Sign in

v1

latestOpenAPI 3.0.02026-07-269913.4 KB
PaymentIntent

post/payment_intent

Request body

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

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

failure_urlstring

Url where user will be redirected after failed payment

testboolean

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.

expirystring

Unix timestamp in milliseconds, must be a future date

allow_tipsboolean

Whether to allow tips for this payment intent

Response

Created payment intent

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