Get All Payout Method - API Documentation

This API is used to retrieve a list of Payout-Methods available. The parameters will be SENDER and BENEFICIARY objects and other required fields to be provided for both parties. You can filter the results by specifying the currency and country query parameters.

Request

Query Params

sender_country

string

required

Example:

sender_currency

string

required

Example:

IDR

beneficiary_country

string

required

Example:

beneficiary_currency

string

required

Example:

IDR

payout_method_class

string | null

optional

DOMESTIC || GCA

Header Params

X-token

string

required

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

status

boolean

required

message

string

required

data

array [object {18}]

required

payout_method_id

string

optional

payout_method_name

string

optional

payout_method_description

string

optional

payout_method_logo

string

optional

sender_country

string

optional

sender_currency

string

optional

beneficiary_country

string

optional

beneficiary_currency

string

optional

payout_method_category

string

optional

payout_method_class

string

optional

payout_method_group

string

optional

min_amount

integer

optional

max_amount

integer

optional

is_returnable

boolean

optional

is_enabled

boolean

optional

limit

integer

optional

page

integer

optional

status

string

optional

Examples

SuccessBad Request

{
  "status": true,
  "message": "string",
  "data": [
    {
      "payout_method_id": "string",
      "payout_method_name": "string",
      "payout_method_description": "string",
      "payout_method_logo": "string",
      "sender_country": "string",
      "sender_currency": "string",
      "beneficiary_country": "string",
      "beneficiary_currency": "string",
      "payout_method_category": "string",
      "payout_method_class": "string",
      "payout_method_group": "string",
      "min_amount": 0,
      "max_amount": 0,
      "is_returnable": true,
      "is_enabled": true,
      "limit": 0,
      "page": 0,
      "status": "string"
    }
  ]
}

🟠400Bad Request