ELANLINK
  1. Acquiring
ELANLINK
  • Guides
    • Welcome
    • Interface
  • API Reference
    • Introduction
    • Endpoints
    • Data Types
    • Signing
    • 3-D Secure Verification
    • Subscription
    • Errors
    • Webhooks
    • Items Information
    • Changelog
    • Acquiring
      • Create a direct payment
        POST
      • Create a redirect (iFrame) payment
        POST
      • Capture a transaction
        POST
      • Review a transaction
        POST
      • Cancel a transaction
        POST
      • Cancel a subscription
        POST
      • Query a transaction
        POST
      • Refund a transaction
        POST
      • Search a refund transaction
        POST
      • Create a payout
        POST
      • Optimise payment methods
        POST
      • Update an order
        POST
  • Appendix
    • Test Cards
    • Bank Code
    • Country Code
    • Currency Code
    • Payment Methods
  1. Acquiring

Create a redirect (iFrame) payment

POST
/v1/checkout
Create a redirect session for your customer by generating a ELANLINK hosted payment page.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://test.your-api-server.com/v1/checkout' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-raw '{
    "merchant_id": "701001",
    "account_id": "701001010",
    "order_no": "1726891254563",
    "currency": "USD",
    "amount": "10.36",
    "item_total": "10.00",
    "shipping": "1.00",
    "handling": "1.00",
    "tax_total": "1.00",
    "insurance": "1.00",
    "shipping_discount": "1.00",
    "discount": "1.00",
    "website": "website.com",
    "items": "huawei#,#NUM1#,#230.00#,#1#;#Test2#,#NUM2#,#290.00#,#2",
    "note": "",
    "shopper_id": "apidog1",
    "shopper_email": "apidog@gmail.com",
    "shopper_ip": "219.78.45.63",
    "shopper_phone": "13012345678",
    "shopper_level": "1",
    "open3d": "do3DS",
    "token_flag": "NO",
    "token_id": "",
    "first_name": "Milton",
    "last_name": "Braganza",
    "notify_url": "{{webUrl}}/v1/pages/NotifyResult.jsp",
    "document": "",
    "birth_date": "02-02-1920",
    "billing_country": "CN",
    "billing_state": "FJ",
    "billing_city": "Xiamen",
    "billing_address": "3610  Brighton Circle Road",
    "billing_postal_code": "56376",
    "os": "Win10",
    "browser": "Mozilla/5.0 (Windows NT 10.0; WOW64) …",
    "browser_lang": "en-US",
    "time_zone": "8",
    "resolution": "1920x1080",
    "cookie_new": "billing_country=US&shopper_email=test@ company.com&time_zone=.... ",
    "cookie_old": "billing_country=US&shopper_email=test@ company.com&time_zone=.... ",
    "challenge_window_size": "01",
    "session_id": "",
    "delivery_firstname": "Li",
    "delivery_lastname": "Han",
    "delivery_country": "CN",
    "delivery_state": "FJ",
    "delivery_city": "Xiamen",
    "delivery_address": "3610  Brighton Circle Road",
    "delivery_postal_code": "56376",
    "custom": "",
    "installments": "",
    "installments_id": "",
    "device_fingerprint": "",
    "encryption_data": "003b48322659ff3be45f33135f9f46dc6edcf6e911100dfd925299c6b79e26f2",
    "platform_source": "Shopify",
    "device_type": "PC",
    "order_type": "WEB",
    "checkout_time": 1415273168,
    "user_agent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36",
    "forter_token_cookie": "",
    "cart_items": [
        {
            "basic_item_data": {
                "name": "Tanya Langosh V",
                "quantity": "19",
                "type": "veniam ea dolore",
                "price": {
                    "amount_usd": 341.99,
                    "amount_local_currency": 962.39,
                    "currency": "RON"
                },
                "category": "velit in exercitation incididunt",
                "productId": "tempor nostrud"
            }
        },
        {
            "basic_item_data": {
                "name": "Vicky Muller",
                "quantity": "19",
                "type": "elit eu aliqua ad mollit",
                "price": {
                    "amount_usd": 911.79,
                    "amount_local_currency": 973.19,
                    "currency": "UYU"
                },
                "category": "pariatur in",
                "productId": "cillum min"
            }
        }
    ],
    "account_owner": [
        {
            "first_name": "Aditya",
            "last_name": "Macejkovic",
            "email": "Sydnie84@gmail.com",
            "account_id": "aliquip",
            "created": 65540588.10937965,
            "past_orders_count": 26710687.666394636,
            "past_orders_sum": -18973407.709439844,
            "lastLogin_ip": "bbd5:0dab:9af3:83b9:adcd:9c8d:f36b:8fee",
            "registration_ip": "152.207.3.206"
        }
    ],
    "total_discount": [
        {
            "coupon_code_used": "56",
            "discount_type": "nostrud in aliq"
        },
        {
            "coupon_code_used": "43",
            "discount_type": "commodo dolore est cup"
        },
        {
            "coupon_code_used": "51",
            "discount_type": "culpa est"
        }
    ],
    "additional_information": [
        {
            "mpi_info": {
                "eci": "",
                "cavv": "dolor exercitation incididunt id",
                "xid": "minim",
                "dsTransID": "occaecat ex ut proide"
            }
        },
        {
            "mpi_info": {
                "eci": "",
                "cavv": "incididunt velit id",
                "xid": "ullamco incididunt sit Excepteur",
                "dsTransID": "in amet incididunt dolor"
            }
        }
    ],
    "price_id": "695.95",
    "quote_id": "",
    "quote_price": "873.35",
    "color_depth": "test",
    "storefront_domains": "mealy-onset.info",
    "subscription": {
        "contract": "in consequat",
        "contract_name": "Vickie Windler",
        "contract_amount": "321.99",
        "interval": "day",
        "interval_count": "aliquip",
        "billing_cycle": 72751013,
        "promotion_cycle": 77462921,
        "contract_start": "elit tempo",
        "contract_end": "ir",
        "price_id": "100.69"
    }
}'
Response Response Example
200 - Success example
<html>

