NOnomba

GET /v1/global-payout/payment-methods

Changed on

Returns all supported payment methods and their method-specific requirements. Filter by code or name to retrieve a specific method.

Request

  • Base URL
    https://api.nomba.com
  • URL
    https://api.nomba.com/v1/global-payout/payment-methods
  • Auth
    none declared. Required headers: Authorization, accountId

Query parameters

destinationCountryIsoCodestring
Example:CA

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.

destinationCurrencystring
Example:CAD

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

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.

codestring
descriptionstring

Example response

{
  "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"
        }
      ]
    }
  ]
}

Changes

  • 278a25dccfe5Revision changes
    • breaking

      the /// response's property type changed from string to object for status

    • info

      added the new optional query request parameter destinationCountryIsoCode

    • info

      added the new optional query request parameter destinationCurrency

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status