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 |
| location | string | API path to retrieve the current |
| 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:
|
| 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 } }, "payment_backends": [ { "credit_card": { "type": "card", "currencies": [ "thb", "jpy", "usd", "eur", "gbp", "sgd", "aud", "chf", "cny", "dkk", "hkd" ], "brands": [ "JCB", "Visa", "MasterCard" ] } }, { "internet_banking_bay": { "type": "internet_banking", "currencies": [ "thb" ], "amount": { "min": 2000, "max": 15000000 } } }, { "internet_banking_bbl": { "type": "internet_banking", "currencies": [ "thb" ], "amount": { "min": 2000, "max": 15000000 } } }, { "alipay": { "type": "alipay", "currencies": [ "thb" ], "amount": { "min": 2000, "max": 15000000 } } }, { "installment_bay": { "type": "installment", "currencies": [ "thb" ], "allowed_installment_terms": [ 3, 4, 6, 9, 10 ], "amount": { "min": 2000, "max": 15000000 } } }, { "installment_kbank": { "type": "installment", "currencies": [ "thb" ], "allowed_installment_terms": [ 3, 4, 6, 10 ], "amount": { "min": 2000, "max": 15000000 } } }, { "installment_ktc": { "type": "installment", "currencies": [ "thb" ], "allowed_installment_terms": [ 3, 4, 5, 6, 7, 8, 9, 10 ], "amount": { "min": 2000, "max": 15000000 } } }, { "installment_bbl": { "type": "installment", "currencies": [ "thb" ], "allowed_installment_terms": [ 4, 6, 8, 9, 10 ], "amount": { "min": 2000, "max": 15000000 } } }, { "installment_first_choice": { "type": "installment", "currencies": [ "thb" ], "allowed_installment_terms": [ 3, 4, 6, 9, 10, 12, 18, 24, 36 ], "amount": { "min": 2000, "max": 15000000 } } }, { "bill_payment_tesco_lotus": { "type": "offline", "currencies": [ "thb" ], "amount": { "min": 2000, "max": 15000000 } } }, { "barcode_alipay": { "type": "offline", "currencies": [ "thb" ], "amount": { "min": 2000, "max": 15000000 } } }, { "grabpay": { "type": "grabpay", "currencies": [ "thb", "myr", "sgd" ], "amount": { "min": 2000, "max": 15000000 } } }, { "shopeepay_jumpapp": { "type": "shopeepay_jumpapp", "currencies": [ "sgd", "myr", "thb" ], "amount": { "min": 2000, "max": 15000000 } } }, { "shopeepay": { "type": "shopeepay", "currencies": [ "sgd", "myr", "thb" ], "amount": { "min": 2000, "max": 15000000 } } }, { "installment_scb": { "type": "installment", "currencies": [ "thb" ], "allowed_installment_terms": [ 3, 4, 6, 9, 10 ], "amount": { "min": 2000, "max": 15000000 } } }, { "installment_ttb": { "type": "installment", "currencies": [ "thb" ], "allowed_installment_terms": [ 3, 4, 6, 10 ], "amount": { "min": 2000, "max": 15000000 } } }, { "installment_uob": { "type": "installment", "currencies": [ "thb" ], "allowed_installment_terms": [ 3, 4, 6, 10 ], "amount": { "min": 2000, "max": 15000000 } } }, { "mobile_banking_kbank": { "type": "mobile_banking_kbank", "currencies": [ "thb" ], "amount": { "min": 2000, "max": 15000000 } } }, { "mobile_banking_bay": { "type": "mobile_banking_bay", "currencies": [ "thb" ], "amount": { "min": 2000, "max": 15000000 } } }, { "mobile_banking_scb": { "type": "mobile_banking_scb", "currencies": [ "thb" ], "amount": { "min": 2000, "max": 15000000 } } }, { "mobile_banking_bbl": { "type": "mobile_banking_bbl", "currencies": [ "thb" ], "amount": { "min": 2000, "max": 15000000 } } }, { "mobile_banking_ktb": { "type": "mobile_banking_ktb", "currencies": [ "thb" ], "amount": { "min": 2000, "max": 15000000 } } }, { "points_citi": { "type": "points_citi", "currencies": [ "thb" ], "amount": { "min": 2000, "max": 15000000 } } }, { "promptpay": { "type": "promptpay", "currencies": [ "thb" ], "amount": { "min": 2000, "max": 15000000 } } }, { "rabbit_linepay": { "type": "rabbit_linepay", "currencies": [ "thb" ], "amount": { "min": 2000, "max": 15000000 } } }, { "truemoney": { "type": "truemoney", "currencies": [ "thb" ], "amount": { "min": 2000, "max": 15000000 } } } ], "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
- 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)
