Xendit API

https://docs.xendit.co/apidocs
Admin
Xendit API provides a RESTful interface for developers to integrate payment processing, payouts,...
Tokens:251,447
Snippets:943
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Get Product List Response Example (JSON)

Source: https://docs.xendit.co/apidocs/get-product-list

This JSON object represents a successful response when fetching a list of PLN Prepaid products. It includes pagination details and product information.

```json
{
  "limit": 50,
  "cursor": "dummy-cursor-value-001==",
  "data": [
    {
      "type": "product",
      "id": "PLN_PREPAID_50K",
      "properties": {
        "product_name": "PLN Prepaid 50K",
        "category": "ELECTRICITY",
        "biller": "PLN",
        "country": "ID",
        "currency": "IDR",
        "requires_inquiry": false,
        "availability_status": "AVAILABLE",
        "admin_amount": 3200,
        "base_amount": 50000,
        "total_amount": 53200,
        "revenue_share_amount": 1000,
        "locale": {
          "en": "PLN Prepaid 50.000",
          "id": "PLN Prabayar 50.000"
        }
      }
    }
  ]
}
```

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

### Get File Details (JSON Response)

Source: https://docs.xendit.co/apidocs/get-file-by-id

This is an example of a successful JSON response when retrieving file details. It includes metadata such as file ID, business ID, purpose, creation and update timestamps, type, size, and the download URL.

```json
{
  "id": "file-ec700c1c-db17-4496-b1fb-04ebe551b412",
  "business_id": "ec700c1c-db17-4496-b1fb-04ebe551b412",
  "purpose": "CHARGEBACK_EVIDENCE",
  "created": "2020-10-08T06:38:33.479Z",
  "updated": "2020-10-08T06:38:33.479Z",
  "type": "image/png",
  "size": 10000,
  "url": "https://files.xendit.co/file-ec700c1c-db17-4496-b1fb-04ebe551b412"
}
```

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

### Create Payment Session Response Example

Source: https://docs.xendit.co/apidocs/create-session

Example JSON response returned upon successfully creating a payment session.

```json
{
  "payment_session_id": "ps-661f87c614802d6c402cd82d",
  "created": "2021-12-31T23:59:59Z",
  "updated": "2021-12-31T23:59:59Z",
  "reference_id": "Alice",
  "customer_id": "cust-e2878b4c-d57e-4a2c-922d-c0313c2800a3",
  "session_type": "SAVE",
  "currency": "IDR",
  "amount": "0",
  "country": "ID",
  "mode": "PAYMENT_LINK",
  "channel_properties": {},
  "allowed_payment_channels": [
    "OVO",
    "DANA"
  ],
  "expires_at": "2021-12-31T23:59:59Z",
  "locale": "en",
  "description": "Insurance Plan Registration",
  "success_return_url": "https://yourcompany.com/success/example_item=my_item",
  "cancel_return_url": "https://yourcompany.com/cancel/example_item=my_item",
  "items": null,
  "metadata": null,
  "status": "ACTIVE",
  "payment_link_url": "https://xen.to/kGxPCi60",
  "payment_token_id": null,
  "payment_request_id": null,
  "business_id": "661f87c614802d6c402cd82d"
}
```

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

### Get Conversion Transaction Details (JSON)

Source: https://docs.xendit.co/apidocs/get-transaction

Example response for a successful currency conversion transaction. Note the different currency fields for amount and net amount.

```json
{
  "id": "txn_3365895e-3cc1-490a-b48c-2757ce8ab0e5",
  "product_id": "cmanl0vtp000101u9lqbvn7im",
  "type": "CONVERSION",
  "status": "SUCCESS",
  "channel_category": "OTHER",
  "channel_code": "DEFAULT",
  "reference_id": "cmanl0vtp000101u9lqbvn7im",
  "account_identifier": null,
  "currency": "SGD",
  "amount": 6.55,
  "net_amount": 5.2,
  "net_amount_currency": "USD",
  "cashflow": "MONEY_IN",
  "settlement_status": "SETTLED",
  "estimated_settlement_time": "2025-05-14T06:51:08.999Z",
  "business_id": "675bdaf542c2f448122e71d5",
  "created": "2025-05-14T06:51:08.998Z",
  "updated": "2025-05-14T06:52:34.196Z",
  "fee": {
    "xendit_fee": 0,
    "value_added_tax": 0,
    "xendit_withholding_tax": 0,
    "third_party_withholding_tax": 0,
    "status": "NOT_APPLICABLE"
  }
}
```

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

