Get beneficiary field requirements for a currency

GET

payouts

requirements

curl --request GET \
  --url https://api.example.com/v1/payouts/requirements \
  --header 'Authorization: Bearer <token>'

{
  "optional": [
    "email",
    "addressLine2",
    "countrySubdivision"
  ],
  "required": [
    "address",
    "city",
    "postcode"
  ]
}

Authorization

string

header

required

Enter Auth0 JWT token

currency

string

required

Destination currency (e.g. NGN, EUR, USD, GBP)

Example:

"NGN"

Beneficiary field requirements for the currency

optional

string[]

required

Fields that may optionally be provided

Example:

[
  "email",
  "addressLine2",
  "countrySubdivision"
]

required

string[]

required

Fields that must be provided for this corridor

Example:

["address", "city", "postcode"]

Get beneficiary field requirements for a currency

curl --request GET \
  --url https://api.example.com/v1/payouts/requirements \
  --header 'Authorization: Bearer <token>'

{
  "optional": [
    "email",
    "addressLine2",
    "countrySubdivision"
  ],
  "required": [
    "address",
    "city",
    "postcode"
  ]
}

Documentation Index