Xendit

https://docs.xendit.co/v1/docs
Admin
Xendit is a fintech platform that enables businesses to accept payments, send payouts, and manage...
Tokens:70,246
Snippets:175
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example Response for Retrieving Payment Token

Source: https://docs.xendit.co/v1/docs/store-a-card-for-one-click

An example JSON response detailing the stored card information, including masked card number, expiry details, and cardholder information, after a successful retrieval of a payment token.

```JSON
{
    "payment_token_id": "YOUR_PAYMENT_TOKEN_ID",
    "business_id": "YOUR_BUSINESS_ID",
    "customer_id": "YOUR_CUSTOMER_ID",
    "country": "ID",
    "reference_id": "YOUR_REFERENCE_ID",
    "currency": "IDR",
    "status": "ACTIVE",
    "actions": [],
    "created": "2024-12-05T02:05:56.176308Z",
    "updated": "2024-12-05T02:19:02.935905Z",
    "channel_properties": {
        "skip_three_ds": false,
        "success_return_url": "https://yourcompany.com/success",
        "failure_return_url": "https://yourcompany.com/failure",
        "card_details": {
            "masked_card_number": "400000XXXXXX1091",
            "cardholder_first_name": "Jaap",
            "cardholder_last_name": "Stam",
            "cardholder_email": "Jaap@stam.com",
            "cardholder_phone_number": "+6512341234",
            "expiry_month": "12",
            "expiry_year": "2040",
            "fingerprint": "635a0be115cf90001ae83752",
            "type": "CREDIT",
            "network": "VISA",
            "country": "ID",
            "issuer": "BRI"
        },
        "card_on_file_type": "CUSTOMER_UNSCHEDULED",
        "card_verification_results": {
            "three_ds_data": {
                "three_ds_flow": "CHALLENGE",
                "eci_code": "05",
                "three_ds_result": "AUTHENTICATED",
                "three_ds_result_reason": null,
                "three_ds_version": "2.1.0"
            },
            "cvn_result": null,
            "address_verification_result": "MATCH"
        }
    },
    "channel_code": "CARDS"
}
```

--------------------------------

### Xendit Payment Capture Webhook Example

Source: https://docs.xendit.co/v1/docs/one-click-with-cvn

An example payload for the `payment.capture` webhook event sent by Xendit. This webhook provides the final status of the transaction, including details like capture amount, currency, payment ID, and customer ID, which is crucial for backend reconciliation.

```json
{
    "created": "2024-12-18T05:46:35.109Z",
    "business_id": "62440e322008e87fb29c1fd0",
    "event": "payment.capture",
    "data": {
        "type": "PAY",
        "status": "SUCCEEDED",
        "country": "ID",
        "created": "2024-12-18T05:46:08.192Z",
        "updated": "2024-12-18T05:46:30.627Z",
        "captures": [
            {
                "capture_id": "cptr-08f17fa3-e80c-4d8e-8c34-17aa3400bc1c",
                "capture_amount": 10000,
                "capture_timestamp": "2024-12-18T05:46:34.234Z"
            }
        ],
        "currency": "IDR",
        "payment_id": "py-3f57d678-2448-4c9f-a433-8468d366fb5c",
        "business_id": "62440e322008e87fb29c1fd0",
        "customer_id": "cust-7de9a9b4-37e8-40ad-b665-d97f42e538c5",
        "channel_code": "CARDS",
        "reference_id": "97ba0a32-b996-4abf-8a7b-6184a6644676_b8d18f2f-3",
        "capture_method": "AUTOMATIC",
        "request_amount": 10000,
        "payment_details": {
            "authorization_data": {
                "reconciliation_id": "7345007929096981703954",
                "authorization_code": "831000",
                "acquirer_merchant_id": "xendit_ctv_agg",
                "network_response_code": "00",
                "network_transaction_id": "016153570198200",
                "cvn_verification_result": "M"
            }
        }
    }
}
```

--------------------------------

### Handle Payment Actions

Source: https://docs.xendit.co/v1/docs/pay-one-off-payment

