v1

latestOpenAPI 3.0.02026-07-269913.4 KB
Transfer

Get a transfer by its ID. Caller must be the payer or the receiver.

get/transfer/{id}

Path parameters

idstring required

id of the transfer

Response

idstring required

id of the transfer

account_idstring required

Account which will receive the transfer

amountnumber required

Transaction amount. Values must be passed in the base units of their currency. For example, $10.50 should be provided as 1050.

currency_codestring required

Currency code of the amount to charge. This should be a 3-letter ISO-4217 currency code. For example, if you wish to charge 10 AED, you should pass AED. For more information on supported currencies, please visit the supported currencies page

created_atstring required

Unix timestamp in milliseconds

status'requires_payment_instrument' | 'requires_user_action' | 'pending' | 'completed' | 'failed' | 'canceled' required

Status of the transaction. You can find more details here

operation_idstring required

Unique client generated UUID. In case of retries provide the same operation_id

messagestring

Optional text comment attached to a transfer. Displayed to the user in the app as part of the transaction details.