# Billing Account API - Get Payment Capacity

## 1. API Overview

### Purpose

[context]
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.).<br>
This pre-transaction lookup is executed before rendering the payment checkout page, allowing merchants to dynamically display payment methods and populate required parameters.
[/context]

### Details

[table:key-value]
| Item | Value |
| :-------------- | :-------------------------- |
| **API Name**    | Get Payment Capacity |
| **API Path**    | /api/v2/payments/capacity |
| **API ID**      | EBP_API_240 |
| **HTTP Method** | [badge:GET,blue,lg]        |
| **Region** | [badge:Global,green-subtle,lg] |
[/table]

## 2. Request Specification

### 2.1 Request Header

@@include:common-headers-link.md@@

### 2.2 Request Data Schema (Query Parameter)

| Field | Details & Description |
| :--- | :--- |
| paymentMethod | [type:string] [req:Optional] [desc:Filter specific payment method. If omitted, returns all mapped payment methods for the merchant.] [eg:INSTALLMENT] |

---

## 3. Response Specification

### 3.1 Response Data Schema

@@include:standard-response.md@@
| -1 | data | [type:object] [req:Yes] [desc:Response payload] |
| 0 | paymentMethods | [type:array] [req:Yes] [desc:List of available payment methods] |
| 1 | paymentMethod | [type:string] [req:Yes] [desc:EBP standard payment method code] [eg:CARD, INSTALLMENT] |
| 1 | pgProviders | [type:array] [req:Yes] [desc:List of PGs supporting the payment method] |
| 2 | pgProvider | [type:string] [req:Yes] [desc:Unique PG Provider code] [eg:WORLDPAY_AWP, OMISE, CHECKOUTCOM] |
| 2 | displayName | [type:string] [req:Yes] [desc:Display name of the PG Provider] |
| 2 | specifications | [type:object] [req:Yes] [desc: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 | [type:number] [req:Yes] [desc:Minimum overall order amount to apply for installment plans (Unit: Subunit of the currency, e.g., 2000.00 THB -> 200000)] |
| 0     | installmentSources | [type:array] [req:Yes] [desc:List of participating installment sources and conditions] |
| 1     | installmentSource | [type:string] [req:Yes] [desc:Unique identifier code for the installment source] [eg:installment_bay, installment_kbank] |
| 1     | installmentTerm | [type:array] [req:Yes] [desc:Supported monthly installment terms] [eg:&#91;3, 4, 6, 10&#93;] |
| 1     | currencies | [type:array] [req:Yes] [desc:List of supported transactional currencies for the source] [eg:&#91;"THB"&#93;] |

---

## 3.2 Response Samples

#### Success Response

[tabs]
[tab: Credit Card]

```json
{
  "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"
          }
        ]
      }
    ]
  }
}
```

[tab:Installments & Others (Thailand Omise)]

```json
{
  "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
          }
        ]
      }
    ]
  }
}
```

[/tabs]