Capability API

Retrieve information about a given account's capabilities. This includes banks that can be used when adding bank accounts for transfer recipients as well as available payment methods.

To test White-Label Installment source types while in test mode, please contact our support team to enable this feature.

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.
limits	object	Defines the min/max charge amount as well as the installment amount that merchants can process.
payment_backends	array	Available payment methods and allowed values.
tokenization_methods	array	Lists the methods of card tokenization. The methods at present are: `googlepay` - card tokenized by GooglePay `null` - tokenized by Opn
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"
  ],
  "zero_interest_installments": true,
  "limits": {
    "charge_amount": {
      "max": 100000000,
      "min": 2000
    },
    "transfer_amount": {
      "max": 5000000000,
      "min": 3000
    }
  },
  "payment_backends": [
    {
      "credit_card": {
        "type": "card",
        "currencies": [
          "thb",
          "jpy",
          "usd",
          "eur",
          "gbp",
          "sgd",
          "aud",
          "chf",
          "cny",
          "dkk",
          "hkd"
        ],
        "brands": [
          "JCB",
          "Visa",
          "MasterCard"
        ]
      }
    },
    {
      "installment_bay": {
        "type": "installment",
        "currencies": [
          "thb"
        ],
        "allowed_installment_terms": [
          3,
          4,
          6,
          9,
          10
        ],
        "amount": {
          "min": 2000,
          "max": 100000000
        }
      }
    },
    {
      "installment_first_choice": {
        "type": "installment",
        "currencies": [
          "thb"
        ],
        "allowed_installment_terms": [
          3,
          4,
          6,
          9,
          10,
          12,
          18,
          24,
          36
        ],
        "amount": {
          "min": 2000,
          "max": 100000000
        }
      }
    },
    {
      "installment_kbank": {
        "type": "installment",
        "currencies": [
          "thb"
        ],
        "allowed_installment_terms": [
          3,
          4,
          6,
          10
        ],
        "amount": {
          "min": 2000,
          "max": 100000000
        }
      }
    },
    {
      "installment_bbl": {
        "type": "installment",
        "currencies": [
          "thb"
        ],
        "allowed_installment_terms": [
          4,
          6,
          8,
          9,
          10
        ],
        "amount": {
          "min": 2000,
          "max": 100000000
        }
      }
    },
    {
      "installment_ktc": {
        "type": "installment",
        "currencies": [
          "thb"
        ],
        "allowed_installment_terms": [
          3,
          4,
          5,
          6,
          7,
          8,
          9,
          10
        ],
        "amount": {
          "min": 2000,
          "max": 100000000
        }
      }
    }
  ]
}

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
node.js
go

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

const omise = require('omise')({
  publicKey: 'pkey_test_no1t4tnemucod0e51mo',
});

const capability = await omise.capability.retrieve();
console.log(capability);

client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.Capability{}
err := client.Do(result, &operations.RetrieveCapability{})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)