GET
/
payment_methods
/
curl --request GET \
  --url https://gate.chip-in.asia/api/v1/payment_methods/ \
  --header 'Authorization: Bearer <token>'
{
  "available_payment_methods": [
    "visa",
    "mastercard",
    "some_method"
  ],
  "by_country": {
    "GB": [
      "some_method"
    ],
    "any": [
      "card"
    ]
  },
  "card_methods": [
    "american_express",
    "visa"
  ],
  "country_names": {
    "GB": "United Kingdom",
    "any": "Other"
  },
  "logos": {
    "mastercard": "/static/images/icon-mastercard.svg",
    "some_method": [
      "/static/images/icon-visa.svg",
      "/static/images/icon-mastercard.svg",
      "/static/images/icon-maestro.svg"
    ],
    "visa": "/static/images/icon-visa.svg"
  },
  "names": {
    "mastercard": "Mastercard",
    "some_method": "Some method",
    "visa": "Visa"
  }
}

Send this request providing, at the very least, the brand_id and currency query parameters having the same values you’d use to create your Purchase. Be sure to use the same API key you’ll create your Purchase with; it will define the test_mode setting used in the lookup.

In the response body you’ll receive an object with available_payment_methods property containing the list of payment method names available to use with your Purchase (e.g. those codes can be used in payment_method_whitelist field or with ?preferred={payment_method} option of checkout_url).

Please note that all lookup arguments must be provided via query parameters after the endpoint, e.g. the minimal call would be similar to: GET /api/v1/payment_methods/?brand_id=75a76529-91c7-4d98-90a9-8a641d70ee52&currency=MYR

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

brand_id
string
required

Which brand would you like to lookup the available payment methods for. Use the same value (UUID) you'd set the Purchase.brand_id to.

currency
enum<string>
required

Currency you'd use in your Purchase in ISO 4217 format, e.g. EUR.

Available options:
MYR
country
string

Country code in the ISO 3166-1 alpha-2 format (e.g. GB). Optional.

recurring
boolean

If provided in the format of recurring=true, will filter out the methods that don't support recurring charges (see POST /purchases/{id}/charge/).

skip_capture
boolean

If provided in the format of skip_capture=true, will filter out the methods that don't support skip_capture functionality (see the description for Purchase.skip_capture field).

preauthorization
boolean

If provided in the format of preauthorization=true, will filter out the methods that don't support preauthorization functionality (see the description for Purchase.skip_capture field).

language
string

Language code in the ISO 639-1 format (e.g. 'en'). Optional.

amount
integer

Amount of money as the smallest indivisible units of the currency. Some payment method like FPX are not available when purchase is below than RM 1. Optional.

Response

200 - application/json
available_payment_methods
string[]
by_country
object

Payment method names (as returned by available_payment_methods) grouped by country codes they are available in. any key returns names of payment method available in all countries.

card_methods
string[]
country_names
object

Human-readable names corresponding to country codes as returned by by_country property. any code is also decoded to Other.

logos
object

Mapping of payment method names to respective logo file paths (relative to the hostname of API host). Some methods can be displayed as an array of logos.

names
object

Human-readable names of payment methods as returned by available_payment_methods property.