### Get Transaction Details (JSON)

Source: https://docs.xendit.co/apidocs/get-transaction

Example response for a successful payment transaction. Includes details like ID, amount, status, and associated product data.

```json
{
  "id": "txn_pay_1234567890abcdef",
  "product_id": "py-123e4567-e89b-12d3-a456-426614174000",
  "type": "PAYMENT",
  "status": "SUCCESS",
  "channel_category": "EWallet",
  "channel_code": "ID_SHOPEEPAY",
  "reference_id": "payref-123456",
  "account_identifier": null,
  "currency": "IDR",
  "amount": 100000,
  "net_amount": 99000,
  "net_amount_currency": "IDR",
  "cashflow": "MONEY_IN",
  "settlement_status": "SETTLED",
  "estimated_settlement_time": "2025-06-01T10:00:00Z",
  "business_id": "1234567890abcdef",
  "created": "2025-06-01T09:59:00Z",
  "updated": "2025-06-01T10:01:00Z",
  "fee": {
    "xendit_fee": 1000,
    "value_added_tax": 0,
    "xendit_withholding_tax": 0,
    "third_party_withholding_tax": 0,
    "status": "COMPLETED"
  },
  "product_data": {
    "capture_id": "cap-e1a8b3e8-5b4a-4b1a-8b0e-4e8b1a8b0e4e",
    "payment_request_id": "pr-e1a8b3e8-5b4a-4b1a-8b0e-4e8b1a8b0e4f"
  }
}
```

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

### Get Individual Customer Example

Source: https://docs.xendit.co/apidocs/create-customer-request

This JSON object represents a successful response when retrieving an individual customer's details. It includes personal information, employment details, contact information, addresses, KYC documents, and metadata.

```json
{
  "id": "cust-239c16f4-866d-43e8-9341-7badafbc019f",
  "reference_id": "demo_1475801962607",
  "type": "INDIVIDUAL",
  "individual_detail": {
    "given_names": "John",
    "surname": "Doe",
    "nationality": "ID",
    "place_of_birth": "Jakarta",
    "date_of_birth": "1980-01-01",
    "gender": "MALE",
    "employment": {
      "employer_name": "Xendit",
      "nature_of_business": "Payment Gateway",
      "role_description": "Test dummy"
    }
  },
  "email": "customer@website.com",
  "mobile_number": "+62812123456",
  "phone_number": "+62812123456",
  "hashed_phone_number": "+628#######56",
  "addresses": [
    {
      "street_line1": "Panglima Polim IV",
      "street_line2": "Ruko Grand Panglima Polim, Blok E",
      "city": "Jakarta Selatan",
      "province_state": "DKI Jakarta",
      "postal_code": "993448",
      "country": "ID",
      "category": "HOME",
      "is_primary": true
    }
  ],
  "kyc_documents": [
    {
      "type": "IDENTITY_CARD",
      "sub_type": "NATIONAL_ID",
      "country": "ID",
      "document_name": "KTP",
      "document_number": "12356789012456",
      "expires_at": null,
      "holder_name": "John Doe",
      "document_images": [
        "file-ec700c1c-db17-4496-b1fb-04ebe551b412"
      ]
    }
  ],
  "description": "My first customer",
  "date_of_registration": "2020-03-30",
  "domicile_of_registration": "ID",
  "metadata": {
    "foo": "bar"
  },
  "created": "2020-03-30T06:12:47.212Z",
  "updated": "2020-03-30T06:12:47.212Z"
}
```

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

### Get Business Customer Response

Source: https://docs.xendit.co/apidocs/get-customer-id

Example JSON response when retrieving a business customer. This includes business details and associated accounts.

```json
{
  "id": "cust-239c16f4-866d-43e8-9341-7badafbc019f",
  "reference_id": "demo_1475801962607",
  "type": "BUSINESS",
  "business_detail": {
    "business_name": "ACME Corp",
    "trading_name": null,
    "business_type": "CORPORATION",
    "nature_of_business": null,
    "business_domicile": null,
    "date_of_registration": null
  },
  "email": "customer@website.com",
  "mobile_number": null,
  "phone_number": null,
  "hashed_phone_number": null,
  "addresses": [],
  "identity_accounts": [],
  "kyc_documents": [],
  "description": null,
  "metadata": {},
  "created": "2020-03-30T06:12:47.212Z",
  "updated": "2020-03-30T06:12:47.212Z"
}
```

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

### Merchant Metadata Example

Source: https://docs.xendit.co/apidocs/payment-token-webhook-notification

