cURL
curl --request POST \
--url https://api.xpaycheckout.com/payments/create-intent \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 100,
"currency": "USD",
"customerDetails": {
"name": "John Doe",
"email": "john.doe@example.com",
"contactNumber": "+919123456789",
"customerAddress": {
"addressLine1": "123 Main St",
"addressLine2": "Apt 1",
"city": "New York",
"state": "NY",
"country": "US",
"postalCode": "2424"
}
},
"callbackUrl": "https://example.com/callback",
"receiptId": "order123",
"customerReferenceId": "eTfd3Jq1tZxPjYVhRQW2r3",
"description": "Order for 2 items",
"cancelUrl": "https://example.com/cancel",
"paymentMethods": [
"CARD",
"GOOGLE_PAY",
"APPLE_PAY"
],
"metadata": {
"orderId": "12345",
"customerNote": "Deliver after 5 PM"
},
"phoneNumberRequired": false,
"customerId": "cus_Tfd3Jq1tZxPjYVhRQW2r3",
"storeFrontId": "sf_sK8d3Jq1tZxPjYVhRQW2rf",
"tokenise": false,
"manualCapture": false,
"allowedCardInstallmentTenures": [
"three",
"six"
],
"platformFeeInBps": 100
}
'import requests
url = "https://api.xpaycheckout.com/payments/create-intent"
payload = {
"amount": 100,
"currency": "USD",
"customerDetails": {
"name": "John Doe",
"email": "john.doe@example.com",
"contactNumber": "+919123456789",
"customerAddress": {
"addressLine1": "123 Main St",
"addressLine2": "Apt 1",
"city": "New York",
"state": "NY",
"country": "US",
"postalCode": "2424"
}
},
"callbackUrl": "https://example.com/callback",
"receiptId": "order123",
"customerReferenceId": "eTfd3Jq1tZxPjYVhRQW2r3",
"description": "Order for 2 items",
"cancelUrl": "https://example.com/cancel",
"paymentMethods": ["CARD", "GOOGLE_PAY", "APPLE_PAY"],
"metadata": {
"orderId": "12345",
"customerNote": "Deliver after 5 PM"
},
"phoneNumberRequired": False,
"customerId": "cus_Tfd3Jq1tZxPjYVhRQW2r3",
"storeFrontId": "sf_sK8d3Jq1tZxPjYVhRQW2rf",
"tokenise": False,
"manualCapture": False,
"allowedCardInstallmentTenures": ["three", "six"],
"platformFeeInBps": 100
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 100,
currency: 'USD',
customerDetails: {
name: 'John Doe',
email: 'john.doe@example.com',
contactNumber: '+919123456789',
customerAddress: {
addressLine1: '123 Main St',
addressLine2: 'Apt 1',
city: 'New York',
state: 'NY',
country: 'US',
postalCode: '2424'
}
},
callbackUrl: 'https://example.com/callback',
receiptId: 'order123',
customerReferenceId: 'eTfd3Jq1tZxPjYVhRQW2r3',
description: 'Order for 2 items',
cancelUrl: 'https://example.com/cancel',
paymentMethods: ['CARD', 'GOOGLE_PAY', 'APPLE_PAY'],
metadata: {orderId: '12345', customerNote: 'Deliver after 5 PM'},
phoneNumberRequired: false,
customerId: 'cus_Tfd3Jq1tZxPjYVhRQW2r3',
storeFrontId: 'sf_sK8d3Jq1tZxPjYVhRQW2rf',
tokenise: false,
manualCapture: false,
allowedCardInstallmentTenures: ['three', 'six'],
platformFeeInBps: 100
})
};
fetch('https://api.xpaycheckout.com/payments/create-intent', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.xpaycheckout.com/payments/create-intent",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 100,
'currency' => 'USD',
'customerDetails' => [
'name' => 'John Doe',
'email' => 'john.doe@example.com',
'contactNumber' => '+919123456789',
'customerAddress' => [
'addressLine1' => '123 Main St',
'addressLine2' => 'Apt 1',
'city' => 'New York',
'state' => 'NY',
'country' => 'US',
'postalCode' => '2424'
]
],
'callbackUrl' => 'https://example.com/callback',
'receiptId' => 'order123',
'customerReferenceId' => 'eTfd3Jq1tZxPjYVhRQW2r3',
'description' => 'Order for 2 items',
'cancelUrl' => 'https://example.com/cancel',
'paymentMethods' => [
'CARD',
'GOOGLE_PAY',
'APPLE_PAY'
],
'metadata' => [
'orderId' => '12345',
'customerNote' => 'Deliver after 5 PM'
],
'phoneNumberRequired' => false,
'customerId' => 'cus_Tfd3Jq1tZxPjYVhRQW2r3',
'storeFrontId' => 'sf_sK8d3Jq1tZxPjYVhRQW2rf',
'tokenise' => false,
'manualCapture' => false,
'allowedCardInstallmentTenures' => [
'three',
'six'
],
'platformFeeInBps' => 100
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.xpaycheckout.com/payments/create-intent"
payload := strings.NewReader("{\n \"amount\": 100,\n \"currency\": \"USD\",\n \"customerDetails\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"contactNumber\": \"+919123456789\",\n \"customerAddress\": {\n \"addressLine1\": \"123 Main St\",\n \"addressLine2\": \"Apt 1\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"postalCode\": \"2424\"\n }\n },\n \"callbackUrl\": \"https://example.com/callback\",\n \"receiptId\": \"order123\",\n \"customerReferenceId\": \"eTfd3Jq1tZxPjYVhRQW2r3\",\n \"description\": \"Order for 2 items\",\n \"cancelUrl\": \"https://example.com/cancel\",\n \"paymentMethods\": [\n \"CARD\",\n \"GOOGLE_PAY\",\n \"APPLE_PAY\"\n ],\n \"metadata\": {\n \"orderId\": \"12345\",\n \"customerNote\": \"Deliver after 5 PM\"\n },\n \"phoneNumberRequired\": false,\n \"customerId\": \"cus_Tfd3Jq1tZxPjYVhRQW2r3\",\n \"storeFrontId\": \"sf_sK8d3Jq1tZxPjYVhRQW2rf\",\n \"tokenise\": false,\n \"manualCapture\": false,\n \"allowedCardInstallmentTenures\": [\n \"three\",\n \"six\"\n ],\n \"platformFeeInBps\": 100\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.xpaycheckout.com/payments/create-intent")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 100,\n \"currency\": \"USD\",\n \"customerDetails\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"contactNumber\": \"+919123456789\",\n \"customerAddress\": {\n \"addressLine1\": \"123 Main St\",\n \"addressLine2\": \"Apt 1\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"postalCode\": \"2424\"\n }\n },\n \"callbackUrl\": \"https://example.com/callback\",\n \"receiptId\": \"order123\",\n \"customerReferenceId\": \"eTfd3Jq1tZxPjYVhRQW2r3\",\n \"description\": \"Order for 2 items\",\n \"cancelUrl\": \"https://example.com/cancel\",\n \"paymentMethods\": [\n \"CARD\",\n \"GOOGLE_PAY\",\n \"APPLE_PAY\"\n ],\n \"metadata\": {\n \"orderId\": \"12345\",\n \"customerNote\": \"Deliver after 5 PM\"\n },\n \"phoneNumberRequired\": false,\n \"customerId\": \"cus_Tfd3Jq1tZxPjYVhRQW2r3\",\n \"storeFrontId\": \"sf_sK8d3Jq1tZxPjYVhRQW2rf\",\n \"tokenise\": false,\n \"manualCapture\": false,\n \"allowedCardInstallmentTenures\": [\n \"three\",\n \"six\"\n ],\n \"platformFeeInBps\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.xpaycheckout.com/payments/create-intent")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 100,\n \"currency\": \"USD\",\n \"customerDetails\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"contactNumber\": \"+919123456789\",\n \"customerAddress\": {\n \"addressLine1\": \"123 Main St\",\n \"addressLine2\": \"Apt 1\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"postalCode\": \"2424\"\n }\n },\n \"callbackUrl\": \"https://example.com/callback\",\n \"receiptId\": \"order123\",\n \"customerReferenceId\": \"eTfd3Jq1tZxPjYVhRQW2r3\",\n \"description\": \"Order for 2 items\",\n \"cancelUrl\": \"https://example.com/cancel\",\n \"paymentMethods\": [\n \"CARD\",\n \"GOOGLE_PAY\",\n \"APPLE_PAY\"\n ],\n \"metadata\": {\n \"orderId\": \"12345\",\n \"customerNote\": \"Deliver after 5 PM\"\n },\n \"phoneNumberRequired\": false,\n \"customerId\": \"cus_Tfd3Jq1tZxPjYVhRQW2r3\",\n \"storeFrontId\": \"sf_sK8d3Jq1tZxPjYVhRQW2rf\",\n \"tokenise\": false,\n \"manualCapture\": false,\n \"allowedCardInstallmentTenures\": [\n \"three\",\n \"six\"\n ],\n \"platformFeeInBps\": 100\n}"
response = http.request(request)
puts response.read_body{
"amount": 100,
"currency": "USD",
"presentmentCurrency": "USD",
"receiptId": "order123",
"customerDetails": {
"name": "John Doe",
"email": "john.doe@example.com",
"contactNumber": "+919123456789",
"customerAddress": {
"addressLine1": "123 Main St",
"addressLine2": "Apt 1",
"city": "New York",
"state": "NY",
"country": "US",
"postalCode": "2424"
}
},
"description": "Order for 2 items",
"callbackUrl": "https://example.com/callback",
"cancelUrl": "https://example.com/cancel",
"createdAt": "2024-09-26T10:41:50.472+00:00",
"status": "CREATED",
"xIntentId": "in_fooBOwYsaK50AEfK",
"fwdUrl": "https://pay.xpaycheckout.com/?xpay_intent_id=67f53a6e2097773e4f0112c8",
"metadata": {
"orderId": "12345",
"customerNote": "Deliver after 5 PM"
}
}{
"errorCode": "bad_request",
"errorDescription": "Failed to read request"
}Payments
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.
POST
/
payments
/
create-intent
cURL
curl --request POST \
--url https://api.xpaycheckout.com/payments/create-intent \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 100,
"currency": "USD",
"customerDetails": {
"name": "John Doe",
"email": "john.doe@example.com",
"contactNumber": "+919123456789",
"customerAddress": {
"addressLine1": "123 Main St",
"addressLine2": "Apt 1",
"city": "New York",
"state": "NY",
"country": "US",
"postalCode": "2424"
}
},
"callbackUrl": "https://example.com/callback",
"receiptId": "order123",
"customerReferenceId": "eTfd3Jq1tZxPjYVhRQW2r3",
"description": "Order for 2 items",
"cancelUrl": "https://example.com/cancel",
"paymentMethods": [
"CARD",
"GOOGLE_PAY",
"APPLE_PAY"
],
"metadata": {
"orderId": "12345",
"customerNote": "Deliver after 5 PM"
},
"phoneNumberRequired": false,
"customerId": "cus_Tfd3Jq1tZxPjYVhRQW2r3",
"storeFrontId": "sf_sK8d3Jq1tZxPjYVhRQW2rf",
"tokenise": false,
"manualCapture": false,
"allowedCardInstallmentTenures": [
"three",
"six"
],
"platformFeeInBps": 100
}
'import requests
url = "https://api.xpaycheckout.com/payments/create-intent"
payload = {
"amount": 100,
"currency": "USD",
"customerDetails": {
"name": "John Doe",
"email": "john.doe@example.com",
"contactNumber": "+919123456789",
"customerAddress": {
"addressLine1": "123 Main St",
"addressLine2": "Apt 1",
"city": "New York",
"state": "NY",
"country": "US",
"postalCode": "2424"
}
},
"callbackUrl": "https://example.com/callback",
"receiptId": "order123",
"customerReferenceId": "eTfd3Jq1tZxPjYVhRQW2r3",
"description": "Order for 2 items",
"cancelUrl": "https://example.com/cancel",
"paymentMethods": ["CARD", "GOOGLE_PAY", "APPLE_PAY"],
"metadata": {
"orderId": "12345",
"customerNote": "Deliver after 5 PM"
},
"phoneNumberRequired": False,
"customerId": "cus_Tfd3Jq1tZxPjYVhRQW2r3",
"storeFrontId": "sf_sK8d3Jq1tZxPjYVhRQW2rf",
"tokenise": False,
"manualCapture": False,
"allowedCardInstallmentTenures": ["three", "six"],
"platformFeeInBps": 100
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 100,
currency: 'USD',
customerDetails: {
name: 'John Doe',
email: 'john.doe@example.com',
contactNumber: '+919123456789',
customerAddress: {
addressLine1: '123 Main St',
addressLine2: 'Apt 1',
city: 'New York',
state: 'NY',
country: 'US',
postalCode: '2424'
}
},
callbackUrl: 'https://example.com/callback',
receiptId: 'order123',
customerReferenceId: 'eTfd3Jq1tZxPjYVhRQW2r3',
description: 'Order for 2 items',
cancelUrl: 'https://example.com/cancel',
paymentMethods: ['CARD', 'GOOGLE_PAY', 'APPLE_PAY'],
metadata: {orderId: '12345', customerNote: 'Deliver after 5 PM'},
phoneNumberRequired: false,
customerId: 'cus_Tfd3Jq1tZxPjYVhRQW2r3',
storeFrontId: 'sf_sK8d3Jq1tZxPjYVhRQW2rf',
tokenise: false,
manualCapture: false,
allowedCardInstallmentTenures: ['three', 'six'],
platformFeeInBps: 100
})
};
fetch('https://api.xpaycheckout.com/payments/create-intent', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.xpaycheckout.com/payments/create-intent",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 100,
'currency' => 'USD',
'customerDetails' => [
'name' => 'John Doe',
'email' => 'john.doe@example.com',
'contactNumber' => '+919123456789',
'customerAddress' => [
'addressLine1' => '123 Main St',
'addressLine2' => 'Apt 1',
'city' => 'New York',
'state' => 'NY',
'country' => 'US',
'postalCode' => '2424'
]
],
'callbackUrl' => 'https://example.com/callback',
'receiptId' => 'order123',
'customerReferenceId' => 'eTfd3Jq1tZxPjYVhRQW2r3',
'description' => 'Order for 2 items',
'cancelUrl' => 'https://example.com/cancel',
'paymentMethods' => [
'CARD',
'GOOGLE_PAY',
'APPLE_PAY'
],
'metadata' => [
'orderId' => '12345',
'customerNote' => 'Deliver after 5 PM'
],
'phoneNumberRequired' => false,
'customerId' => 'cus_Tfd3Jq1tZxPjYVhRQW2r3',
'storeFrontId' => 'sf_sK8d3Jq1tZxPjYVhRQW2rf',
'tokenise' => false,
'manualCapture' => false,
'allowedCardInstallmentTenures' => [
'three',
'six'
],
'platformFeeInBps' => 100
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.xpaycheckout.com/payments/create-intent"
payload := strings.NewReader("{\n \"amount\": 100,\n \"currency\": \"USD\",\n \"customerDetails\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"contactNumber\": \"+919123456789\",\n \"customerAddress\": {\n \"addressLine1\": \"123 Main St\",\n \"addressLine2\": \"Apt 1\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"postalCode\": \"2424\"\n }\n },\n \"callbackUrl\": \"https://example.com/callback\",\n \"receiptId\": \"order123\",\n \"customerReferenceId\": \"eTfd3Jq1tZxPjYVhRQW2r3\",\n \"description\": \"Order for 2 items\",\n \"cancelUrl\": \"https://example.com/cancel\",\n \"paymentMethods\": [\n \"CARD\",\n \"GOOGLE_PAY\",\n \"APPLE_PAY\"\n ],\n \"metadata\": {\n \"orderId\": \"12345\",\n \"customerNote\": \"Deliver after 5 PM\"\n },\n \"phoneNumberRequired\": false,\n \"customerId\": \"cus_Tfd3Jq1tZxPjYVhRQW2r3\",\n \"storeFrontId\": \"sf_sK8d3Jq1tZxPjYVhRQW2rf\",\n \"tokenise\": false,\n \"manualCapture\": false,\n \"allowedCardInstallmentTenures\": [\n \"three\",\n \"six\"\n ],\n \"platformFeeInBps\": 100\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.xpaycheckout.com/payments/create-intent")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 100,\n \"currency\": \"USD\",\n \"customerDetails\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"contactNumber\": \"+919123456789\",\n \"customerAddress\": {\n \"addressLine1\": \"123 Main St\",\n \"addressLine2\": \"Apt 1\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"postalCode\": \"2424\"\n }\n },\n \"callbackUrl\": \"https://example.com/callback\",\n \"receiptId\": \"order123\",\n \"customerReferenceId\": \"eTfd3Jq1tZxPjYVhRQW2r3\",\n \"description\": \"Order for 2 items\",\n \"cancelUrl\": \"https://example.com/cancel\",\n \"paymentMethods\": [\n \"CARD\",\n \"GOOGLE_PAY\",\n \"APPLE_PAY\"\n ],\n \"metadata\": {\n \"orderId\": \"12345\",\n \"customerNote\": \"Deliver after 5 PM\"\n },\n \"phoneNumberRequired\": false,\n \"customerId\": \"cus_Tfd3Jq1tZxPjYVhRQW2r3\",\n \"storeFrontId\": \"sf_sK8d3Jq1tZxPjYVhRQW2rf\",\n \"tokenise\": false,\n \"manualCapture\": false,\n \"allowedCardInstallmentTenures\": [\n \"three\",\n \"six\"\n ],\n \"platformFeeInBps\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.xpaycheckout.com/payments/create-intent")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 100,\n \"currency\": \"USD\",\n \"customerDetails\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"contactNumber\": \"+919123456789\",\n \"customerAddress\": {\n \"addressLine1\": \"123 Main St\",\n \"addressLine2\": \"Apt 1\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"postalCode\": \"2424\"\n }\n },\n \"callbackUrl\": \"https://example.com/callback\",\n \"receiptId\": \"order123\",\n \"customerReferenceId\": \"eTfd3Jq1tZxPjYVhRQW2r3\",\n \"description\": \"Order for 2 items\",\n \"cancelUrl\": \"https://example.com/cancel\",\n \"paymentMethods\": [\n \"CARD\",\n \"GOOGLE_PAY\",\n \"APPLE_PAY\"\n ],\n \"metadata\": {\n \"orderId\": \"12345\",\n \"customerNote\": \"Deliver after 5 PM\"\n },\n \"phoneNumberRequired\": false,\n \"customerId\": \"cus_Tfd3Jq1tZxPjYVhRQW2r3\",\n \"storeFrontId\": \"sf_sK8d3Jq1tZxPjYVhRQW2rf\",\n \"tokenise\": false,\n \"manualCapture\": false,\n \"allowedCardInstallmentTenures\": [\n \"three\",\n \"six\"\n ],\n \"platformFeeInBps\": 100\n}"
response = http.request(request)
puts response.read_body{
"amount": 100,
"currency": "USD",
"presentmentCurrency": "USD",
"receiptId": "order123",
"customerDetails": {
"name": "John Doe",
"email": "john.doe@example.com",
"contactNumber": "+919123456789",
"customerAddress": {
"addressLine1": "123 Main St",
"addressLine2": "Apt 1",
"city": "New York",
"state": "NY",
"country": "US",
"postalCode": "2424"
}
},
"description": "Order for 2 items",
"callbackUrl": "https://example.com/callback",
"cancelUrl": "https://example.com/cancel",
"createdAt": "2024-09-26T10:41:50.472+00:00",
"status": "CREATED",
"xIntentId": "in_fooBOwYsaK50AEfK",
"fwdUrl": "https://pay.xpaycheckout.com/?xpay_intent_id=67f53a6e2097773e4f0112c8",
"metadata": {
"orderId": "12345",
"customerNote": "Deliver after 5 PM"
}
}{
"errorCode": "bad_request",
"errorDescription": "Failed to read request"
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Headers
A unique key for making the request idempotent. Must match pattern: ^[a-zA-Z0-9\-_:\.]+$. See Idempotent Requests for more details.
Maximum string length:
255Pattern:
^[a-zA-Z0-9\-_:\.]+$A Connect merchant ID owned by the authenticated Platform. Required when a Platform merchant creates a payment intent on behalf of a Connect merchant. See Platform Connect.
Body
application/json
Create Intent
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)
Example:
100
Three letter abbreviation of the currency. Refer supported currencies
Example:
"USD"
Billing details for the customer.
Show child attributes
Show child attributes
The URL we will callback to with the xIntentId once it finishes.
Example:
"https://example.com/callback"
Your identifier of the order
Example:
"order123"
Your unique identifier for the customer. This can be used to associate the payment with a specific customer in your system.
Example:
"eTfd3Jq1tZxPjYVhRQW2r3"
The description of the order, if any
Example:
"Order for 2 items"
The URL to redirect the customer to when they cancel the payment. If not provided, the callbackUrl will be used as fallback.
Example:
"https://example.com/cancel"
List of payment methods to be enabled for the link. supported payment methods
š” If a selected payment method is unavailable, the system will automatically fallback to card payments to ensure a smooth checkout experience.
Example:
["CARD", "GOOGLE_PAY", "APPLE_PAY"]
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.
Show child attributes
Show child attributes
Example:
{ "orderId": "12345", "customerNote": "Deliver after 5 PM" }
Flag to indicate whether phone number is required from the customer during checkout. By default, this is false.
Example:
false
The unique identifier for the customer, generated via the create-customer API. This can be used to associate the payment with a specific customer in your system.
Example:
"cus_Tfd3Jq1tZxPjYVhRQW2r3"
šµ Beta Feature - The unique identifier for your storefront. This ID is used to associate the payment with a specific storefront in your account. When provided, it will replace the default DBA and logo with the corresponding storefront's branding. This feature is currently in beta testing and may be subject to changes.
To enable this feature, please contact hello@xpaycheckout.com
Example:
"sf_sK8d3Jq1tZxPjYVhRQW2rf"
This boolean tokenises and stores the card to showcase the same card in future. If sending this value, corresponding customerId is also required. You will receive payment_method_token.created webhook every time a new payment method token is created.
Example:
false
When set to true, the payment is authorized but not captured immediately, allowing you to complete the capture separately. By default, this is false.
Example:
false
Product Page - showcases more about the product on the checkout page
Show child attributes
Show child attributes
Optional. Restricts which Card Installment (EMI) tenures (in months) are offered at checkout. If omitted, all tenures enabled on your account are offered.
Available options:
three, six, nine, twelve Example:
["three", "six"]
Optional additional fee in basis points (1 bps = 0.01%). Only available to Platform merchants when creating a payment intent on behalf of a Connect merchant (requires the x-connect-merchant-id header). See Platform Connect.
Example:
100
Response
Create Intent response
The amount in lowest count unit (e.g., cents for USD)
Example:
100
Three-letter currency code
Example:
"USD"
The currency that the customer paid in
Example:
"USD"
Your identifier for the order
Example:
"order123"
Billing details for the customer.
Show child attributes
Show child attributes
Description of the order, if any
Example:
"Order for 2 items"
Callback URL to notify order status
Example:
"https://example.com/callback"
The URL to redirect the customer to when they cancel the payment.
Example:
"https://example.com/cancel"
Timestamp of when the intent was created
Example:
"2024-09-26T10:41:50.472+00:00"
Current status of the intent. Refer payment statuses
Example:
"CREATED"
Unique identifier of the intent
Example:
"in_fooBOwYsaK50AEfK"
The URL to redirect the customer to the xPay payment gateway for payment.
Example:
"https://pay.xpaycheckout.com/?xpay_intent_id=67f53a6e2097773e4f0112c8"
A collection of key-value pairs that were provided when the object was created. These metadata values are echoed back in the response, allowing you to store and retrieve custom information such as context-specific attributes, references, or tags. This can be useful for correlating records in your system or attaching meaningful context to transactions.
Show child attributes
Show child attributes
Example:
{ "orderId": "12345", "customerNote": "Deliver after 5 PM" }
Was this page helpful?