FIfinmo
Payin-Method

List Payin Methods By Country & Currency

Changed on

Retrieve a list of all Payin-Methods available. Filter the results by specifying the currency and country query parameters.

You can also filter the results by specifying the is_va_allowed (Virtual Account) to fetch Payin-Methods specifically for creating Virtual Accounts (e.g., generating a bank account number in Australia with a BSB/Account No). Some Payin-Methods can generate a static Virtual Account and facilitate payments, while other Payin-Methods allow payments through Checkout Page or Direct API. The result includes VA-only-Payin-Methods by country and currency.

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

get/payin-method/all

Request

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

Query parameters

countrystring required
Example:AU

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

currencystring required
Example:AUD

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

is_va_allowedboolean
Example:true

true or false (This field means if a Payin method can be used to generate a Virtual Account for the country, currency combination

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": [
    {
      "is_payin_allowed": false,
      "is_va_allowed": true,
      "payin_method_category": "BANK",
      "payin_method_description": "BSB and Account No",
      "payin_method_id": "pim_b21cad7becbd48c59505eff761c4c561",
      "payin_method_logo": "https://payid.com.au/wp-content/uploads//2021/01/PayID_wordmark-Black-01.svg",
      "payin_method_name": "au_bank_acct"
    }
  ]
}

Changes