Payment methods

Returns 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

cURL

cURL

curl --request GET \
  --url https://api.nomba.com/v1/global-payout/payment-methods \
  --header 'Authorization: <authorization>' \
  --header 'accountId: <accountid>'

200

{
  "code": "00",
  "description": "Successful",
  "data": [
    {
      "code": "EFT",
      "displayName": "EFT",
      "purposeOfPaymentRequired": true,
      "purposeOfPayments": [
        {
          "code": "SERVICE_CHARGES",
          "displayName": "Service Charges"
        }
      ],
      "requiredFields": [
        "amount",
        "sourceCurrency",
        "destinationCurrency",
        "receiverName",
        "sourceCountryIsoCode",
        "destinationCountryIsoCode",
        "paymentMethod",
        "accountType",
        "accountNumber",
        "institutionCode",
        "beneficiary.beneficiaryEmail",
        "beneficiary.transitNumber"
      ],
      "optionalFields": [
        "narration",
        "lockedExchangeRateId",
        "beneficiary.beneficiaryState"
      ],
      "accountTypes": [
        "INDIVIDUAL",
        "CORPORATE"
      ],
      "bankAccountTypes": [
        "CHECKING",
        "SAVINGS"
      ],
      "supportedCorridors": [
        {
          "countryIsoCode": "CA",
          "currency": "CAD"
        }
      ]
    }
  ]
}

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

destinationCountryIsoCode · string

Optional destination country ISO code. Supply it to receive that corridor's method-specific requiredFields and optionalFields. Omit it to receive the catalogue of available methods and the corridors each one serves.

Example:

"CA"

destinationCurrency · string

Optional destination currency code. Use it where a country supports more than one currency and the requirements differ between them.

Example:

"CAD"

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[]

Show child attributes