- Use this endpoint when you already gathered card details and consent within your PCI DSS compliant environment
- You must obtain explicit approval from hello@xpaycheckout.com before using this API
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)
2000
Three letter abbreviation of the currency. Refer supported currencies
"USD"
Payment card information collected by you
URL that the customer will be redirected to once the payment is processed in case 3ds authentication is required.
"https://example.com/callback"
Your identifier for the order
"order123"
Indicates if the payment is being processed in a different session than the one where the card details were collected.
"false"
A collection of key-value pairs that can be attached to an object for storing additional structured information. This is useful for capturing custom data or context-specific attributes.
Constraints:
- Maximum of 50 key-value pairs allowed.
- Each key must be no longer than 40 characters.
- Each value must be a string and cannot exceed 500 characters.
{
"orderId": "12345",
"customerNote": "Deliver after 5 PM"
}Response
Charge raw card response
Current state of the charge attempt.
CREATED, SUCCESS, FAILED "SUCCESS"
Identifier of the payment intent created for this charge.
"in_gKAqR0DjLeOihdTE"
URL to redirect your customer to xpay's secure link to complete any pending 3DS or next action steps. Present only when additional authentication is required.
"https://pay.xpaycheckout.com/?id=67f53a6e2097773e4f0112c8"
Machine readable failure reason when status is FAILED. See all possible values here.
"insufficient_funds"