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. Note: this endpoint accepts public key authentication.

Attribute

Name	Type	Description
object	string	The string `capability`.
location	string	API path to retrieve the current `capability` object.
banks	Array	Bank account brand codes that can be used for recipient bank accounts. See supported banks for full names.
limits	Object	Maximum and minimum charge and transfer limits.
payment_backends	Array	Available payment backends and details.

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"
  ],
  "limits": {
    "charge_amount": {
      "max": 100000000,
      "min": 2000
    },
    "transfer_amount": {
      "max": 3000,
      "min": 3000
    }
  },
  "payment_backends": [
    {
      "credit_card": {
        "type": "card",
        "currencies": [
          "THB",
          "JPY",
          "USD",
          "EUR",
          "GBP",
          "SGD"
        ],
        "brands": [

        ]
      }
    },
    {
      "installment_bbl": {
        "type": "installment",
        "currencies": [
          "THB"
        ],
        "allowed_installment_terms": [
          4,
          6,
          10
        ],
        "amount": {
          "min": 2000,
          "max": 100000000
        }
      }
    },
    {
      "installment_first_choice": {
        "type": "installment",
        "currencies": [
          "THB"
        ],
        "allowed_installment_terms": [
          3,
          4,
          6,
          10,
          12,
          18,
          24
        ],
        "amount": {
          "min": 2000,
          "max": 100000000
        }
      }
    },
    {
      "installment_bay": {
        "type": "installment",
        "currencies": [
          "THB"
        ],
        "allowed_installment_terms": [
          4,
          6,
          10
        ],
        "amount": {
          "min": 2000,
          "max": 100000000
        }
      }
    },
    {
      "installment_kbank": {
        "type": "installment",
        "currencies": [
          "THB"
        ],
        "allowed_installment_terms": [
          4,
          6,
          10
        ],
        "amount": {
          "min": 2000,
          "max": 100000000
        }
      }
    },
    {
      "installment_ktc": {
        "type": "installment",
        "currencies": [
          "THB"
        ],
        "allowed_installment_terms": [
          4,
          6,
          10
        ],
        "amount": {
          "min": 2000,
          "max": 100000000
        }
      }
    }
  ]
}

Retrieve account capabilities

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

Returns the capability object of the current account.

Example

Retrieve account capabilities

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

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