Example of the key-value object structure used for custom merchant metadata.

```json
{
  "my_custom_id": "merchant-123",
  "my_custom_order_id": "order-123"
}
```

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

### Get Individual Customer Response

Source: https://docs.xendit.co/apidocs/get-customer-id

Example JSON response when retrieving an individual customer. This includes personal details, contact information, addresses, and KYC documents.

```json
{
  "id": "cust-239c16f4-866d-43e8-9341-7badafbc019f",
  "reference_id": "demo_1475801962607",
  "type": "INDIVIDUAL",
  "individual_detail": {
    "given_names": "John",
    "surname": "Doe",
    "nationality": "ID",
    "place_of_birth": "Jakarta",
    "date_of_birth": "1980-01-01",
    "gender": "MALE",
    "employment": {
      "employer_name": "Xendit",
      "nature_of_business": "Payment Gateway",
      "role_description": "Test dummy"
    }
  },
  "email": "customer@website.com",
  "mobile_number": "+62812123456",
  "phone_number": "+62812123456",
  "hashed_phone_number": "+628#######56",
  "addresses": [
    {
      "street_line1": "Panglima Polim IV",
      "street_line2": "Ruko Grand Panglima Polim, Blok E",
      "city": "Jakarta Selatan",
      "province_state": "DKI Jakarta",
      "postal_code": "993448",
      "country": "ID",
      "category": "HOME",
      "is_primary": true
    }
  ],
  "identity_accounts": [
    {
      "type": "CREDIT_CARD",
      "company": "OCBC",
      "description": "My account",
      "country": "ID",
      "properties": {
        "token_id": "586f0ba2ab70de5d2b409e0d"
      }
    }
  ],
  "kyc_documents": [
    {
      "type": "IDENTITY_CARD",
      "sub_type": "NATIONAL_ID",
      "country": "ID",
      "document_name": "KTP",
      "document_number": "12356789012456",
      "expires_at": null,
      "holder_name": "John Doe",
      "document_images": [
        "file-ec700c1c-db17-4496-b1fb-04ebe551b412"
      ]
    }
  ],
  "description": "My first customer",
  "date_of_registration": "2020-03-30",
  "domicile_of_registration": "ID",
  "metadata": {
    "foo": "bar"
  },
  "created": "2020-03-30T06:12:47.212Z",
  "updated": "2020-03-30T06:12:47.212Z"
}
```

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

### Payment Token ID Example

Source: https://docs.xendit.co/apidocs/create-payment-request

Example of a unique Payment Token ID string.

```text
pt-cc3938dc-c2a5-43c4-89d7-7570793348c2
```

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

### Recurring Plan Schema Examples

Source: https://docs.xendit.co/apidocs/create-recurring-plan

Example values for recurring plan properties including reference ID, currency, payment token ID, and metadata.

```json
"reference_id": "my-plan-01"
```

```json
"currency": "IDR"
```

```json
"payment_token_id": "pt-f8429206-f3ea-49f0-abb4-eaa89064056e"
```

```json
"metadata": {
  "customKey": "customValue"
}
```

```json
"description": "My newspaper subscription 01"
```

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

### Payment Request Object Examples

Source: https://docs.xendit.co/apidocs/create-payment-request

JSON structures representing different payment request scenarios, including QR payments, Direct Debit, and Reusable Payment Codes.

```json
{
  "value": "00020101021153037643011A0000000677010111013202120000000000000000052048405303764540415005802TH5925THAI QR PAYMENT (EXAMPLE)6007Bangkok62070703001"
}
],
"status": "REQUIRES_ACTION",
"description": "Restaurant bill - Table 15",
"metadata": {
  "order_id": "321654",
  "table_number": "15",
  "branch": "bangkok_central",
  "service_type": "dine_in"
},
"created": "2025-01-15T12:37:50Z",
"updated": "2025-01-15T12:37:50Z"
}
```

```json
{
  "business_id": "5f27a14a9bf05c73dd040bc8",
  "reference_id": "dd_ph_456789_with_cust",
  "payment_request_id": "pr-90392f42-d98a-49ef-a7f3-abcezas132",
  "customer_id": "cust-e60078dd-494c-483c-a1e2-4f7bc34ff728",
  "type": "PAY",
  "country": "PH",
  "currency": "PHP",
  "request_amount": "2500",
  "capture_method": "AUTOMATIC",
  "channel_code": "BPI_DIRECT_DEBIT",
  "channel_properties": {
    "failure_return_url": "https://xendit.co/failure",
    "success_return_url": "https://xendit.co/success"
  },
  "actions": [
    {
      "type": "API_POST_REQUEST",
      "descriptor": "DEBIT_ACCOUNT",
      "value": "https://api.xendit.co/v1/direct_debits/authorize"
    }
  ],
  "status": "REQUIRES_ACTION",
  "description": "Bill payment - Account #456789",
  "metadata": {
    "bill_id": "456789",
    "customer_account": "ACC456789"
  },
  "created": "2025-01-15T12:39:10Z",
  "updated": "2025-01-15T12:39:10Z"
}
```

