Retrieve the status of your payment request that was created.
Fetch Payment Request Status
{
"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": "2222XXXXXXXX8888",
"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": "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"
},
"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_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"
},
"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_request_id": "pr-90392f42-d98a-49ef-a7f3-abcezas123",
"customer_id": "cust-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"
},
"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"
}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
Fields or values in the payment request does not comply with our API specification. Check the specific error message for debugging.
Not found
ID specified in request cannot be found.
Internal server error
An unexpected error occured, our team has been notified and will troubleshoot the issue