<head>
	<title>Payment Loading...</title>
</head>

<body onload="fun_onload_event();">
	<form name="theForm" id="shoplazz" method="POST" action="https://test-api.star-saas.com/v1/checkout">
		<input type="hidden" name="gbc_id" value="126301" />
		<input type="hidden" name="connector_code" value="RISINGPAY" />
		<input type="hidden" name="account_name" value="default" />
		<input type="hidden" name="webSite" value="" />
		<input type="hidden" name="pm_id" value="8" />
		<input type="hidden" name="apm_type" value="MIX" />
		<input type="hidden" name="descriptor" value="star-saas" />
		<input type="hidden" name="orderprefix" value="C" />
		<input type="hidden" name="rrtimezone" value="+0000" />
		<input type="hidden" name="ordernumlength" value="12" />
		<input type="hidden" name="sendbgoods" value="0" />
		<input type="hidden" name="replacename" value="null" />
		<input type="hidden" name="send_bank_website" value="test-star-saas.com" />
		<input type="hidden" name="replace_up_id" value="701" />
		<input type="hidden" name="replace_match_address" value="0" />

		<input type="hidden" name="to_pass_page" value="true" />

	</form>
	<script language="Javascript">
		function fun_onload_event()
		{
			var shoplazzElement = document.getElementById('shoplazz');
			
				var inputEle = document.createElement('input');
				inputEle.name = `insurance`;
				inputEle.type = 'hidden';
				inputEle.value = `1.00`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `shopper_phone`;
				inputEle.type = 'hidden';
				inputEle.value = `13012345678`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `country`;
				inputEle.type = 'hidden';
				inputEle.value = `CN`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `delivery_address`;
				inputEle.type = 'hidden';
				inputEle.value = `3610  Brighton Circle Road`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `signInfo`;
				inputEle.type = 'hidden';
				inputEle.value = `003b48322659ff3be45f33135f9f46dc6edcf6e911100dfd925299c6b79e26f2`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `APMType`;
				inputEle.type = 'hidden';
				inputEle.value = ``
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `taxTotal`;
				inputEle.type = 'hidden';
				inputEle.value = `1.00`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `price_id`;
				inputEle.type = 'hidden';
				inputEle.value = ``
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `discount`;
				inputEle.type = 'hidden';
				inputEle.value = `1.00`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `billing_address`;
				inputEle.type = 'hidden';
				inputEle.value = `3610  Brighton Circle Road`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `device_type`;
				inputEle.type = 'hidden';
				inputEle.value = `PC`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `shipping`;
				inputEle.type = 'hidden';
				inputEle.value = `1.00`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `token_id`;
				inputEle.type = 'hidden';
				inputEle.value = ``
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `merNo`;
				inputEle.type = 'hidden';
				inputEle.value = `701001`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `source_request_ip`;
				inputEle.type = 'hidden';
				inputEle.value = `39.109.216.11`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `default_lang`;
				inputEle.type = 'hidden';
				inputEle.value = `en_US`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `open3d`;
				inputEle.type = 'hidden';
				inputEle.value = `do3DS`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `allParams`;
				inputEle.type = 'hidden';
				inputEle.value = `insurance=1.00&country=CN&signInfo=003b48322659ff3be45f33135f9f46dc6edcf6e911100dfd925299c6b79e26f2&gbc_id=null&APMType=&billing_street_number=null&taxTotal=1.00&discount=1.00&delivery_street_number=null&cardNo=null&cardSecurityCode=null&merNo=701001&state=FJ&zip=56376&orderNo=1731480073283&orderCurrency=USD&shipZip=56376&timeZone=null&shipFirstName=Li&firstName=Milton&cpfNumber=null&itemTotal=10.00&phone=13012345678&shipState=FJ&notifyUrl=https://test-api.star-saas.com/v1/pages/NotifyResult.jsp&shippingDiscount=1.00&shipLastName=Han&goodsInfo=huawei#,#NUM1#,#230.00#,#1#;#Test2#,#NUM2#,#290.00#,#2&cardExpireMonth=null&defaultLang=en_US&lastName=Braganza&verifyBillingAddress=YES&cardExpireYear=null&city=Xiamen&remark=&shipFee=1.00&newCookie=null&shipCountry=CN&billing_district_name=null&webSite=null&paymentToken=&orderAmount=10.36&oldCookie=null&delivery_district_name=null&merSendLogoNo=1&returnUrl=https://test-api.star-saas.com/v1/pages/PayResult.jsp&email=apidog@gmail.com&user_agent=null&shipCity=Xiamen&shopperLevel=1&address=3610  Brighton Circle Road&gatewayNo=701001021&referenceNo=null&shopperId=apidog1&custom=&cardType=&token=NO&shipAddress=3610  Brighton Circle Road&browerLang=null&cancelUrl=https://test-api.star-saas.com/v1/pages/PayResult.jsp&isOpen3D=do3DS&handling=1.00&`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `state`;
				inputEle.type = 'hidden';
				inputEle.value = `FJ`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `payment_method`;
				inputEle.type = 'hidden';
				inputEle.value = ``
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `zip`;
				inputEle.type = 'hidden';
				inputEle.value = `56376`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `orderNo`;
				inputEle.type = 'hidden';
				inputEle.value = `1731480073283`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `orderCurrency`;
				inputEle.type = 'hidden';
				inputEle.value = `USD`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `shipZip`;
				inputEle.type = 'hidden';
				inputEle.value = `56376`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `delivery_postal_code`;
				inputEle.type = 'hidden';
				inputEle.value = `56376`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `quote_id`;
				inputEle.type = 'hidden';
				inputEle.value = ``
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `item_total`;
				inputEle.type = 'hidden';
				inputEle.value = `10.00`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `delivery_state`;
				inputEle.type = 'hidden';
				inputEle.value = `FJ`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `shipFirstName`;
				inputEle.type = 'hidden';
				inputEle.value = `Li`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `billing_city`;
				inputEle.type = 'hidden';
				inputEle.value = `Xiamen`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `firstName`;
				inputEle.type = 'hidden';
				inputEle.value = `Milton`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `itemTotal`;
				inputEle.type = 'hidden';
				inputEle.value = `10.00`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `phone`;
				inputEle.type = 'hidden';
				inputEle.value = `13012345678`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `shipState`;
				inputEle.type = 'hidden';
				inputEle.value = `FJ`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `notifyUrl`;
				inputEle.type = 'hidden';
				inputEle.value = `https://test-api.star-saas.com/v1/pages/NotifyResult.jsp`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `shopper_email`;
				inputEle.type = 'hidden';
				inputEle.value = `apidog@gmail.com`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `shippingDiscount`;
				inputEle.type = 'hidden';
				inputEle.value = `1.00`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `items`;
				inputEle.type = 'hidden';
				inputEle.value = `huawei#,#NUM1#,#230.00#,#1#;#Test2#,#NUM2#,#290.00#,#2`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `cancel_url`;
				inputEle.type = 'hidden';
				inputEle.value = `https://test-api.star-saas.com/v1/pages/PayResult.jsp`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `shipLastName`;
				inputEle.type = 'hidden';
				inputEle.value = `Han`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `goodsInfo`;
				inputEle.type = 'hidden';
				inputEle.value = `huawei#,#NUM1#,#230.00#,#1#;#Test2#,#NUM2#,#290.00#,#2`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `defaultLang`;
				inputEle.type = 'hidden';
				inputEle.value = `en_US`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `order_no`;
				inputEle.type = 'hidden';
				inputEle.value = `1731480073283`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `note`;
				inputEle.type = 'hidden';
				inputEle.value = ``
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `lastName`;
				inputEle.type = 'hidden';
				inputEle.value = `Braganza`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `verifyBillingAddress`;
				inputEle.type = 'hidden';
				inputEle.value = `YES`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `tax_total`;
				inputEle.type = 'hidden';
				inputEle.value = `1.00`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `city`;
				inputEle.type = 'hidden';
				inputEle.value = `Xiamen`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `encryption_data`;
				inputEle.type = 'hidden';
				inputEle.value = `003b48322659ff3be45f33135f9f46dc6edcf6e911100dfd925299c6b79e26f2`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `remark`;
				inputEle.type = 'hidden';
				inputEle.value = ``
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `shipFee`;
				inputEle.type = 'hidden';
				inputEle.value = `1.00`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `merchant_id`;
				inputEle.type = 'hidden';
				inputEle.value = `701001`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `shipCountry`;
				inputEle.type = 'hidden';
				inputEle.value = `CN`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `quote_price`;
				inputEle.type = 'hidden';
				inputEle.value = ``
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `paymentToken`;
				inputEle.type = 'hidden';
				inputEle.value = ``
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `billing_postal_code`;
				inputEle.type = 'hidden';
				inputEle.value = `56376`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `source_notify_url`;
				inputEle.type = 'hidden';
				inputEle.value = `https://test-api.star-saas.com/v1/pages/NotifyResult.jsp`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `orderAmount`;
				inputEle.type = 'hidden';
				inputEle.value = `10.36`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `delivery_firstname`;
				inputEle.type = 'hidden';
				inputEle.value = `Li`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `billing_state`;
				inputEle.type = 'hidden';
				inputEle.value = `FJ`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `return_url`;
				inputEle.type = 'hidden';
				inputEle.value = `https://test-api.star-saas.com/v1/pages/PayResult.jsp`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `currency`;
				inputEle.type = 'hidden';
				inputEle.value = `USD`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `merSendLogoNo`;
				inputEle.type = 'hidden';
				inputEle.value = `1`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `verify_billing_address`;
				inputEle.type = 'hidden';
				inputEle.value = `YES`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `returnUrl`;
				inputEle.type = 'hidden';
				inputEle.value = `https://test-api.star-saas.com/v1/pages/PayResult.jsp`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `first_name`;
				inputEle.type = 'hidden';
				inputEle.value = `Milton`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `email`;
				inputEle.type = 'hidden';
				inputEle.value = `apidog@gmail.com`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `delivery_lastname`;
				inputEle.type = 'hidden';
				inputEle.value = `Han`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `delivery_country`;
				inputEle.type = 'hidden';
				inputEle.value = `CN`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `shipCity`;
				inputEle.type = 'hidden';
				inputEle.value = `Xiamen`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `amount`;
				inputEle.type = 'hidden';
				inputEle.value = `10.36`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `platform_source`;
				inputEle.type = 'hidden';
				inputEle.value = `Shopify`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `shopperLevel`;
				inputEle.type = 'hidden';
				inputEle.value = `1`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `address`;
				inputEle.type = 'hidden';
				inputEle.value = `3610  Brighton Circle Road`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `logo_name`;
				inputEle.type = 'hidden';
				inputEle.value = `1`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `gatewayNo`;
				inputEle.type = 'hidden';
				inputEle.value = `701001021`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `shopperId`;
				inputEle.type = 'hidden';
				inputEle.value = `apidog1`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `custom`;
				inputEle.type = 'hidden';
				inputEle.value = ``
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `billing_country`;
				inputEle.type = 'hidden';
				inputEle.value = `CN`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `cardType`;
				inputEle.type = 'hidden';
				inputEle.value = ``
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `last_name`;
				inputEle.type = 'hidden';
				inputEle.value = `Braganza`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `card_type`;
				inputEle.type = 'hidden';
				inputEle.value = ``
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `notify_url`;
				inputEle.type = 'hidden';
				inputEle.value = `https://test-api.star-saas.com/v1/pages/NotifyResult.jsp`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `token`;
				inputEle.type = 'hidden';
				inputEle.value = `NO`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `shipAddress`;
				inputEle.type = 'hidden';
				inputEle.value = `3610  Brighton Circle Road`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `shopper_level`;
				inputEle.type = 'hidden';
				inputEle.value = `1`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `cancelUrl`;
				inputEle.type = 'hidden';
				inputEle.value = `https://test-api.star-saas.com/v1/pages/PayResult.jsp`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `account_id`;
				inputEle.type = 'hidden';
				inputEle.value = `701001021`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `shipping_discount`;
				inputEle.type = 'hidden';
				inputEle.value = `1.00`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `token_flag`;
				inputEle.type = 'hidden';
				inputEle.value = `NO`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `isOpen3D`;
				inputEle.type = 'hidden';
				inputEle.value = `do3DS`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `shopper_id`;
				inputEle.type = 'hidden';
				inputEle.value = `apidog1`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `color_depth`;
				inputEle.type = 'hidden';
				inputEle.value = `24`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `handling`;
				inputEle.type = 'hidden';
				inputEle.value = `1.00`
				shoplazzElement.appendChild(inputEle);
			
				var inputEle = document.createElement('input');
				inputEle.name = `delivery_city`;
				inputEle.type = 'hidden';
				inputEle.value = `Xiamen`
				shoplazzElement.appendChild(inputEle);
			
			document.theForm.submit();
		}
	</script>
