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.
Query Parameters
country
string
Country ISO code
Headers
Authorization
string
"Bearer " + Read-Only API Key
Please find all the country codes in the Countries Specifications section.
Request
In order to start using the payment methods endpoint, you need to:
Send the request with GET method.
Specify a valid country code in the request as QUERY PARAMS.
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.
name
String
Payment method name
status
String
Status of the payment method. It will be updated in case a payment methods becomes momentaneously unavailable
logo
String
URL containing the payment method logo
daily_average
Number
Daily average time for the approval of the deposits with this payment method in seconds. *Note that in case the method is new, we may not have daily average information so this field won't be returned
monthly_average
Number
Monthly average time for the approval of the deposits with this payment method in seconds. *Note that in case the method is new, we may not have monthly average information so this field won't be 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_type
Description
BANK_DEPOSIT
Bank deposits
BANK_TRANSFER
Electronic Funds Transfer (TEF)
WALLET
Wallet solutions
VOUCHER
Cash solutions
MOBILE MONEY
Mobile Money Solutions
Payment Methods
Check the Payment Methods page for the full list of payment methods.
Payment MethodsLast updated
Was this helpful?