Capability API

The Capability API allows you to retrieve information about a given account's capabilities. This includes banks that can be used when adding bank accounts for transfer recipients, account-specific limits on charges and transfers, as well as available payment methods.

Attributes

Name	Type	Description
object	string	The string `capability`.
location	string	API path to retrieve the current `capability` object.
banks	array	Banks supported for transfer recipients.
payment_methods	array	Available payment methods and allowed values.
zero_interest_installments	boolean	Whether merchant absorbs interest for installment payments.

Example

JSON Response

{
  "object": "capability",
  "location": "/capability",
  "banks": [
    "test",
    "bbl",
    "kbank",
    "rbs",
    "ktb",
    "jpm",
    "mufg",
    "tmb",
    "scb",
    "citi",
    "smbc",
    "sc",
    "cimb",
    "uob",
    "bay",
    "mega",
    "boa",
    "cacib",
    "gsb",
    "hsbc",
    "db",
    "ghb",
    "baac",
    "mb",
    "bnp",
    "tbank",
    "ibank",
    "tisco",
    "kk",
    "icbc",
    "tcrb",
    "lhb"
  ],
  "payment_methods": [
    {
      "object": "payment_method",
      "name": "card",
      "currencies": [
        "THB",
        "JPY",
        "USD",
        "EUR",
        "GBP",
        "SGD"
      ],
      "card_brands": [
        "JCB",
        "Visa",
        "MasterCard"
      ],
      "installment_terms": null
    },
    {
      "object": "payment_method",
      "name": "installment_bay",
      "currencies": [
        "THB"
      ],
      "card_brands": null,
      "installment_terms": [
        3,
        4,
        6,
        9,
        10
      ]
    },
    {
      "object": "payment_method",
      "name": "installment_first_choice",
      "currencies": [
        "THB"
      ],
      "card_brands": null,
      "installment_terms": [
        3,
        4,
        6,
        9,
        10,
        12,
        18,
        24,
        36
      ]
    },
    {
      "object": "payment_method",
      "name": "installment_kbank",
      "currencies": [
        "THB"
      ],
      "card_brands": null,
      "installment_terms": [
        3,
        4,
        6,
        10
      ]
    },
    {
      "object": "payment_method",
      "name": "installment_bbl",
      "currencies": [
        "THB"
      ],
      "card_brands": null,
      "installment_terms": [
        4,
        6,
        8,
        9,
        10
      ]
    },
    {
      "object": "payment_method",
      "name": "installment_ktc",
      "currencies": [
        "THB"
      ],
      "card_brands": null,
      "installment_terms": [
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10
      ]
    }
  ],
  "zero_interest_installments": true
}

Retrieve account capabilities

- GET https://api.omise.co/capability

Returns information about the account "capabilities". Note: this verb accepts public key authentication only.

Example

Retrieve the account capability

curl
ruby
python
php
C#
node.js
java
go
elixir

curl https://api.omise.co/capability \
  -u $OMISE_PUBLIC_KEY:

Request<Capability> request = new Capability.GetRequestBuilder().build();
Capability capability = client().sendRequest(request);

System.out.printf("isZeroInterestInstallments: %b", capability.isZeroInterestInstallments());