Fetch Payment Methods

Retrieve supported payment methods and method-specific requirements

Fetch Payment Methods

GET /v1/global-payout/payment-methods

Returns the payment methods available to you and, for a given corridor, the exact fields an Authorize Transfer request must carry.

A payment method’s requirements depend on where you are sending to. The same method carries different fields in different corridors — SEPA requires an institutionCode in some destinations and not others, and a Canadian bank payout needs routing details a European one does not. The endpoint therefore answers in two ways.

Without a destination country, it returns the catalogue: which methods exist, and the corridors each one serves. Only the fields that apply to every request are listed.

With destinationCountryIsoCode, it returns that corridor’s exact requiredFields and optionalFields.

Start with the catalogue to discover a method and its corridors, then call again with destinationCountryIsoCode (and destinationCurrency where a country supports more than one) to get the fields you must send.

Query parameters

destinationCountryIsoCode · string

Optional destination country ISO code, for example CA. Supply it to receive that corridor’s method-specific requiredFields and optionalFields. Omit it to receive the catalogue.

destinationCurrency · string

Optional destination currency code, for example CAD. Use it where a country supports more than one currency and the requirements differ between them. Without it, a method configured for several currencies in that country is returned once per currency.

code · string

Optional payment method code. Use this to retrieve a specific method, for example EFT.

name · string

Optional payment method name. Use this to retrieve a specific method, for example BANK or Wire Transfer.

Supported method codes are BANK, MobileMoney, INTERAC, FASTER_PAYMENTS, SEPA, ACH, EFT, and WIRE. A method appears only where it is active for at least one corridor.

Transaction limits and delivery timelines are documented on the Supported Countries page — they are not part of this response.

Catalogue request

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

Reading the field names

requiredFields and optionalFields name fields on the Authorize Transfer request body. A dotted name is a nested field: beneficiary.transitNumber means transitNumber inside the beneficiary object.

{
  "amount": 5000,
  "paymentMethod": "EFT",
  "receiverName": "Jane Doe",
  "accountNumber": "1234567",
  "institutionCode": "001",
  "beneficiary": {
    "beneficiaryEmail": "[e-mail]",
    "transitNumber": "12345"
  }
}

Response body

data · array · required

List of payment methods. On a corridor request, a method configured for more than one currency in that country appears once per currency; supportedCorridors identifies which.

Hide payment method object

code · string

The payment method code. Use this as the paymentMethod value in the Authorize Transfer request.

displayName · string

Human-readable label suitable for displaying in a UI selector.

purposeOfPaymentRequired · boolean

Indicates whether purposeOfPayment is required for this payment method in this corridor.

purposeOfPayments · array

Selectable purpose-of-payment values, each an object with a code and a displayName. When purposeOfPaymentRequired is true, send one of the code values as purposeOfPayment. Empty on the catalogue response.

requiredFields · array

Fields that must be included when authorizing a transfer with this payment method. On the catalogue response this lists only the fields every request carries; call with destinationCountryIsoCode for the method-specific ones.

optionalFields · array

Fields that may be included but are not required.

accountTypes · array

Selectable accountType values for this payment method. Empty on the catalogue response.

bankAccountTypes · array

Selectable bankAccountType values for this payment method. Empty where the method does not use one.

supportedCorridors · array

The corridors this entry covers. On the catalogue response, every corridor the method is available in — use these to decide which destinationCountryIsoCode and destinationCurrency to request next. On a corridor response, the single corridor the entry describes.

Show corridor object

countryIsoCode · string

Destination country ISO code, for example CA.

currency · string

Destination currency code, for example CAD.