Create a redirect payment
POST
https://test-api.star-saas.com/v1/checkout
Request
Header Params
Content-Type
string
required
Example:
application/x-www-form-urlencoded
Body Params application/x-www-form-urlencoded
merchant_id
string
required
<= 7 characters
Example:
{{merchant_id}}
account_id
string
required
<= 10 characters
Example:
{{account_id}}
order_no
string
required
<= 50 characters
Example:
1731480073283
amount
string
required
<= 15 characters
Example:
10.36
item_total
string
optional
<= 15 characters
Example:
10.00
shipping
string
optional
<= 15 characters
Example:
1.00
handling
string
optional
<= 15 characters
Example:
1.00
tax_total
string
optional
<= 15 characters
Example:
1.00
insurance
string
optional
<= 15 characters
Example:
1.00
shipping_discount
string
optional
<= 15 characters
Example:
1.00
discount
string
optional
<= 15 characters
Example:
1.00
items
string
required
<= 5000 characters
Example:
huawei#,#NUM1#,#230.00#,#1#;#Test2#,#NUM2#,#290.00#,#2
note
string
optional
<= 1000 characters
custom
string
optional
Example:
custom1;custom2;custom3;custom4;custom5
<= 2500 characters
card_type
string
optional
1: Visa
2: Master
3: JCB
4: AE
5: Diners
6: Maestro
<= 10 characters
payment_method
string
optional
<= 50 characters
open3d
string
optional
do3DS: try 3D
no3DS: non 3d
<= 10 characters
Example:
do3DS
token_flag
string
optional
YES: Tokenize the card information
NO: Do Not tokenize the card information
This parameter is required when Token is used
<= 10 characters
Example:
NO
token_id
string
optional
Note: The expiration date of token_id is the same as the card expiration date; Once a token is expired new token need to be created during a new payment process
<= 50 characters
shopper_id
string
required
<= 64 characters
Example:
apidog1
shopper_email
string
required
<= 100 characters
Example:
apidog@gmail.com
shopper_phone
string
optional
<= 50 characters
Example:
13012345678
shopper_level
string
optional
<= 50 characters
Example:
1
default_lang
string
optional
en_US --English
zh_HK --Hong Kong
zh_CN --China
ja_JP -- Japan
ko_KR -- South Korea
it_IT -- Italy
ru_RU -- Russia
en_ID -- Indonesia
th_TH -- Thailand
ar_AE -- United Arab Emirates<
tr_TR -- Turkey
nl_NL -- Netherlands
pt_PT -- Portugal
el_GR -- Greece
pl_PL -- Poland
<= 10 characters
Example:
en_US
logo_name
string
optional
<= 2 characters
Example:
1
first_name
string
required
<= 100 characters
Example:
Milton
last_name
string
required
<= 100 characters
Example:
Braganza
billing_country
string
optional
This parameter is required for tangible goods
<= 2 characters
Example:
CN
billing_state
string
optional
This parameter is required for tangible goods and when the country is United States or Canada
<= 100 characters
Example:
FJ
billing_city
string
optional
This parameter is required for tangible goods
<= 100 characters
Example:
Xiamen
billing_address
string
optional
This parameter is required for tangible goods
<= 300 characters
Example:
3610 Brighton Circle Road
billing_postal_code
string
optional
This parameter is required for tangible goods
<= 100 characters
Example:
56376
delivery_firstname
string
optional
<= 100 characters
Example:
Li
delivery_lastname
string
optional
<= 100 characters
Example:
Han
delivery_country
string
optional
<= 100 characters
Example:
CN
delivery_state
string
optional
<= 100 characters
Example:
FJ
delivery_city
string
optional
<= 100 characters
Example:
Xiamen
delivery_address
string
optional
<= 300 characters
Example:
3610 Brighton Circle Road
delivery_postal_code
string
optional
This parameter is required for tangible goods and when the country is United States or Canada
<= 100 characters
Example:
56376
return_url
string
required
<= 500 characters
Example:
{{webUrl}}/v1/pages/PayResult.jsp
notify_url
string
required
<= 500 characters
Example:
{{webUrl}}/v1/pages/NotifyResult.jsp
cancel_url
string
required
<= 500 characters
Example:
{{webUrl}}/v1/pages/PayResult.jsp
verify_billing_address
string
optional
YES: Need to verify billing address
No: Don’t need to verify billing address (Default Value)
<= 10 characters
Example:
YES
encryption_data
string
required
encryption_data=sha256(merchant_id + account_id + order_no + currency+ amount + return_url+ sign_key);
All encryption parameters need to remove spaces before encryption.
<= 64 characters
Example:
003b48322659ff3be45f33135f9f46dc6edcf6e911100dfd925299c6b79e26f2
platform_source
string
optional
Acceptable Value: Magento, Shopify, Shoplazza, Shopyy, Shopline, WooCommerce, Zencart, SAAS
<= 30 characters
Example:
Shopify
device_type
string
optional
PC, Mobile<= 20 characters
Example:
PC
price_id
string
optional
<= 50 characters
quote_id
string
optional
<= 50 characters
quote_price
string
optional
<= 15 characters
color_depth
string
optional
<= 50 characters
Example:
24
accept
string
optional
user_agent
string
optional
Example:
Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36