For archived content, access the previous documentation here or the previous API reference here.

Get payout channels

Prev Next
Get
/payouts_channels

This API endpoint will provide you the current list of banks and E-Wallets we support for payouts

Security
HTTP
Type basic
Query parameters
currency
string
currency
string
Valid values[ "BANK", "EWALLET", "OTC" ]
currency
string
ExampleID_BCA
Responses
200

'Returns array of Payout Channel objects sorted by alphabetical order by channel_code with HTTP status code 200. Return empty array when not found.

If query parameters are defined, returns a filtered list of Payout Channel objects matching the query parameter.

getPaymentChannelsResponseExample
[
  {
    "channel_code": "ID_BSI",
    "channel_category": "BANK",
    "currency": "IDR",
    "channel_name": "Bank Syariah Indonesia",
    "amount_limits": {
      "minimum": 10000,
      "maximum": 1999999999999,
      "minimum_increment": 1
    }
  },
  {
    "channel_code": "PH_AUB",
    "channel_category": "BANK",
    "currency": "PHP",
    "channel_name": "Asia United Bank",
    "amount_limits": {
      "minimum": 1,
      "maximum": 100000000,
      "minimum_increment": 1
    }
  }
]
Array of object
object
channel_name
string

Name of payout channel

channel_category
string
Valid values[ "BANK", "EWALLET", "OTC" ]
channel_code
string

Channel code of destination bank, E-Wallet or OTC channel. List of supported channels can be found here

ExampleID_BCA
currency
string

ISO 4217 Currency Code.

amount_limits
object

Object containing amount limitations imposed by the channel.

minimum
number

Minimum amount that can be paid out to this channel

maximum
number

Maximum amount that can be paid out to this channel

minimum_increment
number

Smallest amount increment allowed by the channel

401

Unauthorized

OneOf
401InvalidAPIKeyError
object (401InvalidAPIKeyError)
error_code
string
ExampleINVALID_API_KEY
error_message
string
ExampleAPI key format is invalid
404

Not Found

OneOf
404DataNotFoundError
object (404DataNotFoundError)
error_code
string
ExampleDATA_NOT_FOUND
error_message
string
ExampleCould not find payout with the corresponding ID. Please try again with a valid Id
500

Internal Server Error

OneOf
500ServerError
object (500ServerError)
error_code
string
ExampleSERVER_ERROR
error_message
string
ExampleError connecting to our server. Retry safely using Idempotency-key header when available