v1

latestOpenAPI 3.1.02026-07-266133267.6 KB

Collection Methods

This allows you to check the collection methods available for a given buyer/seller country. This also shows the supported collection methods for the invoice currency and country corridor, the banks and type of accounts that will be available.

get/v3/metadata/collect

Query parameters

amountinteger required

Amount in cents. For example if you want to charge $10.12 pass 1012 as the value. For decimal handling for various currencies, refer to <a href="/API-Reference/appendix/Decimal-Currencies" target="_blank"> the guide here</a>

invoice_currencystring required

Invoice currency, ISO 4217 standard specifies three-letter ("Alpha-3") codes. e.g. USD

customer_countrystring required

ISO 3166 standard alpha-2 code. eg: SG, IN, US

Response

200

statusstring

Indicates whether the request to fetch available payment methods or quote was successful.

Example response

{
  "data": {
    "payment_methods": [
      {
        "logo": [
          "downloadable_logo_url_1",
          "downloadable_logo_url_2"
        ]
      }
    ]
  }
}