Billing Account API - Get Payment Capacity #

1. API Overview #

Purpose #

This API retrieves the list of available payment methods, their associated PG (Payment Gateway) information, and specific payment configurations (e.g., Thailand bank installment terms) dynamically mapped to the merchant based on the provided merchant headers (Store ID, Channel Code, Country Code, etc.).
This pre-transaction lookup is executed before rendering the payment checkout page, allowing merchants to dynamically display payment methods and populate required parameters.

Details #

Item	Value
API Name	Get Payment Capacity
API Path	/api/v2/payments/capacity
API ID	EBP_API_240
HTTP Method	GET
Region	Global

2. Request Specification #

2.1 Request Header #

For detailed header information, please refer to the Common Headers documentation.

2.2 Request Data Schema (Query Parameter) #

Field Details & Description

paymentMethod

Field	Details & Description
paymentMethod	`string` ⚪ Optional Filter specific payment method. If omitted, returns all mapped payment methods for the merchant. e.g., INSTALLMENT

string

⚪ Optional

Filter specific payment method. If omitted, returns all mapped payment methods for the merchant.

e.g., INSTALLMENT

3. Response Specification #

3.1 Response Data Schema #

depth	Field	Details & Description
-1	resultCode	`string` 🔴 Required Result code e.g., "0" for success, "EBP-A-0001" for error
-1	message	`string` 🔴 Required Result message
-1	requestId	`string` 🔴 Required Unique request identifier for tracking
-1	timestamp	`string` 🔴 Required Response timestamp in ISO 8601 format e.g., 2025-12-19T14:24:00+09:00
-1	data	`object` 🔴 Required Response payload
0	paymentMethods	`array` 🔴 Required List of available payment methods
1	paymentMethod	`string` 🔴 Required EBP standard payment method code e.g., CARD, INSTALLMENT
1	pgProviders	`array` 🔴 Required List of PGs supporting the payment method
2	pgProvider	`string` 🔴 Required Unique PG Provider code e.g., WORLDPAY_AWP, OMISE, CHECKOUTCOM
2	displayName	`string` 🔴 Required Display name of the PG Provider
2	specifications	`object` 🔴 Required Dynamic metadata specific to the PG and payment method. See PG Specifications below for details.

3.1.1 PG Specifications (specifications) #

The schema inside the specifications object is dynamic and varies based on the Country, Payment Method, and the mapped PG's unique specifications.

3.1.1.1 Thailand Installment (INSTALLMENT - OMISE PG Example) #

For Thailand INSTALLMENT payments with Omise, this object returns the minimum threshold amount and detailed information about participating installment sources (banks) and supported monthly terms.

depth	Field	Details & Description
0	min	`number` 🔴 Required Minimum overall order amount to apply for installment plans (Unit: Subunit of the currency, e.g., 2000.00 THB -> 200000)
0	installmentSources	`array` 🔴 Required List of participating installment sources and conditions
1	installmentSource	`string` 🔴 Required Unique identifier code for the installment source e.g., installment_bay, installment_kbank
1	installmentTerm	`array` 🔴 Required Supported monthly installment terms e.g., [3, 4, 6, 10]
1	currencies	`array` 🔴 Required List of supported transactional currencies for the source e.g., ["THB"]

3.2 Response Samples #

Success Response #

Credit Card

Installments & Others (Thailand Omise)

{
  "resultCode": "0",
  "message": "SUCCESS",
  "requestId": "06F4W5V4F1DA47BH58VVMD95VC",
  "timestamp": "2026-05-22T05:10:16.445222700Z",
  "data": {
    "paymentMethods": [
      {
        "paymentMethod": "OPEN_BANKING",
        "pgProviders": [
          {
            "pgProvider": "WORLDPAY",
            "displayName": "Worldpay"
          }
        ]
      },
      {
        "paymentMethod": "GOOGLE_PAY",
        "pgProviders": [
          {
            "pgProvider": "WORLDPAY",
            "displayName": "Worldpay"
          }
        ]
      },
      {
        "paymentMethod": "AFTER_PAY",
        "pgProviders": [
          {
            "pgProvider": "WORLDPAY",
            "displayName": "Worldpay"
          }
        ]
      },
      {
        "paymentMethod": "CARD",
        "pgProviders": [
          {
            "pgProvider": "WORLDPAY_AWP",
            "displayName": "Worldpay Access"
          }
        ]
      },
      {
        "paymentMethod": "APPLE_PAY",
        "pgProviders": [
          {
            "pgProvider": "CHECKOUT_COM",
            "displayName": "Checkout.com"
          }
        ]
      }
    ]
  }
}

{
  "resultCode": "0",
  "message": "SUCCESS",
  "requestId": "06F4W0040755WD29TBYFE8VWNR",
  "timestamp": "2026-05-22T04:44:45.010Z",
  "data": {
    "paymentMethods": [
      {
        "paymentMethod": "INSTALLMENT",
        "pgProviders": [
          {
            "pgProvider": "OMISE",
            "displayName": "Omise",
            "specifications": {
              "min": 200000,
              "installmentSources": [
                {
                  "installmentSource": "installment_bay",
                  "installmentTerm": [3, 4, 6, 9, 10],
                  "currencies": ["THB"]
                }
              ]
            }
          }
        ]
      },
      {
        "paymentMethod": "DIRECT_DEBIT",
        "pgProviders": [
          {
            "pgProvider": "OMISE",
            "displayName": "Omise",
            "specifications": null
          }
        ]
      },
      {
        "paymentMethod": "CARD",
        "pgProviders": [
          {
            "pgProvider": "OMISE",
            "displayName": "Omise",
            "specifications": null
          }
        ]
      },
      {
        "paymentMethod": "BANK_TRANSFER",
        "pgProviders": [
          {
            "pgProvider": "OMISE",
            "displayName": "Omise",
            "specifications": null
          }
        ]
      }
    ]
  }
}