Optimise payment methods
POST
/v1/optimise
By using this interface, the system will provide a list of available payment methods, sorted by the highest acceptance rate, enabling shoppers to complete their payments seamlessly.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://test.your-api-server.com/v1/optimise' \
--form 'merchant_id="{{merchant_id}}"' \
--form 'account_id="{{account_id}}"' \
--form 'request_id="test123456796"' \
--form 'currency="EUR"' \
--form 'amount="1"' \
--form 'shopper_id="test03"' \
--form 'shopper_email="test@gmail.com"' \
--form 'shopper_country="JP"' \
--form 'encryption_data="2b0e1c1c5aedd349284f57c504b14fdce65853faef0123e1e0c4cbf5f931f379"'Response Response Example
{}Request
Header Params
Content-Type
string
required
Example:
application/x-www-form-urlencoded
Body Params multipart/form-data
merchant_id
string
required
<= 7 characters
Example:
{{merchant_id}}
account_id
string
required
<= 10 characters
Example:
{{account_id}}
request_id
string
required
<= 50 characters
Example:
test123456796
amount
string
required
<= 15 characters
Example:
1
shopper_id
string
required
<= 64 characters
Example:
test03
shopper_email
string
required
<= 100 characters
Example:
test@gmail.com
shopper_ip
string
optional
<= 50 characters
Example:
111.111.111.111
shopper_country
string
required
<= 2 characters
Example:
JP
shopper_level
string
optional
<= 50 characters
Example:
1
platform
string
optional
WEB, PHONE, DYNAMIC_PHONE, MOBILE, MOBILE_IN_STORE, IOS, ANDROID, WAP, STORE, MERCHANT_EMPLOYEE, MAIL_ORDER, AUTOMATIC_RENEWAL_OR_INSTALLMENT_PAYMENT, MERCHANT_INITIATED, UNKNOWN, POS, API_ONLY, PERSONAL_POS, PHONE_LINK<= 50 characters
Example:
PHONE
encryption_data
string
required
encryption_data=sha256(merchant_id + account_id + request_id + currency + amount + shopper_email + sign_key);
All encryption parameters need to remove spaces before encryption.
<= 64 characters
Example:
2b0e1c1c5aedd349284f57c504b14fdce65853faef0123e1e0c4cbf5f931f379