Skip to main content
POST
/
payment_intent
cURL
curl --request POST \
  --url https://api-v2.ziina.com/api/payment_intent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 123,
  "currency_code": "<string>",
  "message": "<string>",
  "success_url": "<string>",
  "cancel_url": "<string>",
  "failure_url": "<string>",
  "test": true,
  "expiry": "<string>",
  "allow_tips": false
}'
{
  "id": "<string>",
  "account_id": "<string>",
  "amount": 123,
  "tip_amount": 123,
  "fee_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>"
  },
  "allow_tips": false
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
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

Required string length: 3
​
message
string

A message to be displayed to the user on 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

​
failure_url
string

Url where user will be redirected after failed payment

​
test
boolean

Whether to create a test payment. Test payments do not require a payment method and can be used to test the payment flow. You won't be charged for this call. You can use test cards to test the payment flow.

​
expiry
string

Unix timestamp in milliseconds, must be a future date

​
allow_tips
boolean
default:false

Whether to allow tips for this payment intent

Response

default - application/json

Created payment intent

​
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

​
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