Transfer API

Attribute

Name Type Description
object string

The string transfer.

id string

The TRANSFER_ID.

livemode boolean

Whether this is a Live (true) or Test (false) transfer.

location string

Path to retrieve this transfer

recipient string

The id of recipient the transfer was sent to

bank_account bank_account

The bank account related to the transfer

sent boolean

Whether the transfer was sent or not

paid boolean

Whether the transfer was paid or not

amount integer

Transfer amount in the smallest currency unit (e.g. satang, cent, ... ).

currency string

The currency as its lower-cased international 3-letter code, defined by the ISO 4217 standard. #Supported Currencies

fee integer

The transfer fee

fail_fast boolean

True if the transfer will not be retried in case of failure. False if it will be retried.

failure_code string

The error code

failure_message string

The error message

transaction string

The TRANSACTION_ID of the transfer.

created datetime

Creation date of the transfer in ISO 8601 format.

Example

  • Json Response

List all transfers

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

Returns a list of transfer objects.

Return all transfers that belongs to your account since the beginning of time. You can learn more about lists in the pagination documentation

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 transfers

Create a transfer

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

Returns a new transfer object.

Request Parameter

Name Type Description
amount integer

The amount in the smallest subunits of the currency used. So for thb (Thai Baht) you'll need to pass the amount in satangs.

recipient string

The recipient id.

fail_fast boolean

True = do not retry the transfer in case of failure (insufficient balance, inactive recipient, ... ). False = keep retrying every day. Default: false.

Example

  • Create a transfer

  • Create a transfer to a third-party recipient

Retrieve a transfer

- GET https://api.omise.co/transfers/TRANSFER_ID

Returns an existing transfer object.

Example

  • Retrieve a transfer

Update a transfer

- PATCH https://api.omise.co/transfers/TRANSFER_ID

Returns the updated transfer object.

Request Parameter

Name Type Description
amount integer

The amount in the smallest subunits of the currency used. So for thb (Thai Baht) you'll need to pass the amount in satangs.

Example

  • Update a transfer

Destroy a transfer

- DELETE https://api.omise.co/transfers/TRANSFER_ID

Returns the destroyed transfer object.

Example

  • Destroy a transfer

  • Response (JSON)