</body>

</html>

Request

Header Params
Content-Type
string 
required
Example:
application/x-www-form-urlencoded
Body Params application/xml
merchant_id
string 
required
Merchant Code or Merchant ID or Merchant Number
<= 7 characters
Example:
701001
account_id
string 
required
Subaccount Code or Subaccount ID or Gateway Number
<= 10 characters
Example:
701001010
order_no
string 
required
Order number defined by merchant
<= 50 characters
Example:
1726891254563
currency
string 
required
Order Currency Code. Please refer to ISO 4217
<= 3 characters
Example:
USD
amount
string 
required
The sum of the amounts of all items in an order; Value can be digits only. Please refer to ISO 4217 for decimal values of each currency
amount = item_total + shipping + handing + tax_total + insurance - shiopping_discount - discount
<= 15 characters
Example:
10.36
item_total
string 
optional
The subtotal for all items can not be a negative number.
<= 15 characters
Example:
10.00
shipping
string 
optional
The shipping fee for all items within the items parameter can not be a negative number.
<= 15 characters
Example:
1.00
handling
string 
optional
The handling fee for all items within the items parameter can not be a negative number.
<= 15 characters
Example:
1.00
tax_total
string 
optional
The total tax for all items within the items parameter can not be a negative number.
<= 15 characters
Example:
1.00
insurance
string 
optional
The insurance fee for all items within the items parameter can not be a negative number.
<= 15 characters
Example:
1.00
shipping_discount
string 
optional
The shipping discount for all items within the items parameter can not be a negative number.
<= 15 characters
Example:
1.00
discount
string 
optional
The discount for all items within the items parameter can not be a negative number.
<= 15 characters
Example:
1.00
items
string 
required
Items information, including item name, ID, unit price, and quantity Please refer to Items Information
<= 5000 characters
Example:
huawei#,#NUM1#,#230.00#,#1#;#Test2#,#NUM2#,#290.00#,#2
note
string 
optional
Additional information or comments for an order, customized by merchant.
<= 1000 characters
Example:
custom
string 
optional
Each custom parameter is separated by semicolons (;), and supports up to 5 custom parameters. The value of the parameter cannot contain semicolons and the length is less then 500 digits.
Example:
custom1;custom2;custom3;custom4;custom5
<= 2500 characters
Example:
card_type
string 
optional
Set card type by using this parameter
1: Visa
2: Master
3: JCB
4: AE
5: Diners
6: Maestro
<= 10 characters
payment_method
string 
required
payment method type. i.e. PAYPAL, MercadoPago, TransbankOneClick, etc
<= 50 characters
open3d
string 
optional
Open the 3DS
do3DS: try 3D
no3DS: non 3d
<= 10 characters
Example:
do3DS
token_flag
string 
optional
To indicate whether or not to tokenize the card information
YES: Tokenize the card information
NO: Do Not tokenize the card information
This parameter is required when Token is used
<= 10 characters
Example:
NO
shopper_id
string 
required
The ID which is allocated or created by Merchant to specify the shopper
<= 64 characters
Example:
apidog1
shopper_email
string 
required
Shopper’s email address
<= 100 characters
Example:
apidog@gmail.com
shopper_phone
string 
optional
Shopper's phone number, CODI Required
<= 50 characters
Example:
13012345678
shopper_level
string 
optional
Shopper tiers defined by merchants
<= 50 characters
Example:
1
default_lang
string 
optional
Set language for payment page; If the value is null then the language will be the browser language
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
logo_name
string 
optional
Merchant Logo Number
<= 2 characters
first_name
string 
required
First name of cardholder
<= 100 characters
Example:
Milton
last_name
string 
required
Last name of cardholder
<= 100 characters
Example:
Braganza
billing_country
string 
optional
2 digits ISO Country Code; Refer to ISO 3166-2 country code
This parameter is required for tangible goods
<= 2 characters
Example:
CN
billing_city
string 
optional
City in the billing address
This parameter is required for tangible goods
<= 100 characters
Example:
Xiamen
billing_state
string 
optional
State in the billing address
This parameter is required for tangible goods and when the country is United States or Canada
<= 100 characters
Example:
FJ
billing_address
string 
optional
Street address in the billing address
This parameter is required for tangible goods
<= 300 characters
Example:
3610 Brighton Circle Road
billing_postal_code
string 
optional
Street address in the billing address
This parameter is required for tangible goods
<= 100 characters
Example:
56376
delivery_firstname
string 
optional
First name of consignee
<= 100 characters
Example:
Li
delivery_lastname
string 
optional
Last name of consignee
<= 100 characters
Example:
Han
delivery_country
string 
optional
2 digits ISO Country Code of the country in the delivery address (i.e. United States should be in the form of US)
<= 100 characters
Example:
CN
delivery_state
string 
optional
State in the delivery address This parameter is required for tangible goods and when the country is United States or Canada
<= 100 characters
Example:
FJ
delivery_city
string 
optional
City in the delivery address
<= 100 characters
Example:
Xiamen
delivery_address
string 
optional
Street address of consignee
<= 300 characters
Example:
3610 Brighton Circle Road
delivery_postal_code
string 
optional
Postal or zip code in the delivery address
This parameter is required for tangible goods and when the country is United States or Canada
<= 100 characters
Example:
56376
return_url
string 
required
Real-time return URL defined by merchant for complete payment
<= 500 characters
notify_url
string 
required
The merchant customized URL address where the payment notification will be sent to
<= 500 characters
Example:
{{webUrl}}/v1/pages/NotifyResult.jsp
cancel_url
string 
required
Real-time return URL defined by merchant for canceled payment
<= 500 characters
verify_billing_address
string 
optional
<= 10 characters
encryption_data
string 
required
Digital signatures information
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:
{{sign}}
platform_source
string 
optional
Name of ecommerce platform that your website used.
Acceptable Value: Magento, Shopify, Shoplazza, Shopyy, Shopline, WooCommerce, Zencart, SAAS
<= 30 characters
Example:
Shopify
device_type
string 
optional
Devices used when payment is processed/made. Acceptable Value: PC, Mobile
<= 20 characters
Example:
PC
price_id
string 
optional
The price id the customer is subscribed to.
<= 50 characters
Example:
quote_id
string 
optional
The ID of the quote
<= 50 characters
quote_price
string 
optional
The price of the quote
<= 15 characters
color_depth
string 
optional
Get the color depth of the screen of the client, which is obtained from screen.colorDepth
<= 50 characters
Example:
test
storefront_domains
string 
optional
The storefront domains of the e-commerce platform that the website used
<= 200 characters
subscription
object 
optional
A container for the type of a subscription contract
contract
string 
required
The type of recurring contract to be used. Possible values:
RECURRING – Payment details can be used without the card security code to initiate card-not-present transactions.
INSTALMENT – for instalment payment plans
<= 20 characters
contract_name
string 
required
A descriptive name for this contract.
<= 200 characters
contract_amount
string 
required
Subscription standard price, if there is no disoount program (without any promotional in which this will be the amount ol the subscription transsction)
<= 15 characters
interval
enum<string> 
required
Specifies billing frequency. Either day, week, month or year.
Allowed values:
day
week
month
<= 20 characters
Allowed values:
daymonthyear
interval_count
string 
required
The number of intervals between contract billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
<= 50 characters
billing_cycle
integer 
required
The total number of billing cycles of the subscription.
For example, the subscription will last for 1 year if billing_cycles=12, interval_count=1 and interval=MONTH.
The subscription will continue indefinitely if billing_cycles is 0.
promotion_cycle
integer 
optional
The rumber of discount periods must be provided for the promotional program. It will be associsied wth interval, e.g, promotion cydes=3, interval=month means the dscount perod is 3 months
contract_start
string 
required
(if specified) Start of the current period that the subscription has been invoiced for. The format "YYYY-MM-DD HH:MM:SS". For example, "2024-12-03 14:30:45" .
<= 20 characters
contract_end
string 
required
(if specified) End of the current period that the subscription has been invoiced for. The format "YYYY-MM-DD HH:MM:SS". For example, "2024-12-03 14:30:45" .
<= 20 characters
price_id
string 
required
The price_id will be used to enable the created subscription plan.
<= 50 characters
Examples

