Create Intent
This API is the first API to be called when the payment flow begins. Through this API, you inform xPay of the intent of the user to pay with all the requisite info about the user.
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Body
The amount in lowest count unit. e.g.: For USD 1, amount is 100 representing 100 cents (The minimum amount should be greater than 1 USD)
Three letter abbreviation of the currency. Refer supported currencies
Your identifier of the order
Details about the customer
The description of the order, if any
The URL we will callback to with the order status once it finishes.
Response
The amount in lowest count unit (e.g., cents for USD)
Three-letter currency code
The currency that the customer paid in
Your identifier for the order
The mode in which the transaction was made (e.g., TEST or LIVE)
Description of the order, if any
Callback URL to notify order status
Timestamp of when the intent was created
Current status of the intent
CREATED
, INCOMPLETE
, SUCCESS
, FAILED
, REFUNDED
, DISPUTED
, DISPUTE_WON
Unique identifier of the intent
Was this page helpful?