Describes how to handle the actions returned in a payment request response, such as redirecting the customer or presenting payment details.

```APIDOC
## Handling Payment Actions

Upon receiving a payment request response with the status `REQUIRES_ACTION`, your application needs to handle the provided actions to allow the end user to complete the payment.

### Action Types

#### 1. PRESENT_TO_CUSTOMER
- **Description**: This action type indicates that payment details need to be presented directly to the customer. This often involves displaying a QR code string or other payment information.
- **Implementation**: On your client application, render the `value` associated with this action (e.g., convert a QR string to a scannable QR code). It is recommended to include clear payment instructions alongside the displayed information.

#### 2. REDIRECT_CUSTOMER
- **Description**: This action type requires redirecting the customer to a specific URL to complete the payment process.
- **Implementation**: On your client application, redirect the user to the URL provided in the `value` field. Consider handling device types and potential redirection rules for pending or cancelled payments based on the payment channel.
```

--------------------------------

### Channel Properties: Installment Configuration

Source: https://docs.xendit.co/v1/docs/routing-payment-channels

Explains the `installment_configuration` object, including the `terms` and `interval` fields for setting up installment payments.

```APIDOC
## POST /any/endpoint (example)

### Description
This section details the `installment_configuration` for setting up payment installments. It includes `terms`, which is an array of numbers representing the number of installments, and `interval`, which specifies the unit of time for the installment schedule (e.g., MONTH).

### Method
POST

### Endpoint
/any/endpoint

### Parameters
#### Request Body
- **channel_properties** (object) - Required - Contains channel-specific properties.
  - **installment_configuration** (object) - Optional - Configuration for installment payments.
    - **terms** (array of number) - Required - The number of installments available (e.g., [12]).
    - **interval** (string) - Required - The unit of time used in defining the installment schedule (Available values: MONTH).

### Request Example
```json
{
  "channel_properties": {
    "installment_configuration": {
        "terms": [12],
        "interval": "MONTH"
    }
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - A success message.

#### Response Example
```json
{
  "message": "Installment configuration updated"
}
```
```

--------------------------------

### Xendit Payment Request Response

Source: https://docs.xendit.co/v1/docs/pay-with-tokens

This is a sample response from the Xendit API after creating a payment request. It includes details about the payment, its status, and any actions required to complete the payment, such as redirecting the customer.

```json
{
  "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",
  "customer_id": "cust-90392f42-d98a-49ef-a7f3-abcezas123",
  "type": "PAY",
  "country": "TH",
  "currency": "THB",
  "channel_code": "CARDS",
  "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"
  },
  "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"
}
```

--------------------------------

### Payment Status Lifecycle - No Action Required

Source: https://docs.xendit.co/v1/docs/pay-with-tokens

This section details the status transitions for payment requests where no immediate user action is needed.

```APIDOC
## Payment Status Lifecycle - No Action Required

This table describes the status lifecycle for a payment request that has no action required.

### Statuses

| Status    | Description                                                                                                                                          |
|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------|
| **SUCCEEDED** | The payment request transitions to this status synchronously when the payment is immediately successful. You will still receive the **payment.capture** webhook containing payment details. |
| **FAILED**    | The payment request transitions to this status synchronously when the payment is immediately failed. You will still receive the **payment.failure** webhook. **Note**: Not all payment channels provide notifications for failed payment. |
| **PENDING**   | The payment request enters this status synchronously upon API response if the payment partner has not yet responded with a payment result. Wait for the payment webhook to arrive at your configured webhook URL. |

### Webhook Events

| Status    | Webhook Event |
|-----------|---------------|
| **SUCCEEDED** | **payment.capture** |
| **FAILED**    | **payment.failure** |

```

--------------------------------

### Xendit Payment Token Activation Webhook

Source: https://docs.xendit.co/v1/docs/store-a-card-for-one-click

Example webhook payload received from Xendit indicating the successful activation of a payment token. This event signals that the card has been tokenized and can be used for future transactions. It includes authorization details and the final `payment_token_id`.

```json
{
    "created": "2024-12-18T03:57:21.601Z",
    "business_id": "62440e322008e87fb29c1fd0",
    "event": "payment_token.activation",
    "data": {
        "status": "ACTIVE",
        "country": "ID",
        "created": "2024-12-18T03:57:19.330Z",
        "updated": "2024-12-18T03:57:21.215Z",
        "currency": "IDR",
        "business_id": "62440e322008e87fb29c1fd0",
        "customer_id": "cust-9f02010d-1189-4f2c-95e9-fe7f52fdd29b",
        "channel_code": "CARDS",
        "reference_id": "efe51f0c-ea1f-45ec-96e4-5275db384d68_1b0d11cd-a",
        "token_details": {
            "authorization_data": {
                "reconciliation_id": "7344942402526026003955",
                "authorization_code": "831000",
                "acquirer_merchant_id": "xendit_ctv_agg",
                "network_response_code": "00",
                "network_transaction_id": "016153570198200",
                "cvn_verification_result": "M",
                "retrieval_reference_number": "435203752181",
                "address_verification_result": "M",
                "network_response_code_descriptor": "Approved and completed sucessfully"
            }
        },
        "payment_token_id": "pt-eda13864-5091-4bd2-b88d-ae640be90ee7",
        "channel_properties": {
            "card_details": {
                "type": "CREDIT",
                "issuer": "BRI",
                "country": "ID",
                "network": "VISA"
            }
        }
    }
}
```

--------------------------------

### Create Payment Session

Source: https://docs.xendit.co/v1/docs/one-click-with-cvn

Initiate a payment session by sending a POST request to the `/sessions` endpoint with the card payment token ID.

```APIDOC
## POST /sessions

### Description
Initiates a payment session for card transactions.

### Method
POST

### Endpoint
/sessions

### Parameters
#### Request Body
- **reference_id** (string) - Required - Your unique identifier for the payment.
- **session_type** (string) - Required - Type of session, e.g., "PAY".
- **mode** (string) - Required - Payment mode, e.g., "CARDS_SESSION_JS".
- **amount** (number) - Required - The transaction amount.
- **currency** (string) - Required - The currency code (e.g., "IDR").
- **country** (string) - Required - The country code (e.g., "ID").
- **customer** (object) - Required - Customer details.
  - **reference_id** (string) - Required - Customer's reference ID.
  - **type** (string) - Required - Customer type (e.g., "INDIVIDUAL").
  - **email** (string) - Required - Customer's email address.
  - **mobile_number** (string) - Required - Customer's mobile number.
  - **individual_detail** (object) - Required - Individual customer details.
    - **given_names** (string) - Required - Customer's given names.
    - **surname** (string) - Required - Customer's surname.
- **cards_session_js** (object) - Required - Card session details.
  - **card_payment_token_id** (string) - Required - The ID of the stored card payment token.
  - **success_return_url** (string) - Required - URL to redirect upon successful payment.
  - **failure_return_url** (string) - Required - URL to redirect upon failed payment.

### Request Example
```json
{
    "reference_id": "YOUR_PAYMENT_REFERENCE_ID",
    "session_type": "PAY",
    "mode": "CARDS_SESSION_JS",
    "amount": 100000,
    "currency": "IDR",
    "country": "ID",
    "customer": {
        "reference_id": "YOUR_CUSTOMER_REFERENCE",
        "type": "INDIVIDUAL",
        "email": "test@yourdomain.com",
        "mobile_number": "+6212345678",
        "individual_detail": {
            "given_names": "Jaap",
            "surname": "Stam"
        }
    },
    "cards_session_js": {
        "card_payment_token_id":"pt-a15a6c28-c65a-4ede-a6cc-10ff3b1d093e",
        "success_return_url": "https://yourcompany.com/success",
        "failure_return_url": "https://yourcompany.com/failure"
    }
}
```

### Response
#### Success Response (200)
- **payment_session_id** (string) - Unique ID for the payment session.
- **created** (string) - Timestamp of session creation.
- **updated** (string) - Timestamp of last session update.
- **status** (string) - Current status of the session (e.g., "ACTIVE").
- **reference_id** (string) - Your reference ID for the payment.
- **currency** (string) - Transaction currency.
- **amount** (number) - Transaction amount.
- **country** (string) - Transaction country.
- **customer_id** (string) - Xendit's customer ID.
- **expires_at** (string) - Timestamp when the session expires.
- **session_type** (string) - Type of session.
- **mode** (string) - Payment mode.
- **locale** (string) - Locale for the session.
- **business_id** (string) - Your business ID.
- **cards_session_js** (object) - Card session details.
  - **card_payment_token_id** (string) - ID of the stored card payment token.
  - **success_return_url** (string) - URL for successful payment redirection.
  - **failure_return_url** (string) - URL for failed payment redirection.

#### Response Example
```json
{
    "payment_session_id": "ps-6746c1006b7752b4d91725af",
    "created": "2024-11-27T06:49:36.535Z",
    "updated": "2024-11-27T06:49:36.535Z",
    "status": "ACTIVE",
    "reference_id": "YOUR_PAYMENT_REFERENCE_ID",
    "currency": "IDR",
    "amount": 10000,
    "country": "ID",
    "customer_id": "XENDIT_GENERATED_CUSTOMER_ID",
    "expires_at": "2024-11-27T07:19:36.434Z",
    "session_type": "PAY",
    "mode": "CARDS_SESSION_JS",
    "locale": "en",
    "business_id": "YOUR_BUSINESS_ID", 
    "cards_session_js": {
        "card_payment_token_id":"pt-a15a6c28-c65a-4ede-a6cc-10ff3b1d093e",
        "success_return_url": "https://yourcompany.com/success",
        "failure_return_url": "https://yourcompany.com/failure"
    }
}
```
```

--------------------------------

### Handling Webhook Failures

Source: https://docs.xendit.co/v1/docs/pay-one-off-payment

Provides guidance on how to handle scenarios where webhooks might not be received, ensuring a complete payment journey for the end user.

```APIDOC
## Handling Webhook Failures

### Description
In real-time messaging systems, there's a possibility that a webhook might not reach your system. This section provides recommendations for handling such scenarios to ensure a robust payment journey for your end users.

### Recommendation
Your application should cater for the scenario where a webhook is not received while the end user is still waiting on their screen. In such cases, it is recommended to display a pending payment notice to the end user while you await a webhook from Xendit. This ensures a better user experience even in the event of communication delays.
```

--------------------------------

### Example Payment Token Response

Source: https://docs.xendit.co/v1/docs/pay-and-save-1

An example JSON response structure when requesting details for a payment token. This illustrates the fields available, such as payment token ID, customer ID, country, status, and detailed channel properties including card details.

```JSON
{
    "payment_token_id": "pt-f5f570a2-f204-49ae-b2f0-10b786de5047",
    "business_id": "62440e322008e87fb29c1fd0",
    "customer_id": "cust-c1a6b0a0-a501-4479-8b57-d038601f139e",
    "country": "ID",
    "reference_id": "ref-id-1_Z6a2sG4sfp",
    "currency": "IDR",
    "status": "ACTIVE",
    "actions": [],
    "created": "2025-01-10T08:45:24.687Z",
    "updated": "2025-01-10T08:45:41.246Z",
    "channel_properties": {
        "success_return_url": "https://checkout-staging.xendit.co/session/ps-6780de086602873447b03b01?token_request_id=82232fe7-32bc-4004-ae15-0cb99dc56b5f",
        "failure_return_url": "https://checkout-staging.xendit.co/session/ps-6780de086602873447b03b01?token_request_id=82232fe7-32bc-4004-ae15-0cb99dc56b5f",
        "skip_three_ds": false,
        "card_on_file_type": "RECURRING",
        "recurring_configuration": {
            "recurring_expiry": "2025-12-12",
            "recurring_frequency": 30
        },
        "card_details": {
            "masked_card_number": "400000XXXXXX1091",
            "expiry_month": "01",
            "expiry_year": "2028",
            "fingerprint": "62c571cc9f1788001b255135",
            "type": "CREDIT",
            "network": "VISA",
            "country": "ID",
            "issuer": "BRI",
            "cardholder_first_name": "John",
            "cardholder_last_name": "Doe",
            "cardholder_email": "test@yourdomain.com",
            "cardholder_phone_number": "+628121233333"
        }
    },
    "channel_code": "CARDS",
    "token_details": {
        "authentication_data": {
            "flow": "CHALLENGE",
            "a_res": {
                "eci": "05",
                "message_version": "2.1.0",
                "authentication_value": "AAIBBYNoEwAAACcKhAJkdQAAAAA=","directory_server_trans_id": "df613bfd-2619-4f1c-989c-f7b32029d4a7"
            }
        },
        "authorization_data": {
            "cvn_verification_result": "M",
            "address_verification_result": "M",
            "network_response_code": "00",
            "network_response_code_descriptor": "Approved and completed sucessfully",
            "authorization_code": "831000",
            "retrieval_reference_number": "501008635675",
            "acquirer_merchant_id": "xendit_ctv_agg",
            "reconciliation_id": "7364987404086454403955",
            "network_transaction_id": "016153570198200"
        }
    }
}
```

--------------------------------

### GET /websites/xendit_co_v1/payment_channels

Source: https://docs.xendit.co/v1/docs/available-payment-channels

Retrieves a list of available payment channels with detailed information about each channel's supported features and parameters.

```APIDOC
## GET /payment_channels

### Description
Retrieves a list of available payment channels with detailed information about each channel's supported features and parameters.

### Method
GET

### Endpoint
/payment_channels

### Query Parameters
- **currency** (string) - Optional - Filter payment channels by currency.
- **country** (string) - Optional - Filter payment channels by country.
- **type** (string) - Optional - Filter payment channels by type (e.g., e-wallet, bank transfer).

### Request Example
```json
{
  "example": "GET /payment_channels?currency=IDR&country=ID"
}
```

### Response
#### Success Response (200)
- **channel_code** (string) - Unique identifier for the payment channel.
- **display_name** (string) - Branding name of the payment channel.
- **currency** (string) - Currency supported by the payment channel.
- **country** (string) - Country where the payment channel can be used.
- **type** (string) - Category or flow for payment channels.
- **min_amount** (number) - Minimum amount that can be collected.
- **max_amount** (number) - Maximum amount that can be collected.
- **settlement_time** (string) - Settlement duration and type (e.g., "T+2 BUSINESS DAYS", "INSTANT").
- **save** (boolean) - Indicates if the channel supports saving payment information.
- **reusable_payment_code** (boolean) - Indicates if the channel supports reusable payment codes.
- **user_approval_flow** (string) - Describes the user authentication flow (e.g., "REDIRECT", "Present to customers").
- **merchant_initiated_transactions** (boolean) - Indicates if the channel supports merchant-initiated transactions.
- **payment_processing_time** (string) - Time delay for payment confirmation.
- **custom_payment_code** (boolean) - Indicates if the channel supports custom payment codes.
- **installments** (boolean) - Indicates if the channel supports installment payments.
- **auth_capture** (boolean) - Indicates if the channel supports auth and capture.
- **partial_capture** (boolean) - Indicates if the channel supports partial capture.
- **multiple_partial_capture** (boolean) - Indicates if the channel supports multiple partial captures.
- **desktop_support** (boolean) - Indicates if the channel is supported on desktop devices.
- **mobile_support** (boolean) - Indicates if the channel is supported on mobile devices.
- **display_merchant_name** (boolean) - Indicates if the merchant name is displayed to the user.
- **display_user_name** (boolean) - Indicates if the user name is displayed, if available.
- **payment_request_expiry_hours** (number) - Duration in hours before a payment request expires.
- **payment_token_validity_years** (number) - Maximum validity period of a saved payment token.
- **refund** (boolean) - Indicates if the channel supports full refunds.
- **partial_refund** (boolean) - Indicates if the channel supports partial refunds.
- **multiple_partial_refund** (boolean) - Indicates if the channel supports multiple partial refunds.
- **refund_validity_days** (number) - Maximum number of days after the original transaction that a refund can be made.
- **payment_link** (boolean) - Indicates if the channel supports payment links.
- **fund_flow** (string) - Describes the settlement fund routing (e.g., "Aggregator", "Switcher").

#### Response Example
```json
[
  {
    "channel_code": "AKULAKU",
    "display_name": "Akulaku",
    "currency": "IDR",
    "country": "ID",
    "type": "e-wallet",
    "min_amount": 1000,
    "max_amount": 25000000,
    "settlement_time": "T+2 BUSINESS DAYS",
    "save": false,
    "reusable_payment_code": false,
    "user_approval_flow": "REDIRECT",
    "merchant_initiated_transactions": false,
    "payment_processing_time": "INSTANT",
    "custom_payment_code": false,
    "installments": true,
    "auth_capture": false,
    "partial_capture": false,
    "multiple_partial_capture": false,
    "desktop_support": true,
    "mobile_support": true,
    "display_merchant_name": true,
    "display_user_name": false,
    "payment_request_expiry_hours": 24,
    "payment_token_validity_years": 0,
    "refund": true,
    "partial_refund": true,
    "multiple_partial_refund": false,
    "refund_validity_days": 30,
    "payment_link": true,
    "fund_flow": "Switcher"
  }
]
```
```

--------------------------------

### Payment Status Lifecycle - No Action Required

Source: https://docs.xendit.co/v1/docs/pay-and-save

Describes the status transitions and webhook events for payment requests where no user interaction is needed.

```APIDOC
## Payment Status Lifecycle - No Action Required

### Statuses and Descriptions

*   **SUCCEEDED**: The payment request transitions to this status synchronously when the payment is immediately successful. You will still receive the `payment.capture` webhook containing payment details and the `payment_token.activation` webhook for the payment token created.
*   **FAILED**: The payment request transitions to this status synchronously when the payment is immediately failed. You will still receive the `payment.failure` webhook. Note: Not all payment channels provide notifications for failed linking processes.
*   **PENDING**: The payment request enters this status synchronously upon API response if the payment partner has not yet responded with a payment result. Wait for the payment webhook to arrive at your configured webhook URL.

### Webhook Events

*   **SUCCEEDED**: `payment.capture`, `payment_token.activation`
*   **FAILED**: `payment.failure`
*   **PENDING**: -
```

--------------------------------

### Payment Status Lifecycle (No User Action Required)

Source: https://docs.xendit.co/v1/docs/pay-one-off-payment

Details the status transitions for payment requests where no immediate user interaction is needed, including synchronous API responses and webhook events.

```APIDOC
## Payment Status Lifecycle (No User Action Required)

### Description
This section outlines the status lifecycle for a payment request that does not require immediate user action. It details the synchronous transitions and the webhook events triggered.

### Statuses and Transitions

| Status    | Description                                                                                                                                                                  |
|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **SUCCEEDED** | The payment request transitions to this status synchronously when the payment is immediately successful. You will still receive the `payment.capture` webhook.                 |
| **FAILED**    | The payment request transitions to this status synchronously when the payment is immediately failed. You will still receive the `payment.failure` webhook.                        |
| **PENDING**   | The payment request enters this status synchronously upon API response if the payment partner has not yet responded with a payment result. Wait for the payment webhook to arrive. |

### Webhook Events

| Status    | Webhook Event     |
|-----------|-------------------|
| **SUCCEEDED** | `payment.capture` |
| **FAILED**    | `payment.failure` |

```

--------------------------------

### Payment Status Lifecycle - User Action Required

Source: https://docs.xendit.co/v1/docs/pay-and-save

Describes the status transitions and webhook events for payment requests that require user interaction.

```APIDOC
## Payment Status Lifecycle - User Action Required

### Statuses and Descriptions

*   **REQUIRES_ACTION**: The payment request enters this status synchronously upon API response if user action is required to complete authorization. Handle the `actions` object in this stage.
*   **SUCCEEDED**: The payment request transitions to this status when the payment is successfully completed. Xendit will send the `payment.capture` webhook as the payment identifier and the `payment_token.activation` webhook for the payment token created. You should store the `payment_token_id` for use in future transactions.
*   **FAILED**: The payment request transitions to this status when the payment fails. Xendit will send the `payment.failure` webhook containing the `payment_request_id` to identify the request. Check the `failure_code` to determine the next action. Note: Not all payment channels provide notifications for failed payment.
*   **CANCELED**: You can cancel a payment request that is in the `REQUIRES_ACTION` status. Canceling immediately transitions the payment request to `CANCELED`, and the end user will no longer be able to complete the `actions`.
*   **EXPIRED**: The payment request transitions to this status when it expires due to the payment partner’s expiry.

### Webhook Events

*   **REQUIRES_ACTION**: -
*   **SUCCEEDED**: `payment.capture`, `payment_token.activation`
*   **FAILED**: `payment.failure`
*   **CANCELED**: -
*   **EXPIRED**: -
```

--------------------------------

### Create Payment Request

Source: https://docs.xendit.co/v1/docs/pay-one-off-payment

Construct an API request to create a payment request for a chosen payment channel. The `type` should be `PAY` for guest checkout scenarios.

```APIDOC
## POST /payment_requests

### Description
Creates a payment request for a selected payment channel. This is a key step in the checkout flow where the user selects their preferred payment method.

### Method
POST

### Endpoint
/payment_requests

### Parameters
#### Request Body
- **reference_id** (string) - Required - A unique identifier for the payment request.
- **type** (string) - Required - The type of payment operation. Use 'PAY' for guest checkouts.
- **country** (string) - Required - The country code for the payment (e.g., 'PH').
- **currency** (string) - Required - The currency code for the payment (e.g., 'PHP').
- **request_amount** (number) - Required - The amount to be paid.
- **capture_method** (string) - Required - The method for capturing the payment ('AUTOMATIC' or 'MANUAL').
- **channel_code** (string) - Required - The code of the payment channel to use (e.g., 'GCASH').
- **channel_properties** (object) - Optional - Properties specific to the chosen channel.
  - **failure_return_url** (string) - Optional - URL to redirect to upon payment failure.
  - **success_return_url** (string) - Optional - URL to redirect to upon successful payment.
- **description** (string) - Optional - A description for the payment.
- **metadata** (object) - Optional - Arbitrary key-value pairs to store with the payment request.

### Request Example
```json
{
    "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"
    }
  }
```

### Response
#### Success Response (200)
- **business_id** (string) - The ID of the business.
- **reference_id** (string) - The unique identifier for the payment request.
- **payment_request_id** (string) - The ID generated by Xendit for the payment request.
- **type** (string) - The type of payment operation.
- **country** (string) - The country code of the payment.
- **currency** (string) - The currency code of the payment.
- **request_amount** (number) - The requested amount for the payment.
- **capture_method** (string) - The method used for capturing the payment.
- **channel_code** (string) - The code of the payment channel used.
- **channel_properties** (object) - Properties specific to the payment channel.
- **actions** (array) - A list of actions required to complete the payment.
  - **type** (string) - The type of action (e.g., 'REDIRECT_CUSTOMER', 'PRESENT_TO_CUSTOMER').
  - **value** (string) - The value associated with the action (e.g., a URL or string to display).
  - **descriptor** (string) - A descriptor for the action.
- **status** (string) - The current status of the payment request (e.g., 'REQUIRES_ACTION').
- **description** (string) - A description for the payment.
- **metadata** (object) - Arbitrary key-value pairs associated with the payment request.
- **created** (string) - The timestamp when the payment request was created.
- **updated** (string) - The timestamp when the payment request was last updated.

#### Response Example
```json
{
    "business_id": "5f27a14a9bf05c73dd040bc8",
    "reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
    "payment_request_id": "pr-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"
    },
    "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"
  }
```
```

--------------------------------

### Payment Token Activation Webhook

Source: https://docs.xendit.co/v1/docs/store-a-card-for-one-click

Receives webhook notifications from Xendit regarding the activation status of a payment token.

```APIDOC
## Webhook: payment_token.activation

### Description
Xendit sends a webhook to your specified endpoint to notify you about the status of a payment token's activation. This is crucial for confirming successful card storage.

### Method
Webhook Notification (POST request to your endpoint)

### Endpoint
Your configured webhook URL

### Parameters
#### Request Body
- **created** (string) - Timestamp of the event creation.
- **business_id** (string) - Your Xendit business ID.
- **event** (string) - The event type, which will be `payment_token.activation` for this notification.
- **data** (object) - Contains the details of the payment token activation.
  - **status** (string) - The activation status (e.g., 'ACTIVE').
  - **country** (string) - Country code associated with the token.
  - **created** (string) - Timestamp of token creation.
  - **updated** (string) - Timestamp of the last token update.
  - **currency** (string) - Currency code.
  - **business_id** (string) - Your Xendit business ID.
  - **customer_id** (string) - The ID of the customer associated with the token.
  - **channel_code** (string) - The payment channel used (e.g., 'CARDS').
  - **reference_id** (string) - The reference ID from the initial payment session.
  - **token_details** (object) - Contains details about the authorization.
    - **authorization_data** (object) - Specific authorization details.
      - **reconciliation_id** (string) - Reconciliation ID from the acquirer.
      - **authorization_code** (string) - Authorization code from the bank.
      - **acquirer_merchant_id** (string) - Merchant ID assigned by the acquirer.
      - **network_response_code** (string) - Response code from the card network.
      - **network_transaction_id** (string) - Transaction ID from the card network.
      - **cvn_verification_result** (string) - CVN verification result (e.g., 'M' for Match).
      - **retrieval_reference_number** (string) - Retrieval reference number.
      - **address_verification_result** (string) - AVS verification result (e.g., 'M' for Match).
      - **network_response_code_descriptor** (string) - Description of the network response code.
  - **payment_token_id** (string) - The unique identifier for the payment token.
  - **channel_properties** (object) - Properties specific to the payment channel.
    - **card_details** (object) - Details about the card used.
      - **type** (string) - Card type (e.g., 'CREDIT').
      - **issuer** (string) - Card issuer (e.g., 'BRI').
      - **country** (string) - Country of the card issuer.
      - **network** (string) - Card network (e.g., 'VISA').

### Response Example (Webhook Payload)
```json
{
    "created": "2024-12-18T03:57:21.601Z",
    "business_id": "62440e322008e87fb29c1fd0",
    "event": "payment_token.activation",
    "data": {
        "status": "ACTIVE",
        "country": "ID",
        "created": "2024-12-18T03:57:19.330Z",
        "updated": "2024-12-18T03:57:21.215Z",
        "currency": "IDR",
        "business_id": "62440e322008e87fb29c1fd0",
        "customer_id": "cust-9f02010d-1189-4f2c-95e9-fe7f52fdd29b",
        "channel_code": "CARDS",
        "reference_id": "efe51f0c-ea1f-45ec-96e4-5275db384d68_1b0d11cd-a",
        "token_details": {
            "authorization_data": {
                "reconciliation_id": "7344942402526026003955",
                "authorization_code": "831000",
                "acquirer_merchant_id": "xendit_ctv_agg",
                "network_response_code": "00",
                "network_transaction_id": "016153570198200",
                "cvn_verification_result": "M",
                "retrieval_reference_number": "435203752181",
                "address_verification_result": "M",
                "network_response_code_descriptor": "Approved and completed sucessfully"
            }
        },
        "payment_token_id": "pt-eda13864-5091-4bd2-b88d-ae640be90ee7",
        "channel_properties": {
            "card_details": {
                "type": "CREDIT",
                "issuer": "BRI",
                "country": "ID",
                "network": "VISA"
            }
        }
    }
}
```
```
Tokens:
Raw