Checkout Page (E-com)

How to use Luxtak Checkoutpage to submit a payin.

post

https://gateway-test.luxtak.com/trade/create

Payin by using Luxtak checkout page

This endpoint allows you to submit a payin by using Luxtak checkout page

Parameters

NameTypeDescription
Content-Type*stringapplication/json; chartset=UTF-8
Authorization*stringBasic Base($app_id:$security_key)

Body

NameTypeDescription
app_id*stringcreated app's id at dashboard
- Max. 32 chars -
timestamp*stringyyyy-MM-dd HH:mm:ss - Max. 19 chars -
out_trade_no*stringID given by the merchant in their system - Max. 64 chars -
methodstringAdd this object to show only the selected method. For instance, “method”: “PIX” will only show the PIX method. To show all the methods do not add this object in the request body. Check here for all methods
channelstringonly use when method = Wallet
order_currency*stringorder currency - Max. 3 chars - Check here for all methods.
order_amount*stringorder amount - 0.01 ~ 999999999 -
(refer to amount limit for different methods)
subject*stringpayment reason or item title
- Max. 128 chars -
content*stringpayment reason detail or item detail. This will be shown on the bank bill.
- Max. 255 chars -
trade_type*stringfixed value: WEB
version*stringfixed value: 2.0
timeout_expressstringm(minutes), h(hours), d(days), c(always end in current day).
Used to control the expiration time of submitting an order (from initial to processing). (90m in default, max 15d)
notify_url*stringWhere Luxtak will send notification to
return_urlstringweb redirect url when payment is finish
buyer_id*stringmerchant user's id
customer.name*stringUser's name
customer.email*stringUser's email
customer.phone*stringUser's phone
customer.identify.number*stringUser's identification number
customer.identify.type*stringUser's identification type
- check here to check identify type for different countries -
address.postal_code*stringzip code
address.country*stringcountry
address.state*stringstate
address.city*stringcity
address.street*stringstreet
address.street_number*stringstreet number
address.neighborhood*stringneighborhood
billing.name*stringbilling name
billing.email*stringbilling email
billing.phone*stringbilling phone
billing.address.postal_code*stringbilling zip code
billing.address.country*stringbilling country
billing.address.state*stringbilling state
billing.address.city*stringbilling city
billing.address.street*stringbilling street
billing.address.street_number*stringbilling street number
billing.address.neighborhood*stringbilling neighborhood
billing.identification.number*stringbilling identify number
billing.identification.type*stringbilling identify type
shipping.name*stringshipping name
shipping.email*stringshipping email
shipping.phone*stringshipping phone
shipping.address.postal_code*stringshipping zip code
shipping.address.country*stringshipping country
shipping.address.state*stringshipping state
shipping.address.city*stringshipping city
shipping.address.street*stringshipping street
shipping.address.street_number*stringshipping street number
shipping.address.neiborhood*stringshipping neighborhood
shipping.identification.number*stringshipping identify number
shipping.idenification.type*stringshipping identify type
products.quanity*stringproduct quantity
products.name*stringproduct name - Max. 200 chars -
products.url*stringproduct url - Max. 2000 chars -
products.description*stringproduct description - Max. 1000 chars -

Responses

200submit successfully
{
    "code": "10000",
    "msg": "Success",
    "trade_no": "2022010110293900083",
    "out_trade_no": "202201010354003",
    "web_url": "http://checkout-testv2.luxtak.com?prepay_id=123456",
    "prepay_id":"123456"
}
400duplicate out_trade_no
{
    "code": "40002",
    "msg": "Business Failed",
    "sub_code": "duplicate-out_trade_no",
    "sub_msg": "out_trade_no is duplicate"
}

Example

curl --location --request POST 'https://gateway-test.luxtak.com/trade/create' \
--header 'Authorization: Basic MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
      "charset": "UTF-8",
    * "app_id": "162************38",
    * "out_trade_no": "202201010354002",
    * "order_currency": "BRL",
    * "order_amount": "12.01",
    * "subject": "item name",
    * "content": "20 item description",
    * "trade_type": "WEB",
      "timeout_express": "15d",
    * "timestamp": "2022-01-01 03:54:01",
    * "notify_url": "http://merchant/callback/success",
    * "buyer_id": "buyer_0101_0001",
    * "version": "2.0",
    * "customer" : {
    *     "identification": {
    *         "type": "CPF",
    *         "number": "50284414001"
        },
    *     "name": "customer user name",
    *     "email": "test@gmail.com",
    *     "phone": "5511987654321",
    *  "buyer_id": "buyer_0101_0001",
        "ip": "127.0.0.1"
      },
    * "address":{
    *           "postal_code":"38082365",
    *            "country":"address test country",
    *            "state":"address state123",
    *            "city":"address city123",
    *            "street":"address streetqqq",
    *            "street_number":"4567",
    *            "neighborhood":"neighbor address222"
       },
    * "billing": {
    *     "address": {
    *            "postal_code":"38082365",
    *            "country":"billingtest country001",
    *            "state":"billingstate123",
    *            "city":"billingcity123",
    *            "street":"billingstreetqqq",
    *            "street_number":"22222",
    *            "neighborhood":"billingneighborhood222"
          },
    *     "identification": {
    *         "type": "cpf",
    *         "number": "50284414727"
        },
    *     "email": "email@test.com",
    *     "name": "test",
    *     "phone": "5511987654321"
      },
    * "shipping": {
    *     "address": {
    *            "postal_code":"38082365",
    *            "country":"Brazil",
    *            "state":"shipping state123",
    *            "city":"shipping city123",
    *            "street":"shipping streetqqq",
    *            "street_number":"4567",
    *            "neighborhood":"shipping hood222"
          },
    *     "identification": {
    *         "type": "cpf",
    *         "number": "50284414727"
          },
    *     "email": "email@test.com",
    *     "name": "test",
    *     "phone": "5511987654321"
      },
    * "products": [
          {
    *         "quantity": "1",
    *         "name": "product 1",
    *         "url": "https://www.luxtak.com/product/1",
    *         "description": "this is a product"
          },
          {
           "quantity": "1",
           "name": "product 2",
           "url": "https://www.luxtak.com/product/2",
           "description": "this is a product"
          },
          {
           "quantity": "3",
           "name": "product 3",
           "url": "https://www.luxtak.com/product/3",
           "description": "this is a product"
        },
        {
           "quantity": "4",
            "name": "product 4",
            "url": "https://www.luxtak.com/product/4",
            "description": "this is a product"
        }
    ]
}'

Warning

Return _url is not required in the request parameters. However if needed, you can overwrite it by appending the return__url after the web_url when redirect. http://checkout.luxtak.com?prepay_id={$prepay_id} ↓↓↓ http://checkout.luxtak.com?prepay_id={$prepay_id}&return_url=encodeURIComponent({$return_url})

Tips

Note: 162********38 is luxtak's test app id for sandbox, and MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ== is authorization token associated with the test app id.

Warning

Please use your own app_id and generate your own authorization token when testing.