Skip to main content
GET
/
v1
/
global-payout
/
payment-methods
cURL
curl --request GET \
  --url https://api.nomba.com/v1/global-payout/payment-methods \
  --header 'Authorization: <authorization>' \
  --header 'accountId: <accountid>'
{
  "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"
      ]
    }
  ]
}

Headers

Authorization
string
required

Bearer token for authentication.

Example:

"Bearer <token>"

accountId
string
required

The parent accountId of the business.

Example:

"890022ce-bae0-45c1-9b9d-ee7872e6ca27"

Query Parameters

code
string

Optional payment method code used to return a specific method.

Example:

"ACH"

name
string

Optional payment method name used to return a specific method, for example BANK or Wire Transfer.

Example:

"BANK"

Response

200 - application/json

Payment methods retrieved successfully.

code
string
Example:

"00"

description
string
Example:

"Successful"

data
object[]