Sign in

v1

latestOpenAPI 3.0.02026-07-269913.4 KB
Transfer

post/transfer

Request body

operation_idstring required

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

to_account_idsstring[] required

Array of account ids to transfer to. You need to specify only one of the properties: to_account_ids or to_ziinames

to_ziinamesstring[] required

Array of ziinames to transfer to. You need to specify only one of the properties: to_account_ids or to_ziinames

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

messagestring

A message to be displayed to the user on the hosted payment page

Response

idstring required

id of the payment intent

account_idstring required

Account which will receive payment

amountnumber required

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

tip_amountnumber required

The amount of tips to be added to the payment intent

fee_amountnumber

The amount of fees paid for this payment intent

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

A message to be displayed to the user on the hosted payment page

redirect_urlstring

The URL to be used to redirect the client to the hosted payment page

embedded_urlstring

The URL to be used to show embedded payment page with the payment widget

success_urlstring

The URL to be called by the hosted web page when the payment is successful

cancel_urlstring

The URL to be called by the hosted web page when the payment is cancelled

allow_tipsboolean

Whether tips are allowed for this payment intent