Initiate a payment request to collect payment(s) from your customer.
The XenPlatform subaccount user id that will perform this transaction.
The XenPlatform split rule id that will be applied to this transaction.
{
"reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
"type": "PAY",
"country": "ID",
"currency": "IDR",
"request_amount": 10000.01,
"capture_method": "AUTOMATIC",
"channel_code": "CARDS",
"channel_properties": {
"mid_label": "mid_label_acquirer_1",
"card_details": {
"cvn": "246",
"card_number": "2222444466668888",
"expiry_year": "2027",
"expiry_month": "12",
"cardholder_first_name": "John",
"cardholder_last_name": "Doe",
"cardholder_email": "john@xendit.co",
"cardholder_phone_number": "+661234567890"
},
"skip_three_ds": false,
"card_on_file_type": "MERCHANT_UNSCHEDULED",
"failure_return_url": "https://xendit.co/failure",
"success_return_url": "https://xendit.co/success",
"billing_information": {
"first_name": "John",
"last_name": "Doe",
"email": "example@xendit.co",
"phone_number": "+628000000000008",
"city": "Singapore",
"country": "SG",
"postal_code": "644228",
"street_line1": "Merlion Bay Sands Suites",
"street_line2": "21-37",
"province_state": "Singapore"
},
"statement_descriptor": "Goods & Services",
"recurring_configuration": {
"recurring_expiry": "YYYY-MM-DD",
"recurring_frequency": 30
}
},
"description": "Description examples",
"metadata": {
"metametadata": "metametametadata"
}
}{
"reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
"type": "PAY",
"country": "PH",
"currency": "PHP",
"request_amount": 10000.01,
"capture_method": "AUTOMATIC",
"channel_code": "GCASH",
"channel_properties": {
"failure_return_url": "https://xendit.co/failure",
"success_return_url": "https://xendit.co/success"
},
"description": "Description examples",
"metadata": {
"metametadata": "metametametadata"
}
}{
"reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
"type": "PAY",
"country": "ID",
"currency": "IDR",
"request_amount": 10000.01,
"capture_method": "AUTOMATIC",
"channel_code": "QRIS",
"channel_properties": {
"expires_at": "2024-12-31T23:59:59Z"
},
"description": "Description examples",
"metadata": {
"metametadata": "metametametadata"
}
}{
"reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
"type": "REUSABLE_PAYMENT_CODE",
"country": "ID",
"currency": "IDR",
"capture_method": "AUTOMATIC",
"channel_code": "QRIS",
"channel_properties": {
"expires_at": "2024-12-31T23:59:59Z"
},
"description": "Description examples",
"metadata": {
"metametadata": "metametametadata"
}
}{
"reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
"customer": {
"reference_id": "demo_1475801962607",
"type": "INDIVIDUAL",
"individual_detail": {
"given_names": "John",
"surname\"": "Doe"
},
"email": "example@xendit.co",
"mobile_number": "+628000000000008"
},
"type": "PAY_AND_SAVE",
"country": "ID",
"currency": "IDR",
"request_amount": 10000.01,
"capture_method": "AUTOMATIC",
"channel_code": "CARDS",
"channel_properties": {
"mid_label": "mid_label_acquirer_1",
"card_details": {
"cvn": "246",
"card_number": "2222444466668888",
"expiry_year": "2027",
"expiry_month": "12",
"cardholder_first_name": "John",
"cardholder_last_name": "Doe",
"cardholder_email": "john@xendit.co",
"cardholder_phone_number": "+661234567890"
},
"skip_three_ds": false,
"card_on_file_type": "MERCHANT_UNSCHEDULED",
"failure_return_url": "https://xendit.co/failure",
"success_return_url": "https://xendit.co/success",
"billing_information": {
"first_name": "John",
"last_name": "Doe",
"email": "example@xendit.co",
"phone_number": "+628000000000008",
"city": "Singapore",
"country": "SG",
"postal_code": "644228",
"street_line1": "Merlion Bay Sands Suites",
"street_line2": "21-37",
"province_state": "Singapore"
},
"statement_descriptor": "Goods & Services",
"recurring_configuration": {
"recurring_expiry": "YYYY-MM-DD",
"recurring_frequency": 30
}
},
"description": "Description examples",
"metadata": {
"metametadata": "metametametadata"
}
}{
"reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
"customer": {
"reference_id": "demo_1475801962607",
"type": "INDIVIDUAL",
"individual_detail": {
"given_names": "John",
"surname\"": "Doe"
},
"email": "example@xendit.co",
"mobile_number": "+628000000000008"
},
"type": "PAY_AND_SAVE",
"country": "PH",
"currency": "PHP",
"request_amount": 10000.01,
"capture_method": "AUTOMATIC",
"channel_code": "MAYA",
"channel_properties": {
"failure_return_url": "https://xendit.co/failure",
"success_return_url": "https://xendit.co/success"
},
"description": "Description examples",
"metadata": {
"metametadata": "metametametadata"
}
}{
"reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
"payment_token_id": "pt-90392f42-d98a-49ef-a7f3-abcezas123",
"type": "PAY",
"country": "TH",
"currency": "THB",
"request_amount": 10000.01,
"capture_method": "AUTOMATIC",
"channel_properties": {
"mid_label": "mid_label_acquirer_1",
"skip_three_ds": false,
"card_on_file_type": "CUSTOMER_UNSCHEDULED",
"failure_return_url": "https://xendit.co/failure",
"success_return_url": "https://xendit.co/success",
"statement_descriptor": "Goods & Services"
},
"description": "Description examples",
"metadata": {
"metametadata": "metametametadata"
}
}{
"reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
"payment_token_id": "pt-90392f42-d98a-49ef-a7f3-abcezas123",
"type": "PAY",
"country": "ID",
"currency": "IDR",
"request_amount": 10000.01,
"capture_method": "AUTOMATIC",
"channel_properties": {
"failure_return_url": "https://xendit.co/failure",
"success_return_url": "https://xendit.co/success"
},
"description": "Description examples",
"metadata": {
"metametadata": "metametametadata"
}
}{
"reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
"payment_token_id": "pt-90392f42-d98a-49ef-a7f3-abcezas123",
"type": "PAY",
"country": "ID",
"currency": "IDR",
"request_amount": 10000.01,
"capture_method": "AUTOMATIC",
"description": "Description examples",
"metadata": {
"metametadata": "metametametadata"
}
}A reference ID from merchants to identify their request. For "CARDS" channel code, reference ID must be unique.
PAY: Create a payment request that is able to receive one payment.
ISO 3166-1 alpha-2 two-letter country code for the country of transaction.
ISO 4217 three-letter currency code for the payment.
The intended payment amount to be collected from the end user.
AUTOMATIC: payment capture will be processed immediately after payment request is created. MANUAL: payment capture requires merchant's trigger via payment capture endpoint before being processed
Channel code used to select the payment method provider. Use routing payment channels mapping for full list of channel codes.
Data required to initiate transaction with payment method provider. Use routing payment channels mapping for full list of data required.
A custom description for the Payment Request.
Key-value entries for your custom data. You can specify up to 50 keys, with key names up to 40 characters and values up to 500 characters. This is for your convenience. Xendit will not use this data for any processing.
Array of objects describing the item/s attached to the payment.
Type of item
Name of item
Net amount to be charged per unit. Must be a negative number when type = DISCOUNT
Number of units of this item in the basket
URL of the item. Must be HTTPS or HTTP
URL of the image of the item. Must be HTTPS or HTTP
Category for item
Sub-category for item
Description of item
Key-value entries for your custom data. You can specify up to 50 keys, with key names up to 40 characters and values up to 500 characters. This is for your convenience. Xendit will not use this data for any processing.
2-letter ISO 3166-2 country code for the customer’s shipping country
Building name and apartment unit number
Building street address
City, village or town as appropriate
Either one of (whichever is applicable): Geographic area, province, or region / Formal state designation within country
Postal, zip or rural delivery code, if applicable
A reference ID from merchants to identify their request. For "CARDS" channel code, reference ID must be unique.
Xendit unique Payment Token ID generated as reference for reusable payment details of the end user.
PAY: Create a payment request that is able to receive one payment.
ISO 3166-1 alpha-2 two-letter country code for the country of transaction.
ISO 4217 three-letter currency code for the payment.
The intended payment amount to be collected from the end user.
AUTOMATIC: payment capture will be processed immediately after payment request is created. MANUAL: payment capture requires merchant's trigger via payment capture endpoint before being processed
Data required to initiate transaction with payment method provider. Use routing payment channels mapping for full list of data required.
A custom description for the Payment Request.
Key-value entries for your custom data. You can specify up to 50 keys, with key names up to 40 characters and values up to 500 characters. This is for your convenience. Xendit will not use this data for any processing.
Array of objects describing the item/s attached to the payment.
Type of item
Name of item
Net amount to be charged per unit. Must be a negative number when type = DISCOUNT
Number of units of this item in the basket
URL of the item. Must be HTTPS or HTTP
URL of the image of the item. Must be HTTPS or HTTP
Category for item
Sub-category for item
Description of item
Key-value entries for your custom data. You can specify up to 50 keys, with key names up to 40 characters and values up to 500 characters. This is for your convenience. Xendit will not use this data for any processing.
2-letter ISO 3166-2 country code for the customer’s shipping country
Building name and apartment unit number
Building street address
City, village or town as appropriate
Either one of (whichever is applicable): Geographic area, province, or region / Formal state designation within country
Postal, zip or rural delivery code, if applicable
A reference ID from merchants to identify their request. For "CARDS" channel code, reference ID must be unique.
REUSABLE_PAYMENT_CODE: Create one payment request that is able to receive multiple payments. This is only used for repeat use payment method like static QR, static OTC payment code or a predefined Virtual Account number.
ISO 3166-1 alpha-2 two-letter country code for the country of transaction.
ISO 4217 three-letter currency code for the payment.
The intended payment amount to be collected from the end user.
AUTOMATIC: payment capture will be processed immediately after payment request is created. MANUAL: payment capture requires merchant's trigger via payment capture endpoint before being processed
Channel code used to select the payment method provider. Use routing payment channels mapping for full list of channel codes.
Data required to initiate transaction with payment method provider. Use routing payment channels mapping for full list of data required.
A custom description for the Payment Request.
Key-value entries for your custom data. You can specify up to 50 keys, with key names up to 40 characters and values up to 500 characters. This is for your convenience. Xendit will not use this data for any processing.
Array of objects describing the item/s attached to the payment.
Type of item
Name of item
Net amount to be charged per unit. Must be a negative number when type = DISCOUNT
Number of units of this item in the basket
URL of the item. Must be HTTPS or HTTP
URL of the image of the item. Must be HTTPS or HTTP
Category for item
Sub-category for item
Description of item
Key-value entries for your custom data. You can specify up to 50 keys, with key names up to 40 characters and values up to 500 characters. This is for your convenience. Xendit will not use this data for any processing.
2-letter ISO 3166-2 country code for the customer’s shipping country
Building name and apartment unit number
Building street address
City, village or town as appropriate
Either one of (whichever is applicable): Geographic area, province, or region / Formal state designation within country
Postal, zip or rural delivery code, if applicable
A reference ID from merchants to identify their request. For "CARDS" channel code, reference ID must be unique.
Xendit unique Payment Token ID generated as reference for reusable payment details of the end user.
Xendit unique Capture ID generated as reference for the end user
Type of customer
Merchant provided identifier for the customer. Must be unique. Alphanumeric no special characters allowed
E-mail address of customer. Maximum length 50 characters
Mobile number of customer in E.164 format +(country code)(subscriber number)
Primary or first name/s of customer. Alphanumeric. No special characters is allowed.
Last or family name of customer. Alphanumeric. No special characters is allowed.
Country code for customer nationality. ISO 3166-1 alpha-2 Country Code
City or other relevant location for the customer birth place. Alphanumeric. No special characters is allowed.
Date of birth of the customer. Format: YYYY-MM-DD
Gender of customer
PAY_AND_SAVE: Create a payment request that is able to receive one payment. If the payment is successful, a reusable payment token will be returned in the callback as saved payment information for subsequent payment requests.
ISO 3166-1 alpha-2 two-letter country code for the country of transaction.
ISO 4217 three-letter currency code for the payment.
The intended payment amount to be collected from the end user.
AUTOMATIC: payment capture will be processed immediately after payment request is created. MANUAL: payment capture requires merchant's trigger via payment capture endpoint before being processed
Channel code used to select the payment method provider. Use routing payment channels mapping for full list of channel codes.
Data required to initiate transaction with payment method provider. Use routing payment channels mapping for full list of data required.
A custom description for the Payment Request.
Key-value entries for your custom data. You can specify up to 50 keys, with key names up to 40 characters and values up to 500 characters. This is for your convenience. Xendit will not use this data for any processing.
Array of objects describing the item/s attached to the payment.
Type of item
Name of item
Net amount to be charged per unit. Must be a negative number when type = DISCOUNT
Number of units of this item in the basket
URL of the item. Must be HTTPS or HTTP
URL of the image of the item. Must be HTTPS or HTTP
Category for item
Sub-category for item
Description of item
Key-value entries for your custom data. You can specify up to 50 keys, with key names up to 40 characters and values up to 500 characters. This is for your convenience. Xendit will not use this data for any processing.
2-letter ISO 3166-2 country code for the customer’s shipping country
Building name and apartment unit number
Building street address
City, village or town as appropriate
Either one of (whichever is applicable): Geographic area, province, or region / Formal state designation within country
Postal, zip or rural delivery code, if applicable
Payment Request Created
{
"business_id": "5f27a14a9bf05c73dd040bc8",
"reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
"payment_request_id": "pr-90392f42-d98a-49ef-a7f3-abcezas123",
"type": "PAY",
"country": "ID",
"currency": "IDR",
"request_amount": 10000.01,
"capture_method": "AUTOMATIC",
"channel_code": "CARDS",
"channel_properties": {
"mid_label": "mid_label_acquirer_1",
"card_details": {
"masked_card_number": "222244XXXXXX8888",
"cardholder_first_name": "John",
"cardholder_last_name": "Doe",
"cardholder_email": "john@xendit.co",
"cardholder_phone_number": "+661234567890",
"expiry_month": "12",
"expiry_year": "2027",
"fingerprint": "62397498595752001b9fdeba",
"type": "CREDIT",
"network": "VISA",
"country": "ID",
"issuer": "PT BANK CARDS"
},
"skip_three_ds": false,
"card_on_file_type": "CUSTOMER_UNSCHEDULED",
"failure_return_url": "https://xendit.co/failure",
"success_return_url": "https://xendit.co/success",
"billing_information": {
"first_name": "John",
"last_name": "Doe",
"email": "example@xendit.co",
"phone_number": "+628000000000008",
"city": "Singapore",
"country": "SG",
"postal_code": "644228",
"street_line1": "Merlion Bay Sands Suites",
"street_line2": "21-37",
"province_state": "Singapore"
},
"statement_descriptor": "Goods & Services",
"recurring_configuration": {
"recurring_expiry": "YYYY-MM-DD",
"recurring_frequency": 30
}
},
"actions": [
{
"type": "REDIRECT_CUSTOMER",
"value": "xendit.co/example",
"descriptor": "WEB_URL"
}
],
"status": "REQUIRES_ACTION",
"description": "Description examples",
"metadata": {
"metametadata": "metametametadata"
},
"created": "2021-12-31T23:59:59Z",
"updated": "2021-12-31T23:59:59Z"
}{
"business_id": "5f27a14a9bf05c73dd040bc8",
"reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
"payment_request_id": "pr-90392f42-d98a-49ef-a7f3-abcezas123",
"type": "PAY",
"country": "ID",
"currency": "IDR",
"request_amount": 10000.01,
"capture_method": "AUTOMATIC",
"channel_code": "DANA",
"channel_properties": {
"failure_return_url": "https://xendit.co/failure",
"success_return_url": "https://xendit.co/success"
},
"actions": [
{
"type": "REDIRECT_CUSTOMER",
"value": "xendit.co/example",
"descriptor": "WEB_URL"
}
],
"status": "REQUIRES_ACTION",
"description": "Description examples",
"metadata": {
"metametadata": "metametametadata"
},
"created": "2021-12-31T23:59:59Z",
"updated": "2021-12-31T23:59:59Z"
}{
"business_id": "5f27a14a9bf05c73dd040bc8",
"reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
"payment_request_id": "pr-90392f42-d98a-49ef-a7f3-abcezas123",
"type": "PAY",
"country": "ID",
"currency": "IDR",
"request_amount": 10000.01,
"capture_method": "AUTOMATIC",
"channel_code": "BRI_VIRTUAL_ACCOUNT",
"channel_properties": {
"expires_at": "2024-12-31T23:59:59Z"
},
"actions": [
{
"type": "PRESENT_TO_CUSTOMER",
"descriptor": "VIRTUAL_ACCOUNT_NUMBER",
"value": "1251255"
}
],
"status": "REQUIRES_ACTION",
"description": "Description examples",
"metadata": {
"metametadata": "metametametadata"
},
"created": "2021-12-31T23:59:59Z",
"updated": "2021-12-31T23:59:59Z"
}{
"business_id": "5f27a14a9bf05c73dd040bc8",
"reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
"payment_request_id": "pr-90392f42-d98a-49ef-a7f3-abcezas123",
"type": "REUSABLE_PAYMENT_CODE",
"country": "ID",
"currency": "IDR",
"request_amount": 10000.01,
"capture_method": "AUTOMATIC",
"channel_code": "BRI_VIRTUAL_ACCOUNT",
"channel_properties": {
"expires_at": "2024-12-31T23:59:59Z"
},
"actions": [
{
"type": "PRESENT_TO_CUSTOMER",
"descriptor": "VIRTUAL_ACCOUNT_NUMBER",
"value": "1251255"
}
],
"status": "REQUIRES_ACTION",
"description": "Description examples",
"metadata": {
"metametadata": "metametametadata"
},
"created": "2021-12-31T23:59:59Z",
"updated": "2021-12-31T23:59:59Z"
}{
"business_id": "5f27a14a9bf05c73dd040bc8",
"reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
"payment_request_id": "pr-90392f42-d98a-49ef-a7f3-abcezas123",
"customer_id": "cust-90392f42-d98a-49ef-a7f3-abcezas123",
"type": "PAY_AND_SAVE",
"country": "ID",
"currency": "IDR",
"request_amount": 10000.01,
"capture_method": "AUTOMATIC",
"channel_code": "CARDS",
"channel_properties": {
"mid_label": "mid_label_acquirer_1",
"card_details": {
"masked_card_number": "222244XXXXXX8888",
"cardholder_first_name": "John",
"cardholder_last_name": "Doe",
"cardholder_email": "john@xendit.co",
"cardholder_phone_number": "+661234567890",
"expiry_month": "12",
"expiry_year": "2027",
"fingerprint": "62397498595752001b9fdeba",
"type": "CREDIT",
"network": "VISA",
"country": "ID",
"issuer": "PT BANK CARDS"
},
"skip_three_ds": false,
"card_on_file_type": "CUSTOMER_UNSCHEDULED",
"failure_return_url": "https://xendit.co/failure",
"success_return_url": "https://xendit.co/success",
"billing_information": {
"first_name": "John",
"last_name": "Doe",
"email": "example@xendit.co",
"phone_number": "+628000000000008",
"city": "Singapore",
"country": "SG",
"postal_code": "644228",
"street_line1": "Merlion Bay Sands Suites",
"street_line2": "21-37",
"province_state": "Singapore"
},
"statement_descriptor": "Goods & Services",
"recurring_configuration": {
"recurring_expiry": "YYYY-MM-DD",
"recurring_frequency": 30
}
},
"actions": [
{
"type": "REDIRECT_CUSTOMER",
"value": "xendit.co/example",
"descriptor": "WEB_URL"
}
],
"status": "REQUIRES_ACTION",
"description": "Description examples",
"metadata": {
"metametadata": "metametametadata"
},
"created": "2021-12-31T23:59:59Z",
"updated": "2021-12-31T23:59:59Z"
}{
"business_id": "5f27a14a9bf05c73dd040bc8",
"reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
"payment_request_id": "pr-90392f42-d98a-49ef-a7f3-abcezas123",
"customer_id": "cust-90392f42-d98a-49ef-a7f3-abcezas123",
"type": "PAY",
"country": "ID",
"currency": "IDR",
"request_amount": 10000.01,
"capture_method": "AUTOMATIC",
"channel_code": "DANA",
"channel_properties": {
"failure_return_url": "https://xendit.co/failure",
"success_return_url": "https://xendit.co/success"
},
"actions": [
{
"type": "REDIRECT_CUSTOMER",
"value": "xendit.co/example",
"descriptor": "WEB_URL"
}
],
"status": "REQUIRES_ACTION",
"description": "Description examples",
"metadata": {
"metametadata": "metametametadata"
},
"created": "2021-12-31T23:59:59Z",
"updated": "2021-12-31T23:59:59Z"
}{
"business_id": "5f27a14a9bf05c73dd040bc8",
"reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
"payment_token_id": "pt-90392f42-d98a-49ef-a7f3-abcezas123",
"payment_request_id": "pr-90392f42-d98a-49ef-a7f3-abcezas123",
"type": "PAY",
"country": "ID",
"currency": "IDR",
"request_amount": 10000.01,
"capture_method": "AUTOMATIC",
"channel_code": "CARDS",
"channel_properties": {
"mid_label": "mid_label_acquirer_1",
"skip_three_ds": false,
"card_on_file_type": "CUSTOMER_UNSCHEDULED",
"failure_return_url": "https://xendit.co/failure",
"success_return_url": "https://xendit.co/success",
"statement_descriptor": "Goods & Services"
},
"actions": [
{
"type": "REDIRECT_CUSTOMER",
"value": "xendit.co/example",
"descriptor": "WEB_URL"
}
],
"status": "REQUIRES_ACTION",
"description": "Description examples",
"metadata": {
"metametadata": "metametametadata"
},
"shipping_information": {
"city": "Singapore",
"country": "SG",
"postal_code": "644228",
"street_line1": "Merlion Bay Sands Suites",
"street_line2": "21-37",
"province_state": "Singapore"
},
"items": [
{
"type": "PHYSICAL_PRODUCT",
"name": "Vyson Dacuum Cleaner",
"net_unit_amount": 10000.01,
"quantity": 1
}
],
"created": "2021-12-31T23:59:59Z",
"updated": "2021-12-31T23:59:59Z"
}{
"business_id": "5f27a14a9bf05c73dd040bc8",
"reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
"payment_token_id": "pt-90392f42-d98a-49ef-a7f3-abcezas123",
"payment_request_id": "pr-90392f42-d98a-49ef-a7f3-abcezas123",
"type": "PAY",
"country": "ID",
"currency": "IDR",
"request_amount": 10000.01,
"capture_method": "AUTOMATIC",
"channel_code": "DANA",
"channel_properties": {
"failure_return_url": "https://xendit.co/failure",
"success_return_url": "https://xendit.co/success"
},
"actions": [
{
"type": "REDIRECT_CUSTOMER",
"value": "xendit.co/example",
"descriptor": "WEB_URL"
}
],
"status": "REQUIRES_ACTION",
"description": "Description examples",
"metadata": {
"metametadata": "metametametadata"
},
"created": "2021-12-31T23:59:59Z",
"updated": "2021-12-31T23:59:59Z"
}{
"business_id": "5f27a14a9bf05c73dd040bc8",
"reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
"payment_token_id": "pt-90392f42-d98a-49ef-a7f3-abcezas123",
"payment_request_id": "pr-90392f42-d98a-49ef-a7f3-abcezas123",
"type": "PAY",
"country": "ID",
"currency": "IDR",
"request_amount": 10000.01,
"capture_method": "AUTOMATIC",
"channel_code": "CARDS",
"channel_properties": {},
"actions": [],
"status": "SUCCEEDED",
"description": "Description examples",
"metadata": {
"metametadata": "metametametadata"
},
"created": "2021-12-31T23:59:59Z",
"updated": "2021-12-31T23:59:59Z"
}Payment request object
Xendit-generated identifier for the business that owns the transaction
A reference ID from merchants to identify their request. For "CARDS" channel code, reference ID must be unique.
Xendit unique Payment Request ID generated as reference after creation of payment request.
Xendit unique Payment Token ID generated as reference for reusable payment details of the end user.
Xendit unique Capture ID generated as reference for the end user
Latest Payment ID linked to the payment request.
The payment collection intent type for the payment request.
PAY: Create a payment request that is able to receive one payment.
PAY_AND_SAVE: Create a payment request that is able to receive one payment. If the payment is successful, a reusable payment token will be returned for subsequent payment requests.
REUSABLE_PAYMENT_CODE: Create a payment request that is able to receive multiple payments. This is only used for repeat use payment method like a static QR, a predefined OTC payment code or a predefined Virtual Account number.
ISO 3166-1 alpha-2 two-letter country code for the country of transaction.
ISO 4217 three-letter currency code for the payment.
The intended payment amount to be collected from the end user.
AUTOMATIC: payment capture will be processed immediately after payment request is created. MANUAL: payment capture requires merchant's trigger via payment capture endpoint before being processed
Channel code used to select the payment method provider. Use routing payment channels mapping for full list of channel codes.
Data required to initiate transaction with payment method provider. Use routing payment channels mapping for full list of data required.
Actions object contains possible next steps merchants can take to proceed with payment collection from end user
The type of action that merchant system will need to handle to complete payment.
The type of action that merchant system will need to handle to complete payment.
The specific value that will be used by merchant to complete the action
Status of the payment request.
Failure codes for payments.
A custom description for the Payment Request.
Key-value entries for your custom data. You can specify up to 50 keys, with key names up to 40 characters and values up to 500 characters. This is for your convenience. Xendit will not use this data for any processing.
Array of objects describing the item/s attached to the payment.
Type of item
Name of item
Net amount to be charged per unit. Must be a negative number when type = DISCOUNT
Number of units of this item in the basket
URL of the item. Must be HTTPS or HTTP
URL of the image of the item. Must be HTTPS or HTTP
Category for item
Sub-category for item
Description of item
Key-value entries for your custom data. You can specify up to 50 keys, with key names up to 40 characters and values up to 500 characters. This is for your convenience. Xendit will not use this data for any processing.
2-letter ISO 3166-2 country code for the customer’s shipping country
Building name and apartment unit number
Building street address
City, village or town as appropriate
Either one of (whichever is applicable): Geographic area, province, or region / Formal state designation within country
Postal, zip or rural delivery code, if applicable
ISO 8601 date-time format.
ISO 8601 date-time format.
Bad request
Values in the payment request is not within expected range or expected configurations. Check the specific error message for debugging.
Fields or values in the payment request does not comply with our API specification. Check the specific error message for debugging.
Card expiry specified in the request should not be earlier than current month.
The payment details entered by the end user is invalid. Check the specific error message for debugging.
Maximum number of requests to this payment channel has been exceeded in a given time frame.
Payment token ID specified in the payment request has expired or has been cancelled. Please reinitiate linking before retrying.
Forbidden
Non 3DS payment request for cards is not allowed. Please activate the feature on Xendit dashboard before proceeding.
Merchant credentials met with an error with the provider. Please contact Xendit customer support to resolve this issue.
Payment token ID specified in the request was denied access by the payment method provider.
Conflict
Duplication is not allowed. Check specific error message for debugging.
The end user has already linked their account previously.
Internal server error
An unexpected error occured, our team has been notified and will troubleshoot the issue
Service unavailable
The channel requested is currently experiencing unexpected issues. The provider will be notified to resolve this issue.
The end user's payment method provider is currently experiencing unexpected issues. The provider will be notified to resolve this issue.