Optimise payment methods

POST

https://test-api.star-saas.com/v1/optimise

Our system leverages transaction data to recommend the optimal payment methods, aiming to enhance the overall payment acceptance rate.
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

Header Params

Content-Type

string

required

Example:

application/x-www-form-urlencoded

Body Params multipart/form-data

merchant_id

string

required

Merchant Code or Merchant ID or Merchant Number

<= 7 characters

Example:

account_id

string

required

Subaccount ID or Gateway Number

<= 10 characters

Example:

request_id

string

required

Request a unique identification number

<= 50 characters

Example:

test123456796

currency

string

required

Order Currency Code. Please refer to ISO 4217

<= 3 characters

Example:

EUR

amount

string

required

Total order amount; value needs to be digits only. Please refer to ISO 4217 for decimal values of each currency

<= 15 characters

Example:

shopper_id

string

required

The ID which is allocated or created by Merchant to specify the shopper

<= 64 characters

Example:

test03

shopper_email

string

required

Shopper’s email address

<= 100 characters

Example:

test@gmail.com

shopper_ip

string

optional

Shopper's IP address

<= 50 characters

Example:

111.111.111.111

shopper_country

string

required

Shopper's IP country

<= 2 characters

Example:

shopper_level

string

optional

Shopper tiers defined by merchants

<= 50 characters

Example:

platform

string

optional

Platform order was made through. Can be one of 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

Digital signatures information
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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://test-api.star-saas.com/v1/optimise' \
--form 'merchant_id="701001"' \
--form 'account_id="701001010"' \
--form 'request_id="test123456796"' \
--form 'currency="EUR"' \
--form 'amount="1"' \
--form 'shopper_id="test03"' \
--form 'shopper_email="test@gmail.com"' \
--form 'shopper_ip="111.111.111.111"' \
--form 'shopper_country="JP"' \
--form 'shopper_level="1"' \
--form 'platform="PHONE"' \
--form 'encryption_data="2b0e1c1c5aedd349284f57c504b14fdce65853faef0123e1e0c4cbf5f931f379"'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Create a payout

Update an order