```json
{
  "created": "2025-10-21T09:14:48.966Z",
  "updated": "2025-10-21T09:14:48.966Z",
  "channel_properties": {
    "display_name": "xenCommerce Shop",
    "expires_at": "2025-10-23T09:14:48.966Z"
  },
  "business_id": "6577c85379425b82e415c673",
  "reference_id": "rpc_vn_123456",
  "payment_request_id": "pr-73762759-0c9b-8178-b48f-0480d694b643",
  "type": "REUSABLE_PAYMENT_CODE",
  "country": "VN",
  "currency": "VND",
  "request_amount": "10000",
  "capture_method": "AUTOMATIC",
  "channel_code": "VIETCAPITAL_VIRTUAL_ACCOUNT",
  "actions": [
    {
      "type": "PRESENT_TO_CUSTOMER",
      "descriptor": "VIRTUAL_ACCOUNT_NUMBER",
      "value": "8881761038089006"
    },
    {
      "type": "PRESENT_TO_CUSTOMER",
      "descriptor": "QR_STRING",
      "value": "00020101021238600010A00000072701300006970454011688817610380890060208QRIBFTTA53037045802VN5405100006304C696"
    }
  ],
  "status": "REQUIRES_ACTION"
}
```

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

### Payment Request Response Examples

Source: https://docs.xendit.co/apidocs/create-payment-request

JSON response structures for different payment request types. Use these to understand the expected schema for PAY, PAY_AND_SAVE, and tokenized payment requests.

```json
"reference_id": "booking_123458",
                      "payment_request_id": "pr-90392f42-d98a-49ef-a7f3-abcezas125",
                      "type": "PAY",
                      "country": "ID",
                      "currency": "IDR",
                      "request_amount": "250000",
                      "capture_method": "MANUAL",
                      "channel_code": "CARDS",
                      "channel_properties": {
                        "mid_label": "CTV_TEST",
                        "card_details": {
                          "masked_card_number": "4000****0002",
                          "cardholder_first_name": "John",
                          "cardholder_last_name": "Doe",
                          "cardholder_email": "john.doe@example.com",
                          "cardholder_phone_number": "+6212345678902",
                          "expiry_month": "03",
                          "expiry_year": "2027",
                          "fingerprint": "62397498595752001b9fdebd",
                          "type": "CREDIT",
                          "network": "VISA",
                          "country": "ID",
                          "issuer": "PT BANK BNI"
                        },
                        "skip_three_ds": "false",
                        "failure_return_url": "https://xendit.co/failure",
                        "success_return_url": "https://xendit.co/success"
                      },
                      "actions": [],
                      "status": "AUTHORIZED",
                      "description": "Hotel booking pre-authorization #123458",
                      "metadata": {
                        "booking_id": "123458",
                        "booking_type": "hotel"
                      },
                      "created": "2025-01-15T12:32:10Z",
                      "updated": "2025-01-15T12:32:12Z"
                    }
                  },
                  "PAY_AND_SAVE_Cards": {
                    "value": {
                      "business_id": "5f27a14a9bf05c73dd040bc8",
                      "reference_id": "order_123459_save",
                      "payment_request_id": "pr-90392f42-d98a-49ef-a7f3-abcezas126",
                      "customer_id": "cust-90392f42-d98a-49ef-a7f3-abcezas789",
                      "type": "PAY_AND_SAVE",
                      "country": "ID",
                      "currency": "IDR",
                      "request_amount": "500000",
                      "capture_method": "AUTOMATIC",
                      "channel_code": "CARDS",
                      "channel_properties": {
                        "mid_label": "CTV_TEST",
                        "card_details": {
                          "masked_card_number": "4000****1109",
                          "cardholder_first_name": "John",
                          "cardholder_last_name": "Doe",
                          "cardholder_email": "john.doe@example.com",
                          "cardholder_phone_number": "+6212345678901",
                          "expiry_month": "11",
                          "expiry_year": "2026",
                          "fingerprint": "62397498595752001b9fdebe",
                          "type": "CREDIT",
                          "network": "VISA",
                          "country": "ID",
                          "issuer": "PT BANK MANDIRI"
                        },
                        "skip_three_ds": "false",
                        "failure_return_url": "https://xendit.co/failure",
                        "success_return_url": "https://xendit.co/success"
                      },
                      "actions": [
                        {
                          "type": "REDIRECT_CUSTOMER",
                          "value": "https://redirect.partner.com/3ds-auth-abc",
                          "descriptor": "WEB_URL"
                        }
                      ],
                      "status": "REQUIRES_ACTION",
                      "description": "Initial subscription payment - Premium Plan",
                      "metadata": {
                        "order_id": "123459",
                        "subscription_plan": "premium_monthly"
                      },
                      "created": "2025-01-15T12:33:15Z",
                      "updated": "2025-01-15T12:33:15Z"
                    }
                  },
                  "PAY_WithToken_Cards": {
                    "value": {
                      "business_id": "5f27a14a9bf05c73dd040bc8",
                      "reference_id": "recurring_payment_123460",
                      "payment_token_id": "pt-90392f42-d98a-49ef-a7f3-abcezas123",
                      "payment_request_id": "pr-90392f42-d98a-49ef-a7f3-abcezas127",
                      "type": "PAY",
                      "country": "ID",
                      "currency": "IDR",
                      "request_amount": "500000",
                      "capture_method": "AUTOMATIC"
```

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

