Recipient API

Attribute

Name	Type	Description
object	string	The string `recipient`.
id	string	The `RECIPIENT_ID`.
livemode	string	Whether this is a live (`true`) or test (`false`) recipient.
location	string	Path to retrieve the recipient.
verified	boolean	Whether the recipient is verified or not
active	boolean	Whether the recipient is active or not
name	string	The recipient's name.
email	string	The recipient's email.
description	string	The recipient description.
type	string	The recipient type `individual` or `corporation`
tax_id	string	The recipient tax id
bank_account	bank_account	The recipient's bank account
failure_code	string	If the recipient could not be verified, a failure code explaining why.
created	datetime	Creation date of the recipient in ISO 8601 format.

Example

Json Response

{
  "object": "recipient",
  "id": "recp_test_5086xmr74vxs0ajpo78",
  "livemode": false,
  "location": "/recipients/recp_test_5086xmr74vxs0ajpo78",
  "verified": false,
  "active": false,
  "name": "Somchai Prasert",
  "email": "somchai.prasert@example.com",
  "description": null,
  "type": "individual",
  "tax_id": null,
  "bank_account": {
    "object": "bank_account",
    "brand": "bbl",
    "last_digits": "7890",
    "name": "SOMCHAI PRASERT",
    "created": "2015-06-02T05:41:53Z"
  },
  "failure_code": null,
  "created": "2015-06-02T05:41:53Z"
}

List all recipients

- GET https://api.omise.co/recipients

Query Parameter

Name	Type	Description
offset	integer	(optional, default: 0) The offset of the first record returned. I.e.: How many records to skip from the beginning.
limit	integer	(optional, default: 20, maximum: 100) The maximum amount of records returned.
from	datetime	(optional, default: `1970-01-01T00:00:00Z`, format: ISO 8601) The UTC date and time limiting the beginning of returned records. E.g.: `2014-10-20T00:00:00Z`
to	datetime	(optional, default: current UTC Datetime, format: ISO 8601) The UTC date and time limiting the end of returned records. E.g.: `2015-01-20T00:00:00Z`
order	string	(optional, default: chronological) The order of the list returned. I.e.: `chronological` (from earliest to latest), `reverse_chronological` (from latest to earliest).

Example

List all recipients

curl
ruby
python
php
C#
node.js
java
go
elixir

curl -X GET https://api.omise.co/recipients \
  -u skey_test_4xsjvwfnvb2g0l81sjz:

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

recipients = Omise::Recipient.list

import omise

omise.api_secret = 'skey_test_4xs8breq3htbkj03d2x'

recipients = omise.Recipient.retrieve()

<?php

$recipient = OmiseRecipient::retrieve();

var recipients = await Client.Recipients.GetList(order: Ordering.ReverseChronological);
Console.WriteLine($"total recipients: {recipients.Total}");

omise.recipients.list(function(err, resp) {
  /* Response. */
});

ScopedList<Recipient> recipients = client.recipients().list();
System.out.printf("returned recipients: %d", recipients.getData().size());
System.out.printf("total no. of recipients: %d", recipients.getTotal());

recipients, list := &omise.RecipientList{}, &operations.ListRecipient{
	operations.List{
		Offset: 100,
		Limit:  20,
	},
}

if e := client.Do(recipients, list); e != nil {
	log.Fatalln(e)
}

log.Printf("recipients #100-#120: %#v\n", recipients.Data)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Recipient.list

Create a recipient

- POST https://api.omise.co/recipients

Request Parameter

Name	Type	Description
name	string	The recipient's name
email	string	(optional) The recipient's email
description	string	(optional) The recipient's description
type	string	Either `individual` or `corporation`
tax_id	string	(optional) The recipient's tax id
bank_account	bank_account	A valid bank account object

Example

Create a recipient

curl
ruby
python
php
C#
node.js
java
go
elixir

## For Thailand, Singapore, Indonesian
curl https://api.omise.co/recipients \
  -X POST \
  -u skey_test_4xsjvwfnvb2g0l81sjz: \
  -d "name=James Smith" \
  -d "email=test_recp123@localhost" \
  -d "description=My first other recipient" \
  -d "type=individual" \
  -d "tax_id=1234567890" \
  -d "bank_account[brand]=test" \
  -d "bank_account[number]=acc12345" \
  -d "bank_account[name]=James Smith"

## For Japan
curl https://api.omise.co/recipients \
  -X POST \
  -u skey_test_550b2hdgr0hzyzgldno: \
  -d "name=John Doe" \
  -d "email=john.doe@example.com" \
  -d "description=John Doe (id: 30)" \
  -d "type=individual" \
  -d "bank_account[bank_code]=0001" \
  -d "bank_account[branch_code]=001" \
  -d "bank_account[account_type]=normal" \
  -d "bank_account[number]=0000001" \
  -d "bank_account[name]=John Doe"

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

