List of payment methods
Always send the
amountquery parameter, e.g.&amount=1000for RM 10. Without it, only card methods (visa, mastercard, maestro) and a few others are returned — most methods (FPX, DuitNow QR, Shopee Pay, etc.) have a minimum amount and are hidden from the response.RM 10 (
1000) is a safe value that covers every method’s minimum.
Send this request providing the brand_id and currency query parameters, with 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¤cy=MYR&amount=1000
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
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 you'd use in your Purchase in ISO 4217 format, e.g. MYR.
MYR Country code in the ISO 3166-1 alpha-2 format (e.g. GB). Optional.
If provided in the format of recurring=true, will filter out the methods that don't support recurring charges (see POST /purchases/{id}/charge/).
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).
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 code in the ISO 639-1 format (e.g. 'en'). Optional.
Amount of money as the smallest indivisible units of the currency (e.g. 1000 for RM 10). Strongly recommended in practice even though it's marked optional in the schema — most payment methods (FPX, DuitNow QR, Shopee Pay, etc.) have a minimum amount, and omitting this parameter hides them from the response. Use a value at or above the highest minimum among the methods you want to expose; RM 10 (1000) is a safe default.
Response
OK
Name of the payment method, e.g. visa.
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.
Human-readable names corresponding to country codes as returned by by_country property. any code is also decoded to Other.
Human-readable names of payment methods as returned by available_payment_methods property.
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 of the card methods listed in available_payment_methods property. All of these are grouped under card in other properties like by_country.