Payout-Method

List Payout-Methods By Country & Currency

Changed on

Retrieve a list of Payout-Methods available. The parameters will be SENDER and BENEFICIARY objects and other required fields to be provided for both parties. Filter the results by specifying the currency and country query parameters.

For certain jurisdictions such as Malaysia, Taiwan, etc., while performing inbound cross-border Payouts, some additional pieces of extra information may be required for both sender (source of funds) & beneficiary (receiver of funds) due to local regulatory reporting. This API will assist you in ensuring the information is captured before you progress.

For example, if you are an AU(Australia) based merchant and wish to remit funds to your vendors in Singapore, you probably only need their Company Name, Address, Bank Name, and Account Number but if you have vendors in Malaysia you probably would need to provide their Company Registration Number (CRN) as well.

This API comes with Pagination support, you can customize limit and page query parameters as per the requirements.

get/payout-method/all

Request

  • Base URL
    https://api.finmo.net/v1
  • Auth
    HTTP basic

Query parameters

sender_countrystring required
Example:AU

Country Code (ISO 3166-1, 2-char alphabetic code)

sender_currencystring required
Example:AUD

Currency Code (ISO 4217, 3-char alphabetic code)

beneficiary_countrystring required
Example:AU

Country Code (ISO 3166-1, 2-char alphabetic code)

beneficiary_currencystring required
Example:AUD

Currency Code (ISO 4217, 3-char alphabetic code)

payout_method_class'DOMESTIC' | 'GCA'
Example:DOMESTIC

DOMESTIC or GCA

limitinteger
Example:10

Max number of transactions per page. Default is 10 transactions per page

pageinteger
Example:1

The page number to return. If unspecified, the first page is returned

Response

OK

request_idstring
request_timestring date-time
status_codeinteger
status_textstring
successboolean

Example response

{
  "data": [
    {
      "beneficiary_country": "AU",
      "beneficiary_currency": "AUD",
      "is_enabled": true,
      "is_returnable": true,
      "max_amount": 10000000,
      "min_amount": 1,
      "payout_method_category": "BANK",
      "payout_method_class": "DOMESTIC",
      "payout_method_description": "Payout using PayID",
      "payout_method_group": "NO_GROUP",
      "payout_method_id": "pom_c36c360bfa404a9d94b6d6de128be0df",
      "payout_method_logo": "https://payid.com.au/wp-content/uploads//2021/01/PayID_wordmark-Black-01.svg",
      "payout_method_name": "au_bank_payid",
      "sender_country": "AU",
      "sender_currency": "AUD"
    }
  ]
}

Changes