recipient = Omise::Recipient.create({
  name: "Somchai Prasert",
  email: "somchai.prasert@example.com",
  type: "individual",
  bank_account: {
    brand: "bbl",
    number: "1234567890",
    name: "SOMCHAI PRASERT"
  }
})

import omise

omise.api_secret = 'skey_test_4xs8breq3htbkj03d2x'

recipient = omise.Recipient.create(
    name='Somchai Prasert',
    email='somchai.prasert@example.com',
    type='individual',
    bank_account=dict(
        brand='bbl',
        number='1234567890',
        name='SOMCHAI PRASERT'
    )
)

<?php

$recipient = OmiseRecipient::create(array(
  'name' => 'Omise Tester',
  'description' => 'Tester account',
  'email' => 'tester@omise.co',
  'type' => 'individual',
  'tax_id' => '',
  'bank_account' => array(
    'brand' => 'bbl',
    'number' => '1234567890',
    'name' => 'Tester Account'
  )
));

var recipient = await Client.Recipients.Create(new CreateRecipientRequest
{
    Name = "John Doe",
    Email = "john.doe@example.com",
    Description = "John Doe (user: 30)",
    Type = RecipientType.Individual,
    BankAccount = new BankAccountRequest
    {
        Brand = "kbank",
        Number = "7777777777",
        Name = "Dohn Joe",
    },
});

Console.WriteLine($"created recipient: {recipient.Id}");

omise.recipients.create({
  'name': 'Somchai Prasert',
  'email': 'somchai.prasert@example.com',
  'type': 'individual',
  'bank_account': {
    'brand': 'bbl',
    'number': '1234567890',
    'name': 'SOMCHAI PRASERT'
  }
}, function(err, resp) {
  /* Response. */
});

Recipient recipient = client.recipients()
  .create(new Recipient.Create()
          .name("Somchai Prasert")
          .email("somchai.prasert@example.com")
          .type(RecipientType.Individual)
          .bankAccount(new BankAccount.BankAccountParams()
                       .brand("bbl")
                       .number("1234567890")
                       .name("SOMCHAI PRASErT")));
System.out.printf("created recipient: %s", recipient.getId());

recipient, create := &omise.Recipient{}, &operations.CreateRecipient{
	Name:        "Somchai Prasert",
	Email:       "somchai.prasert@example.com",
	Type:        omise.Individual,
	BankAccount: &omise.BankAccount{
		Brand:  "BBL",
		Number: "123456789",
		Name:   "SOMCHAI PRASERT",
	},
}
if e := client.Do(recipient, create); e != nil {
	log.Fatalln(e)
}

log.Printf("created recipient: %#v\n", recipient)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Recipient.create(
  name:  "Somchai Prasert",
  email: "somchai.prasert@example.com",
  type:  "individual",
  bank_account: [
    brand:  "bbl",
    number: "1234567890",
    name:   "SOMCHAI PRASERT"
  ]
)

Retrieve a recipient

- GET https://api.omise.co/recipients/RECIPIENT_ID

Example

Retrieve a recipient

curl
ruby
python
php
C#
node.js
java
go
elixir

curl https://api.omise.co/recipients/recp_test_4z6p7e0m4k40txecj5o \
  -u skey_test_4xsjvwfnvb2g0l81sjz:

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

recipient = Omise::Recipient.retrieve("recp_test_5086xmr74vxs0ajpo78")

import omise

omise.api_secret = 'skey_test_4xs8breq3htbkj03d2x'

recipient = omise.Recipient.retrieve("recp_test_511zkbdo44p30knf2lc")

<?php

$recipient = OmiseRecipient::retrieve('recp_test_4z6p7e0m4k40txecj5o');

var recipientId = "recp_test_57po4c5obpi7rrxhtyl";
var recipient = await Client.Recipients.Get(recipientId);
Console.WriteLine($"recipient account last digits: {recipient.BankAccount.LastDigits}");

omise.recipients.retrieve("recp_test_5086xmr74vxs0ajpo78", function(err, resp){
  /* Response. */
});

Recipient recipient = client.recipients().get("recp_test_4z6p7e0m4k40txecj5o");
System.out.printf("recipient's email: %s", recipient.getEmail());

recipient, retrieve := &omise.Recipient{}, &operations.RetrieveRecipients{
	RecipientID: "recp_test_5086xmr74vxs0ajpo78",
}
if e := client.Do(recipient, retrieve); e != nil {
	log.Fatalln(e)
}

log.Printf("recipient: %#v\n", recipient)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Recipient.retrieve("recp_test_5086xmr74vxs0ajpo78")

Update a recipient

- PATCH https://api.omise.co/recipients/RECIPIENT_ID

Request Parameter

Name	Type	Description
name	string	(optional) The recipient's name
email	string	(optional) The recipient's email
description	string	(optional) The recipient's description
type	string	(optional) Either `individual` or `corporation`
tax_id	string	(optional) The recipient's tax id
bank_account	bank_account	(optional) A valid bank account object

