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

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

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

Retrieve a recipient

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

Example

  • Retrieve a recipient

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

Destroy a recipient

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

Example

  • Destroy a recipient