v1
latestOpenAPI 3.0.12026-07-2679100267.2 KBReturns all supported payment methods and their method-specific requirements. Filter by code or name to retrieve a specific method.
get/v1/global-payout/payment-methods
Query parameters
codestring
Example:ACH
Optional payment method code used to return a specific method.
namestring
Example:BANK
Optional payment method name used to return a specific method, for example BANK or Wire Transfer.
Headers
Authorizationstring required
Example:Bearer <token>
Bearer token for authentication.
accountIdstring required
Example:890022ce-bae0-45c1-9b9d-ee7872e6ca27
The parent accountId of the business.
Response
Payment methods retrieved successfully.
Example response
{
"code": "00",
"description": "Successful",
"data": [
{
"code": "BANK",
"displayName": "Bank Transfer",
"purposeOfPaymentRequired": true,
"purposeOfPayments": [
"MAINTENANCE_EXPENSES",
"SERVICE_CHARGES"
],
"requiredFields": [
"accountNumber",
"institutionCode",
"accountType",
"bankAccountType",
"beneficiary",
"purposeOfPayment"
],
"optionalFields": [
"narration"
],
"accountTypes": [
"INDIVIDUAL",
"CORPORATE"
],
"bankAccountTypes": [
"CHECKING",
"SAVINGS"
]
}
]
}