Example

Update a recipient

curl
ruby
python
php
C#
node.js
java
go
elixir

curl https://api.omise.co/recipients/recp_test_4z6p7e0m4k40txecj5o \
  -X PATCH \
  -u skey_test_4xsjvwfnvb2g0l81sjz: \
  -d "name=John Smith" \
  -d "email=john.smith@example.com" \
  -d "bank_account[number]=acc123456789"

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

recipient = Omise::Recipient.retrieve("recp_test_5086xmr74vxs0ajpo78")
recipient.update({
  email: "somchai@prasert.com",
  bank_account: {
    brand: "kbank",
    number: "1234567890",
    name: "SOMCHAI PRASERT"
  }
})

import omise

omise.api_secret = 'skey_test_4xs8breq3htbkj03d2x'

recipient = omise.Recipient.retrieve("recp_test_511zkbdo44p30knf2lc")
recipient.update(
    email='somchai@prasert.com',
    bank_account=dict(
        brand='kbank',
        number='1234567890',
        name='SOMCHAI PRASERT'
    )
)

<?php

$recipient = OmiseRecipient::retrieve('recp_test_4z6p7e0m4k40txecj5o');
$recipient->update(array(
  'name' => 'Omise Tester',
  'email' => 'tester@omise.co',
  'description' => 'Another description'
));

var recipientId = "recp_test_57po4c5obpi7rrxhtyl";
var recipient = await Client.Recipients.Update(recipientId, new UpdateRecipientRequest
{
    Name = "Dohn Joe",
    Email = "dohn.joe@example.com",
});

Console.WriteLine($"updated recipient: {recipient.Id}");

omise.recipients.update("recp_test_5086xmr74vxs0ajpo78",
{
  "email": "somchai@prasert.com",
  "bank_account": {
    "brand": "kbank",
    "number": "1234567890",
    "name": "SOMCHAI PRASERT"
  }
}, function(err, resp){
  /* Response. */
});

Recipient recipient = client.recipients()
  .update("recp_test_4z6p7e0m4k40txecj5", new Recipient.Update()
          .email("somchai@prasert.com")
          .bankAccount(new BankAccount.BankAccountParams()
                       .brand("kbank")
                       .number("1234567890")
                       .name("SOMCHAI PRASERT")));
System.out.printf("updated recipient: %s", recipient.getId());

recipient, update := &omise.Recipient{}, &operations.UpdateRecipient{
	RecipientID: "recp_test_5086xmr74vxs0ajpo78",
	Email:       "somchai@prasert.com",
	BankAccount: &omise.BankAccount{
		Brand:  "KBANK",
		Number: "1234567890",
		Name:   "Somechai Prasert",
	},
}

if e := client.Do(recipient, update); e != nil {
	log.Fatalln(e)
}

log.Printf("updated recipient: %#v\n", recipient)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Recipient.update("recp_test_5086xmr74vxs0ajpo78", [
  email: "somchai@prasert.com",
  bank_account: [
    brand:  "kbank",
    number: "1234567890",
    name:   "SOMCHAI PRASERT"
  ]
])

Destroy a recipient

- DELETE https://api.omise.co/recipients/RECIPIENT_ID

Example

Destroy a recipient

curl
ruby
python
php
C#
node.js
java
go
elixir

curl https://api.omise.co/recipients/recp_test_4z6p7e0m4k40txecj5o \
  -X DELETE \
  -u skey_test_4xsjvwfnvb2g0l81sjz:

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

recipient = Omise::Recipient.retrieve("recp_test_5086xmr74vxs0ajpo78")
recipient.destroy

import omise

omise.api_secret = 'skey_test_4xs8breq3htbkj03d2x'

recipient = omise.Recipient.retrieve("recp_test_511zkbdo44p30knf2lc")
recipient.destroy()

<?php

$recipient = OmiseRecipient::retrieve('recp_test_4z6p7e0m4k40txecj5o');
$recipient->destroy();

var recipient = RetrieveRecipient();
recipient = await Client.Recipients.Destroy(recipient.Id);
Console.WriteLine($"destroyed recipient: {recipient.Id} ({recipient.Deleted})");

omise.recipients.destroy("recp_test_5086xmr74vxs0ajpo78", function(err, resp) {
  /* Response. */
});

Recipient recipient = client.recipients().destroy("recp_test_4z6p7e0m4k40txecj5o");
System.out.printf("destroyed recipient: %s", recipient.getId());

model, destroy := &omise.Deletion{}, &operations.DestroyRecipient{
	RecipientID: "recp_test_5086xmr74vxs0ajpo78",
}

if e := client.Do(model, destroy); e != nil {
	log.Fatalln(e)
}

log.Printf("destroyed recipient:", model.ID)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Recipient.destroy("recp_test_5086xmr74vxs0ajpo78")