Create a recipient

POSThttps://api.omise.co/recipients

Create a new recipient with bank account details to receive transfers from your Omise balance. Recipients can be individuals or corporations.

---

Request Parameters

Required - 5 fieldsRequired Parameters

▼

`name`STRING(required)

Recipient name (individual name or company name, must match bank account).

Example:"John Doe"

`type`STRING(required)

Recipient type.

Example:"individual"

Values:individual, corporation

`bank_account.brand`STRING(required)

Bank code (bbl, kbank, scb, ktb, bay, tmb, etc.).

Example:"bbl"

`bank_account.number`STRING(required)

Bank account number (no spaces or dashes).

Example:"1234567890"

`bank_account.name`STRING(required)

Account holder name as registered with bank (uppercase recommended).

Example:"JOHN DOE"

Recommended - 2 fieldsRecommended Parameters

▼

Additional - 2 fieldsAdditional Parameters

▼

---

Responses

200

Successful transaction

Recipient created successfully. Note that verified: false by default until verification completes.

Returned recipient attributes:

• object - The value "recipient"
• id - Recipient identifier (recp_*)
• livemode - Live or test mode
• location - API path to the recipient object
• activated_at - Activation timestamp (ISO 8601)
• active - Whether recipient is active
• bank_account - Destination bank account object
• created_at - Creation timestamp (ISO 8601)
• default - Whether recipient is account default
• deleted - Whether recipient is deleted
• description - Recipient description
• email - Recipient email address
• failure_code - Failure reason code (name_mismatch, account_not_found, bank_not_found)
• metadata - Custom metadata
• name - Recipient name
• schedule - Transfer schedule (expandable)
• tax_id - Recipient tax ID
• type - Recipient type (individual, corporation)
• verified - Whether recipient is verified
• verified_at - Verification timestamp (ISO 8601)

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Missing required fields (name, type, bank_account fields)
• Invalid bank account format
• Invalid recipient type
• Malformed metadata

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

422

Unprocessable entity

Bank account validation failed.

Common causes:

• Invalid bank account number
• Account name does not match bank records
• Unsupported bank
• Cannot verify bank account

5xx

Server error

Server-side error occurred. These are rare but should be handled gracefully.

How to handle:

• Retry the request with exponential backoff
• Check status.omise.co for service incidents
• See Error Handling for detailed guidance

---

Code samples

cURL

curl https://api.omise.co/recipients \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "name=John Doe" \
  -d "type=individual" \
  -d "email=john@example.com" \
  -d "bank_account[brand]=bbl" \
  -d "bank_account[number]=1234567890" \
  -d "bank_account[name]=JOHN DOE"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = Omise::Recipient.create({
  name: 'John Doe',
  type: 'individual',
  email: 'john@example.com',
  bank_account: {
    brand: 'bbl',
    number: '1234567890',
    name: 'JOHN DOE'
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = omise.Recipient.create(
    name='John Doe',
    type='individual',
    email='john@example.com',
    bank_account={
        'brand': 'bbl',
        'number': '1234567890',
        'name': 'JOHN DOE'
    }
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const recipient = await omise.recipients.create({
  name: 'John Doe',
  type: 'individual',
  email: 'john@example.com',
  bank_account: {
    brand: 'bbl',
    number: '1234567890',
    name: 'JOHN DOE'
  }
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$recipient = OmiseRecipient::create([
    'name' => 'John Doe',
    'type' => 'individual',
    'email' => 'john@example.com',
    'bank_account' => [
        'brand' => 'bbl',
        'number' => '1234567890',
        'name' => 'JOHN DOE'
    ]
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

BankAccount bankAccount = new BankAccount();
bankAccount.brand("bbl");
bankAccount.number("1234567890");
bankAccount.name("JOHN DOE");

Recipient recipient = client.recipients().create()
    .name("John Doe")
    .type("individual")
    .email("john@example.com")
    .bankAccount(bankAccount)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var recipient = await client.Recipients.Create(new CreateRecipientRequest
{
    Name = "John Doe",
    Type = "individual",
    Email = "john@example.com",
    BankAccount = new BankAccount
    {
        Brand = "bbl",
        Number = "1234567890",
        Name = "JOHN DOE"
    }
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

recipient, _ := client.Recipients().Create(&operations.CreateRecipient{
    Name:  "John Doe",
    Type:  "individual",
    Email: "john@example.com",
    BankAccount: &operations.BankAccount{
        Brand:  "bbl",
        Number: "1234567890",
        Name:   "JOHN DOE",
    },
})

---

Error and result codes

Common Error Codes

Code	Description	Resolution
bad_request	Missing or invalid parameters	Check all required fields are provided
authentication_failure	Invalid API key	Verify your secret key is correct
invalid_bank_account	Bank account number invalid	Verify account number is correct
name_mismatch	Account name does not match bank records	Use exact name from bank account
unsupported_bank	Bank not supported for recipients	Check supported banks list

Recipient Types

Type	Description
individual	Personal bank accounts
corporation	Business/company accounts

---

🔑API Credentials

▼

Try it out

Required - 5 fields

▼

name(Required)

type(Required)

bank_account[brand](Required)

bank_account[number](Required)

bank_account[name](Required)

Recommended - 2 fields

▼

Additional - 2 fields

▼

Your IP: ...Loading...