Skip to main content
POST
cURL
In order to call this endpoint your token must have write_transfers scope.
This endpoint allows to transfer funds between Ziina accounts either by account_id or by ziiname

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
operation_id
string
required

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

to_account_ids
string[]
required

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

to_ziinames
string[]
required

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

amount
number
required

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

currency_code
string
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

message
string

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

Response

default - application/json
id
string
required

id of the payment intent

account_id
string
required

Account which will receive payment

amount
number
required

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

tip_amount
number
required

The amount of tips to be added to the payment intent

currency_code
string
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_at
string
required

Unix timestamp in milliseconds

status
enum<string>
required

Status of the transaction. You can find more details here

Available options:
requires_payment_instrument,
requires_user_action,
pending,
completed,
failed,
canceled
operation_id
string
required

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

fee_amount
number

The amount of fees paid for this payment intent

message
string

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

redirect_url
string

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

embedded_url
string

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

success_url
string

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

cancel_url
string

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

latest_error
object

An error that was encountered while processing the payment intent

allow_tips
boolean
default:false

Whether tips are allowed for this payment intent