POST
/
transfer
curl --request POST \
  --url https://api-v2.ziina.com/api/transfer \
  --header 'Content-Type: application/json' \
  --data '{
  "operation_id": "<string>",
  "to_account_ids": [
    "<string>"
  ],
  "to_ziinames": [
    "<string>"
  ],
  "amount": 123,
  "currency_code": "<string>",
  "message": "<string>",
  "transaction_source": "directApi"
}'
{
  "id": "<string>",
  "account_id": "<string>",
  "amount": 123,
  "currency_code": "<string>",
  "created_at": "<string>",
  "status": "requires_payment_instrument",
  "operation_id": "<string>",
  "message": "<string>",
  "redirect_url": "<string>",
  "success_url": "<string>",
  "cancel_url": "<string>",
  "latest_error": {
    "message": "<string>",
    "code": "<string>"
  }
}

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

Body

application/json
​
operation_id
string
required

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

​
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

​
transaction_source
enum<string>
Available options:
directApi,
graphqlApi,
shopify,
woocommerce,
wix,
pos

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.

​
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

​
status
enum<string>
required
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 UUID

​
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

​
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

Was this page helpful?

Payment IntentGet refund by Id