Responses

🟢200OK
application/xml
Body
merchant_id
string 
optional
Merchant Code or Merchant ID or Merchant Number
<= 7 characters
account_id
string 
optional
Subaccount Code or Subaccount ID or Gateway Number
<= 10 characters
transaction_id
string 
optional
Transaction ID generated by gateway system, the Transaction ID = Order No + '-' + 5 digits random number
<= 64 characters
order_no
string 
optional
Merchant Order Number (or Merchant Order ID) generated by Merchant
<= 50 characters
currency
string 
optional
Order Currency Code. Please refer to ISO 4217
<= 3 characters
amount
string 
optional
The sum of the amounts of all items in an order; Value can be digits only. Please refer to ISO 4217 for decimal values of each currency
amount = item_total + shipping + handing + tax_total + insurance - shiopping_discount - discount
<= 15 characters
card
string 
optional
Masked card number
<= 20 characters
threeds_result
string 
optional
3DS Verification Result:
--Cardholder authenticated
---Failed
---Authentication offered but not used
---Unable to Complete Authentication
<= 100 characters
order_status
string 
optional
Order Status:
-3: Payment canceled by shopper
-2: Waiting for review
-1: Waiting for process
0: Failed
1: Succeed
<= 10 characters
result_info
string 
optional
Payment result information in the form of “Code + Details”. Please refer to Appendix: Error Code
<= 200 characters
payment_method
string 
optional
Payment method
<= 50 characters
return_type
string 
optional
1: Real-time return from the browser
2: Real-time return from the server
3: Asynchronous return from the server
<= 10 characters
note
string 
optional
Same value as in the request parameter
<= 1000 characters
first_name
string 
optional
First name of cardholder
<= 1000 characters
last_name
string 
optional
Last name of cardholder
<= 50 characters
billing_address
string 
optional
Return billing address if payment is success
-Returl Null if payment is failed
<= 50 characters
billing_city
string 
optional
City in billing address
<= 100 characters
billing_state
string 
optional
State in billing address
<= 100 characters
billing_country
string 
optional
2 digits Country Code of the country in billing address
<= 2 characters
billing_postal_code
string 
optional
Zip code in billing address
<= 100 characters
billing_phone
string 
optional
Shopper’s phone number
<= 50 characters
billing_email
string 
optional
Shopper’s email address
<= 100 characters
connector
string 
optional
Connector names such as Acquirers, PSPs or Banks
<= 50 characters
contract_name
string 
optional
A descriptive name for this contract.
<= 2000 characters
recurring_id
string 
optional
The recurring ID is a unique identifier assigned to each subscription.
<= 50 characters
recurring_deduction_period
integer 
optional
The deduction period refers to which installment or billing cycle the current deduction falls under for the subscription.
recurring_deduction_time
string 
optional
The deduction time refers to the specific date and time when the payment for the subscription is processed. The format "YYYY-MM-DD HH:MM:SS". For example, "2024-12-03 14:30:45" .
<= 20 characters
encryption_data
string 
optional
Digital signatures information
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
🟠404Record not found
🟠400Invalid input
Previous
Create a direct payment
Next
Capture a transaction