Skip to main content
GET
/
api
/
v1
/
payout-methods
List payout methods with field metadata
curl --request GET \
  --url https://app.mlm-platform.com/api/v1/payout-methods \
  --header 'x-tenant-api-key: <api-key>'
{
"country": "<string>",
"methods": [
{
"id": "<string>",
"name": "<string>",
"category": "<string>",
"provider": "<string>",
"currency": "<string>",
"enabled": true,
"fields": [
{
"key": "<string>",
"label": "<string>",
"type": "<string>",
"placeholder": "<string>",
"helpText": "<string>",
"validation": {
"required": true,
"minLength": 123,
"maxLength": 123,
"pattern": "<string>"
},
"options": [
{
"value": "<string>",
"label": "<string>"
}
]
}
]
}
]
}

Authorizations

x-tenant-api-key
string
header
required

Tenant API key for authentication. Keys are scoped to specific environments (LIVE or SANDBOX). Obtain keys from the admin dashboard.

Query Parameters

country
string
required

ISO 3166-1 alpha-2 country code

Required string length: 2

Response

Payout methods for a country

country
string
required
methods
object[]
required