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.
Attributes
Name | Type | Description |
---|---|---|
object | string | The string |
location | string | API path to retrieve the current |
banks | array | Banks supported for transfer recipients. |
limits | object | Minimum and maximum charge and transfer amounts. Minimum installment amount. Stricter minimum and maximum amounts for charges may be enforced for specific payment methods. See the relevant payment method documentation for details. |
country | string | Country in which account is registered as two-letter ISO 3166 code. |
payment_methods | array | Available payment methods and allowed values. See Payment Methods for more details. |
tokenization_methods | array | Available card tokenization methods. |
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", "ttb", "scb", "citi", "smbc", "sc", "cimb", "uob", "bay", "mega", "boa", "cacib", "gsb", "hsbc", "db", "ghb", "baac", "mb", "bnp", "ibank", "tisco", "kk", "icbc", "tcrb", "lhb" ], "limits": { "charge_amount": { "max": 15000000, "min": 2000 }, "transfer_amount": { "max": 5000000000, "min": 3000 }, "installment_amount": { "min": 200000 } }, "payment_methods": [ { "object": "payment_method", "name": "card", "currencies": [ "THB", "JPY", "USD", "EUR", "GBP", "SGD", "AUD", "CHF", "CNY", "DKK", "HKD" ], "card_brands": [ "JCB", "Visa", "MasterCard" ], "installment_terms": null, "banks": [], "provider": null }, { "object": "payment_method", "name": "internet_banking_bay", "currencies": [ "THB" ], "card_brands": null, "installment_terms": null, "banks": [], "provider": null }, { "object": "payment_method", "name": "internet_banking_bbl", "currencies": [ "THB" ], "card_brands": null, "installment_terms": null, "banks": [], "provider": null }, { "object": "payment_method", "name": "alipay", "currencies": [ "THB" ], "card_brands": null, "installment_terms": null, "banks": [], "provider": null }, { "object": "payment_method", "name": "installment_bay", "currencies": [ "THB" ], "card_brands": null, "installment_terms": [ 3, 4, 6, 9, 10 ], "banks": [], "provider": null }, { "object": "payment_method", "name": "installment_kbank", "currencies": [ "THB" ], "card_brands": null, "installment_terms": [ 3, 4, 6, 10 ], "banks": [], "provider": null }, { "object": "payment_method", "name": "installment_ktc", "currencies": [ "THB" ], "card_brands": null, "installment_terms": [ 3, 4, 5, 6, 7, 8, 9, 10 ], "banks": [], "provider": null }, { "object": "payment_method", "name": "installment_bbl", "currencies": [ "THB" ], "card_brands": null, "installment_terms": [ 4, 6, 8, 9, 10 ], "banks": [], "provider": null }, { "object": "payment_method", "name": "installment_first_choice", "currencies": [ "THB" ], "card_brands": null, "installment_terms": [ 3, 4, 6, 9, 10, 12, 18, 24, 36 ], "banks": [], "provider": null }, { "object": "payment_method", "name": "bill_payment_tesco_lotus", "currencies": [ "THB" ], "card_brands": null, "installment_terms": null, "banks": [], "provider": null }, { "object": "payment_method", "name": "barcode_alipay", "currencies": [ "THB" ], "card_brands": null, "installment_terms": null, "banks": [], "provider": null }, { "object": "payment_method", "name": "grabpay", "currencies": [ "THB", "MYR", "SGD" ], "card_brands": null, "installment_terms": null, "banks": [], "provider": null }, { "object": "payment_method", "name": "shopeepay_jumpapp", "currencies": [ "SGD", "MYR", "THB" ], "card_brands": null, "installment_terms": null, "banks": [], "provider": null }, { "object": "payment_method", "name": "shopeepay", "currencies": [ "SGD", "MYR", "THB" ], "card_brands": null, "installment_terms": null, "banks": [], "provider": null }, { "object": "payment_method", "name": "installment_scb", "currencies": [ "THB" ], "card_brands": null, "installment_terms": [ 3, 4, 6, 9, 10 ], "banks": [], "provider": null }, { "object": "payment_method", "name": "installment_ttb", "currencies": [ "THB" ], "card_brands": null, "installment_terms": [ 3, 4, 6, 10 ], "banks": [], "provider": null }, { "object": "payment_method", "name": "installment_uob", "currencies": [ "THB" ], "card_brands": null, "installment_terms": [ 3, 4, 6, 10 ], "banks": [], "provider": null }, { "object": "payment_method", "name": "mobile_banking_kbank", "currencies": [ "THB" ], "card_brands": null, "installment_terms": null, "banks": [], "provider": null }, { "object": "payment_method", "name": "mobile_banking_bay", "currencies": [ "THB" ], "card_brands": null, "installment_terms": null, "banks": [], "provider": null }, { "object": "payment_method", "name": "mobile_banking_scb", "currencies": [ "THB" ], "card_brands": null, "installment_terms": null, "banks": [], "provider": null }, { "object": "payment_method", "name": "mobile_banking_bbl", "currencies": [ "THB" ], "card_brands": null, "installment_terms": null, "banks": [], "provider": null }, { "object": "payment_method", "name": "mobile_banking_ktb", "currencies": [ "THB" ], "card_brands": null, "installment_terms": null, "banks": [], "provider": null }, { "object": "payment_method", "name": "points_citi", "currencies": [ "THB" ], "card_brands": null, "installment_terms": null, "banks": [], "provider": null }, { "object": "payment_method", "name": "promptpay", "currencies": [ "THB" ], "card_brands": null, "installment_terms": null, "banks": [], "provider": null }, { "object": "payment_method", "name": "rabbit_linepay", "currencies": [ "THB" ], "card_brands": null, "installment_terms": null, "banks": [], "provider": null }, { "object": "payment_method", "name": "truemoney", "currencies": [ "THB" ], "card_brands": null, "installment_terms": null, "banks": [], "provider": null }, { "object": "payment_method", "name": "atome", "currencies": [ "THB", "JPY", "SGD", "MYR" ], "card_brands": null, "installment_terms": null, "banks": [], "provider": null }, { "object": "payment_method", "name": "atome_qr", "currencies": [ "THB", "JPY", "SGD", "MYR" ], "card_brands": null, "installment_terms": null, "banks": [], "provider": null } ], "country": "TH", "tokenization_methods": [ "googlepay" ], "zero_interest_installments": true }
Retrieve account capabilities
- GET https://api.omise.co/capabilityReturns information about the account capabilities
. Note: this verb accepts public key authentication only.
Example
-
Retrieve the account capability
- curl
- node.js
- java
- 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);
Request<Capability> request = new Capability.GetRequestBuilder().build(); Capability capability = client().sendRequest(request); System.out.printf("isZeroInterestInstallments: %b", capability.isZeroInterestInstallments());
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)