v2.payment.get_payment_method_list

资料正文

§1 v2.payment.get_payment_method_list

Obtain payment method (no authentication required)

§2 Overview

Overview

Field	Value
Module	Payment
API type	Public
HTTP method	GET
Path	/api/v2/payment/get_payment_method_list
Production URL	https://partner.shopeemobile.com/api/v2/payment/get_payment_method_list
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/payment/get_payment_method_list
Rate limit	[0, 0, 0]
Permission	ERP System; Seller In House System; Accounting And Finance; Swam ERP

§3 Response parameters

Response parameters

Name	Type	Description
error	string	error code
message	string	error message
request_id	string	Unique id for request
response	object[]
response.payment_method	string[]
response.region	string

§4 Common parameters

Common parameters

Name	Type	Sample	Description
partner_id	int	1	Partner ID is assigned upon registration is successful. Required for all requests.
timestamp	timestamp	1610000000	This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Signature generated by partner_id, api path, timestamp and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2

§5 Response sample

Response sample

§6 JSON

JSON

{
"request_id": "fbb8eb389cf94bad423f32e2735cc0dc",
"error": "",
"message": "",
"response": [{
"payment_method": [
"Cybersource",
"Nicepay CC (ANZ) 18x installment plan",
"Nicepay CC (ANZ) 24x installment plan"
],
"region": "ID"
},
{
"payment_method": [
"MOLPay",
"WeChat Pay (New)",
"iPay88 CC Installment Public Bank 6x"
],
"region": "MY"
},
{
"payment_method": [
"Dragonpay - Online EastWestBanker",
"Shopee Credit x12"
],
"region": "PH"
},
{
"payment_method": [
"Android Pay",
"Cybersource"
],
"region": "SG"
},
{
"payment_method": [
"Online Payment (KBANK)",
"Shopee Credit x12"
],
"region": "TH"
},
{
"payment_method": [
"Cybersource",
"Airpay Credit Card Installment HWATAI BANK 24x",
"Bank Transfer (CTBC VA)"
],
"region": "TW"
},
{
"payment_method": [
"WeChat Pay (New)",
"Free",
"Airpay Credit  Card",
"WeChat Pay",
"Cybersource Installment Citibank 6x",
"Cybersource Installment HDBank 12x"
],
"region": "VN"
}
]
}

§7 Errors

Errors

Error	Description	Solution
error_param	There is no access_token in query.
error_auth	Invalid access_token.
error_network	Inner http call failed
error_data	parse data failed
error_data	data not exist
error_param	parameter invalid
error_param	The information you queried is not found.
error_param	Wrong parameters, detail: {msg}.
error_server	Something wrong. Please try later.
error_shop	shopid is invalid
error_param	request not from gateway

§8 Common errors

Common errors

Error	Description	Solution
error_auth	partner_id is invalid
error_auth	The App is deleted, and you'll be unable to make any API call.
error_auth	App developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
error_param	There is no partner_id in query.
error_param	Invalid partner_id.
error_param	no timestamp
error_param	Invalid timestamp
error_param	There is no sign in query.
error_sign	Wrong sign.
invalid_partner_id	Invalid partner_id, please have a check.
error_auth	No permission to current api.
error_api_call_restricted	The App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
api_suspended	The API is offline. Please call v2 API instead.
error_limit	The total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00)
error_rate_limit	Too many requests. You have reached the rate limit. Please try again later.
source_ip_undeclared	Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_param	Permission denied. This API is currently offline or the request path is incorrect.
error_param	Partner_id is invalid, should be an integer between 0 and 4294967295.
error_param	no timestamp.
error_param	Timestamp is invalid, should be an integer between 0 and 4294967295.
error_param	Timestamp is expired.
error_partner_key_expired	Your API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api.
error_api_permission	This app type has no permission to this API.