Payment Methods Endpoint

The Payment Methods endpoint allows you to retrieve the complete list of payment methods you have available for the country specified

Payment Methods

GET https://api-stg.lime-pay.com/v3/payment_methods?country={country}

Description

The payment_methods endpoint will show you all the payment methods your account has enabled for the country specified as query params in the request.

It will also show details about each payment method like the payment method code, the payment method name, thepayment method type as well as the payment method logo and others.

In case of integrating the OneShot Experience and displaying the payment methods on your cashier, make sure you check the payment methods with this API multiple times per day to make sure that in case a new payment method becomes available or unavailable, you will also automatically update it on your cashier without requiring manual intervention from either side.

Query Parameters

Headers

Please find all the country codes in the Countries Specifications section.

Request

In order to start using the payment methods endpoint, you need to:

  1. Send the request with GET method.

  2. Specify a valid country code in the request as QUERY PARAMS.

  3. Send the Authorization header with your read-only API Key as Bearer as follows:

Authorization: Bearer your_read_only_key_here

Example request

curl --location --request GET 'https://api-stg.lime-pay.com/v3/payment_methods?country=MY' \
--header 'Authorization: Bearer your_read_only_key_here'

Example Response

[
    {
        "country": "MY",
        "code": "MB",
        "name": "AmBank",
        "type": "BANK_DEPOSIT",
        "status": "OK",
        "logo": "https://resources.lime-pay.com/cashin/payment_method/square/MB.svg"
    },
    {
        "country": "MY",
        "code": "TR",
        "name": "Bank Transfer",
        "type": "BANK_TRANSFER",
        "status": "OK",
        "logo": "https://resources.lime-pay.com/cashin/payment_method/square/TR.svg"
    },
    {
        "country": "MY",
        "code": "BST",
        "name": "Boost",
        "type": "WALLET",
        "status": "OK",
        "logo": "https://resources.lime-pay.com/cashin/payment_method/square/BST.svg",
        "daily_average": 216,
        "monthly_average": 142
    },
    {
        "country": "MY",
        "code": "BY",
        "name": "CIMB Bank",
        "type": "BANK_DEPOSIT",
        "status": "OK",
        "logo": "https://resources.lime-pay.com/cashin/payment_method/square/BY.svg",
        "daily_average": 50,
        "monthly_average": 50
    },
    {
        "country": "MY",
        "code": "FPX",
        "name": "FPX",
        "type": "BANK_TRANSFER",
        "status": "OK",
        "logo": "https://resources.lime-pay.com/cashin/payment_method/square/FPX.svg"
    },
    {
        "country": "MY",
        "code": "GRB",
        "name": "Grab",
        "type": "WALLET",
        "status": "OK",
        "logo": "https://resources.lime-pay.com/cashin/payment_method/square/GRB.svg",
        "daily_average": 300,
        "monthly_average": 300
    },
    {
        "country": "MY",
        "code": "MY",
        "name": "Maybank",
        "type": "BANK_DEPOSIT",
        "status": "OK",
        "logo": "https://resources.lime-pay.com/cashin/payment_method/square/MY.svg",
        "daily_average": 17,
        "monthly_average": 17
    },
    {
        "country": "MY",
        "code": "PU",
        "name": "Public Bank",
        "type": "BANK_DEPOSIT",
        "status": "OK",
        "logo": "https://resources.lime-pay.com/cashin/payment_method/square/PU.svg",
        "daily_average": 32,
        "monthly_average": 32
    },
    {
        "country": "MY",
        "code": "RH",
        "name": "RHB Bank",
        "type": "BANK_DEPOSIT",
        "status": "OK",
        "logo": "https://resources.lime-pay.com/cashin/payment_method/square/RH.svg",
        "daily_average": 15,
        "monthly_average": 15
    },
    {
        "country": "MY",
        "code": "SPAY",
        "name": "ShopeePay",
        "type": "WALLET",
        "status": "OK",
        "logo": "https://resources.lime-pay.com/cashin/payment_method/square/SPAY.svg",
        "daily_average": 101,
        "monthly_average": 101
    },
    {
        "country": "MY",
        "code": "TNG",
        "name": "Touch n Go",
        "type": "WALLET",
        "status": "OK",
        "logo": "https://resources.lime-pay.com/cashin/payment_method/square/TNG.svg",
        "daily_average": 73,
        "monthly_average": 73
    }
]

Response Fields

The response will return an object different for each payment method. You should be able to iterate though it no matter how many payment methods are returned.

We may add more fields to this response's object in the future. Please develop your integration considering that it will ignore new fields and continue working fine no matter if we add new fields.

Payment types

Payment Methods

Check the Payment Methods page for the full list of payment methods.

Last updated