### OpenAPI Specification for Create Payment Request

Source: https://docs.xendit.co/apidocs/create-payment-request

The OpenAPI definition for the POST /v3/payment_requests endpoint, including request body examples for card payments with and without 3DS.

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Payments",
    "version": "3.0.0",
    "description": "Payments API enables businesses to integrate seamless and secure payment processing into their platforms, 
supporting key features like a customizable checkout page for user-friendly payment experiences, 
direct payments through API for tailored and flexible transaction flows, 
and recurring subscriptions to automate billing for memberships or SaaS. 
These APIs streamline payment processing by supporting multiple payment channels, 
ensuring PCI compliance, and offering features like tokenization, real-time transactions, 
and automated retries for subscription payments, making them essential for modern, scalable businesses.
"
  },
  "servers": [
    {
      "url": "https://api.xendit.co",
      "description": "Xendit API"
    }
  ],
  "tags": [
    {
      "name": "Payment Request",
      "x-displayName": "Payment Request"
    },
    {
      "name": "Refund",
      "x-displayName": "Refund"
    },
    {
      "name": "Payment",
      "x-displayName": "Payment"
    },
    {
      "name": "Payment Token",
      "x-displayName": "Payment Token"
    },
    {
      "name": "Subscriptions",
      "description": "Manage recurring plans and cycles",
      "x-displayName": "Subscriptions"
    },
    {
      "name": "Session",
      "x-displayName": "Session"
    }
  ],
  "paths": {
    "/v3/payment_requests": {
      "post": {
        "security": [
          {
            "Payments_API_BasicAuth": []
          }
        ],
        "operationId": "CreatePaymentRequest",
        "summary": "Create a payment request",
        "description": "Create payment request. Initiates payment collection from end user.
",
        "tags": [
          "Payment Request"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Payments_API_APIVersionHeaderExternal"
          },
          {
            "$ref": "#/components/parameters/Payments_API_ForUserIdHeaderParam"
          },
          {
            "$ref": "#/components/parameters/Payments_API_WithSplitRuleHeaderParam"
          }
        ],
        "requestBody": {
          "required": "true",
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/Payments_API_Pay"
                  },
                  {
                    "$ref": "#/components/schemas/Payments_API_PayAndSave"
                  },
                  {
                    "$ref": "#/components/schemas/Payments_API_PayWithToken"
                  },
                  {
                    "$ref": "#/components/schemas/Payments_API_ReusablePaymentCode"
                  }
                ]
              },
              "examples": {
                "PAY_Cards_3DS_Auth": {
                  "value": {
                    "reference_id": "order_123456_3ds",
                    "type": "PAY",
                    "country": "ID",
                    "currency": "IDR",
                    "request_amount": "100000",
                    "capture_method": "AUTOMATIC",
                    "channel_code": "CARDS",
                    "channel_properties": {
                      "mid_label": "CTV_TEST",
                      "card_details": {
                        "cvn": "123",
                        "card_number": "4000000000001091",
                        "expiry_year": "2025",
                        "expiry_month": "12",
                        "cardholder_first_name": "John",
                        "cardholder_last_name": "Doe",
                        "cardholder_email": "john.doe@example.com",
                        "cardholder_phone_number": "+628123456789"
                      },
                      "skip_three_ds": "false",
                      "failure_return_url": "https://xendit.co/failure",
                      "success_return_url": "https://xendit.co/success"
                    },
                    "description": "Payment for Order #123456",
                    "metadata": {
                      "order_id": "123456",
                      "customer_type": "premium"
                    }
                  }
                },
                "PAY_Cards_No_3DS": {
                  "value": {
                    "reference_id": "order_123457_no3ds",
                    "type": "PAY",
                    "country": "ID",
                    "currency": "IDR",
                    "request_amount": "50000",
                    "capture_method": "AUTOMATIC",
                    "channel_code": "CARDS",

```

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

### Payment Request API Response Examples

Source: https://docs.xendit.co/apidocs/create-payment-request

JSON response structures for various card payment request scenarios. Use these to understand the expected fields for 3DS and non-3DS transactions.

```json
{
  "business_id": "5f27a14a9bf05c73dd040bc8",
  "reference_id": "order_123456_3ds",
  "payment_request_id": "pr-90392f42-d98a-49ef-a7f3-abcezas123",
  "type": "PAY",
  "country": "ID",
  "currency": "IDR",
  "request_amount": "100000",
  "capture_method": "AUTOMATIC",
  "channel_code": "CARDS",
  "channel_properties": {
    "mid_label": "CTV_TEST",
    "card_details": {
      "masked_card_number": "4000****1091",
      "cardholder_first_name": "John",
      "cardholder_last_name": "Doe",
      "cardholder_email": "john.doe@example.com",
      "cardholder_phone_number": "+628123456789",
      "expiry_month": "12",
      "expiry_year": "2025",
      "fingerprint": "62397498595752001b9fdeba",
      "type": "DEBIT",
      "network": "VISA",
      "country": "ID",
      "issuer": "PT BANK MANDIRI"
    },
    "skip_three_ds": "false",
    "failure_return_url": "https://xendit.co/failure",
    "success_return_url": "https://xendit.co/success"
  },
  "actions": [
    {
      "type": "REDIRECT_CUSTOMER",
      "value": "https://redirect.partner.com/3ds-auth-xyz",
      "descriptor": "WEB_URL"
    }
  ],
  "status": "REQUIRES_ACTION",
  "description": "Payment for Order #123456",
  "metadata": {
    "order_id": "123456",
    "customer_type": "premium"
  },
  "created": "2025-01-15T12:30:45Z",
  "updated": "2025-01-15T12:30:45Z"
}
```

```json
{
  "business_id": "5f27a14a9bf05c73dd040bc8",
  "reference_id": "order_123457_no3ds",
  "payment_request_id": "pr-90392f42-d98a-49ef-a7f3-abcezas124",
  "type": "PAY",
  "country": "ID",
  "currency": "IDR",
  "request_amount": "50000",
  "capture_method": "AUTOMATIC",
  "channel_code": "CARDS",
  "channel_properties": {
    "mid_label": "CTV_TEST",
    "card_details": {
      "masked_card_number": "5200****1096",
      "cardholder_first_name": "Jane",
      "cardholder_last_name": "Doe",
      "cardholder_email": "jane.doe@example.com",
      "cardholder_phone_number": "+6312345678901",
      "expiry_month": "06",
      "expiry_year": "2026",
      "fingerprint": "62397498595752001b9fdebc",
      "type": "CREDIT",
      "network": "MASTERCARD",
      "country": "ID",
      "issuer": "PT BANK BCA"
    },
    "skip_three_ds": "true",
    "failure_return_url": "https://xendit.co/failure",
    "success_return_url": "https://xendit.co/success"
  },
  "actions": [],
  "status": "SUCCEEDED",
  "description": "Quick checkout for Order #123457",
  "metadata": {
    "order_id": "123457",
    "checkout_type": "express"
  },
  "created": "2025-01-15T12:31:22Z",
  "updated": "2025-01-15T12:31:25Z"
}
```

```json
{
  "business_id": "5f27a14a9bf05c73dd040bc8",
  "reference_id": "order_123457_no3ds",
  "payment_request_id": "pr-90392f42-d98a-49ef-a7f3-abcezas124",
  "type": "PAY",
  "country": "ID",
  "currency": "IDR",
  "request_amount": "50000",
  "capture_method": "AUTOMATIC",
  "channel_code": "CARDS",
  "channel_properties": {
    "mid_label": "CTV_TEST",
    "card_details": {
      "masked_card_number": "5200****1096",
      "cardholder_first_name": "Jane",
      "cardholder_last_name": "Doe",
      "cardholder_email": "jane.doe@example.com",
      "cardholder_phone_number": "+6312345678901",
      "expiry_month": "06",
      "expiry_year": "2026",
      "fingerprint": "62397498595752001b9fdebc",
      "type": "CREDIT",
      "network": "MASTERCARD",
      "country": "ID",
      "issuer": "PT BANK BCA"
    },
    "skip_three_ds": "true",
    "failure_return_url": "https://xendit.co/failure",
    "success_return_url": "https://xendit.co/success"
  },
  "actions": [],
  "status": "SUCCEEDED",
  "description": "Quick checkout for Order #123457",
  "metadata": {
    "order_id": "123457",
    "checkout_type": "express"
  },
  "created": "2025-01-15T12:31:22Z",
  "updated": "2025-01-15T12:31:25Z"
}
```

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

### Get Payment Token OpenAPI Specification

Source: https://docs.xendit.co/apidocs/get-payment-token

The OpenAPI definition for the GET /v3/payment_tokens/{payment_token_id} endpoint, including example response schemas for different payment channels.

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Payments",
    "version": "3.0.0",
    "description": "Payments API enables businesses to integrate seamless and secure payment processing into their platforms, \nsupporting key features like a customizable checkout page for user-friendly payment experiences, \ndirect payments through API for tailored and flexible transaction flows, \nand recurring subscriptions to automate billing for memberships or SaaS. \nThese APIs streamline payment processing by supporting multiple payment channels, \nensuring PCI compliance, and offering features like tokenization, real-time transactions, \nand automated retries for subscription payments, making them essential for modern, scalable businesses.\n"
  },
  "servers": [
    {
      "url": "https://api.xendit.co",
      "description": "Xendit API"
    }
  ],
  "tags": [
    {
      "name": "Payment Request",
      "x-displayName": "Payment Request"
    },
    {
      "name": "Refund",
      "x-displayName": "Refund"
    },
    {
      "name": "Payment",
      "x-displayName": "Payment"
    },
    {
      "name": "Payment Token",
      "x-displayName": "Payment Token"
    },
    {
      "name": "Subscriptions",
      "description": "Manage recurring plans and cycles",
      "x-displayName": "Subscriptions"
    },
    {
      "name": "Session",
      "x-displayName": "Session"
    }
  ],
  "paths": {
    "/v3/payment_tokens/{payment_token_id}": {
      "get": {
        "security": [
          {
            "Payments_API_BasicAuth": []
          }
        ],
        "operationId": "GetPaymentToken",
        "summary": "Get the status of a payment token",
        "description": "Retrieve the status of your payment token.\n",
        "tags": [
          "Payment Token"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Payments_API_APIVersionHeaderExternal"
          },
          {
            "$ref": "#/components/parameters/Payments_API_PaymentTokenIdPathParam"
          }
        ],
        "responses": {
          "200": {
            "description": "Fetch Payment Token Status",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Payments_API_PaymentTokenSchema"
                },
                "examples": {
                  "Get_Payment_Token_Ewallet": {
                    "value": {
                      "payment_token_id": "pt-90392f42-d98a-49ef-a7f3-abcezas123",
                      "business_id": "5f27a14a9bf05c73dd040bc8",
                      "reference_id": "tokenize_ovo_user789",
                      "customer_id": "cust-b98d6f63-d240-44ec-9bd5-aa42954c4f48",
                      "country": "ID",
                      "currency": "IDR",
                      "channel_code": "OVO",
                      "channel_properties": {
                        "failure_return_url": "https://xendit.co/failure",
                        "success_return_url": "https://xendit.co/success"
                      },
                      "status": "ACTIVE",
                      "token_details": {
                        "account_name": "John Doe",
                        "account_balance": "1000001",
                        "account_point_balance": "50000"
                      },
                      "description": "Save OVO account for future payments",
                      "metadata": {
                        "customer_id": "CUST789",
                        "wallet_usage": "recurring"
                      },
                      "created": "2021-12-31T23:59:59Z",
                      "updated": "2021-12-31T23:59:59Z"
                    }
                  },
                  "Get_Payment_Token_Cards": {
                    "value": {
                      "payment_token_id": "pt-1402feb0-bb79-47ae-9d1e-e69394d3949c",
                      "business_id": "5f27a14a9bf05c73dd040bc8",
                      "reference_id": "tokenize_card_user456",
                      "customer_id": "cust-b98d6f63-d240-44ec-9bd5-aa42954c4f48",
                      "country": "ID",
                      "currency": "IDR",
                      "channel_code": "CARDS",
                      "channel_properties": {
                        "card_details": {
                          "type": "CREDIT",
                          "issuer": "PT BANK MANDIRI",
                          "country": "ID",
                          "network": "VISA",
                          "fingerprint": "61f632879e9e27001a8165b9",
                          "masked_card_number": "5200****1005"
```

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

### Create Account - Minimal Request (ID, Defaults)

Source: https://docs.xendit.co/apidocs/create-account-v3

Example of a minimal request to create a sub-account for an individual in Indonesia. The configuration block is optional and defaults are used.

```json
{
  "name": "Toko Berkah",
  "email": "owner@tokoberkah.co.id",
  "identity": {
    "country_of_incorporation": "ID",
    "entity_type": "INDIVIDUAL"
  }
}
```

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

### OpenAPI Specification for Get Payout by ID

Source: https://docs.xendit.co/apidocs/get-payout-v3-by-id

The OpenAPI definition for the GET /v3/payouts/{payout_id} endpoint, including request parameters and example response payloads for both successful and failed payouts.

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Payouts",
    "version": "3.0.0",
    "description": "Payouts enables businesses to send funds to anyone, anywhere in the world faster through a single seamless and highly-customizable API."
  },
  "servers": [
    {
      "url": "https://api.xendit.co",
      "description": "Xendit API",
      "variables": {}
    }
  ],
  "security": [
    {
      "SecretApiKeyAuth": []
    }
  ],
  "tags": [
    {
      "name": "Payout"
    }
  ],
  "paths": {
    "/v3/payouts/{payout_id}": {
      "get": {
        "operationId": "Payouts_read",
        "summary": "Get Payout by ID",
        "description": "Retrieve a specific created Payout with a given ID",
        "parameters": [
          {
            "name": "api-version",
            "in": "header",
            "required": "false",
            "description": "The version of the API. Value: \"2025-09-01\"",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "payout_id",
            "in": "path",
            "required": "true",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Payout"
                },
                "examples": {
                  "Get Failed Payout": {
                    "summary": "Get Failed Payout",
                    "value": {
                      "payout_id": "po-b2c3d4e5-f6a7-8901-bcde-f23456789012",
                      "status": "FAILED",
                      "reference_id": "payout-ref-002",
                      "type": "B2C",
                      "source_currency": "PHP",
                      "source_amount": "50000",
                      "destination_currency": "PHP",
                      "destination_amount": "50000",
                      "sender": {
                        "type": "BUSINESS",
                        "business_name": "Acme Corp"
                      },
                      "recipient": {
                        "type": "INDIVIDUAL",
                        "given_name": "Maria",
                        "surname": "Santos",
                        "relationship": "CUSTOMER",
                        "details": {
                          "personal_mobile_number": "+639171234567"
                        },
                        "address": {
                          "country": "PH",
                          "street_line_1": "123 Rizal Avenue",
                          "city": "Manila",
                          "province_state": "Metro Manila",
                          "postal_code": "1000"
                        },
                        "account_details": {
                          "currency": "PHP",
                          "account_country": "PH",
                          "account_holder_name": "Maria Santos",
                          "account_number": "09171234567",
                          "routing_type_1": "WALLET",
                          "routing_value_1": "PH_GCASH"
                        }
                      },
                      "source_of_fund": "BUSINESS_REVENUE",
                      "purpose_code": "SALARY",
                      "description": "Freelancer payment",
                      "failure_code": "INVALID_DESTINATION",
                      "created": "2025-06-11T08:00:00Z",
                      "updated": "2025-06-11T08:01:30Z",
                      "business_id": "6018306aa16ad90cb3c43ba7"
                    }
                  },
                  "Get Payout by ID": {
                    "summary": "Get Payout by ID",
                    "value": {
                      "payout_id": "po-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
                      "status": "SUCCEEDED",
                      "reference_id": "payout-ref-001",
                      "type": "B2C",
                      "source_currency": "IDR",
                      "source_amount": "1000000",
                      "destination_currency": "USD",
                      "destination_amount": "63",
                      "sender": {
                        "type": "BUSINESS",
                        "business_name": "Acme Corp"
                      },
                      "recipient": {
                        "type": "INDIVIDUAL",
                        "given_name": "John",
                        "surname": "Doe",
                        "relationship": "CUSTOMER",
                        "account_details": {

```
Tokens:
Raw