Create eCommerce Payment

Create eCommerce payments & deliver payment options to user

The ecommerce payments API is for creating a payment in the system that can be delivered to your customer separate from your site.

Create an Ecommerce Payment

POST /api/payment/post

Request Body

Name	Type	Description
asset*	String	The asset you would like to settle in your account
requested_asset	String	The asset you would like your customer to pay in
amount*	String	Amount you would like to receive in the settlement asset
cart_items*	Object	item_name,item_desc,item_quantity,unit_price (DVD1,Movie Name,1,80)
email*	String	Email of customer who will be doing the payment
description*	String	Description of Payment
reference*	String	Your payment reference
postback_url	String	After postback please return a response JSON { status: “ok” }. We will try 10 attempts until response received
redirect_url	String	URL user will be redirected to after complete or cancelled payment
exp	String	Hours until payment expired (1 = 1 hour)
personal_fname	String	Customer Firstname
personal_lname	String	Customer Lastname
personal_address	String	Street Address & Number
personal_city	String	Customer City
personal_state	String	Customer State
personal_country	String	Country, ISO 3166 2 digit code
personal_postcode	String	Postcode / ZIP code
personal_mobile	String	Customer's Mobile Number (incl. country code) e.g. [phone]
personal_dob	String	Customers Date of Birth YYYY/MM/DD
key*	String	Merchant's Terminal API ID
hash*	String	MD5 Hash key+asset+amount+api_secret
language	String	Payment Page and Customer Communication language. ISO-639-1 2 character. Default 'en'.
show_payment_html	String	Redirect to payment detail (true,false). Default false

200: OK Payment Create Failed with reason

{
  "status": "nok",
  "message": "Create Payment Failed!",
  "error": "Asset is required, Amount is required",
  "validated": false
}

201: Created Payment Successfully Created

{
    "status": "ok",
    "paymentId": "X8sjfaja8",
    "paymentShortId": "",
    "mobile_check_url": "",
    "payment_url": "<api-endpoint>/en/payment/detail/X8sjfaja8",
    "payment_address": ,
    "message": "Payment successfully created!" 
}

The API Endpoint can be used in multiple ways to deliver the payment page which is covered in the examples below.

Examples

Create a Payment & Custom Deliver

This is used when you would like to handle how the payment is delivered to your user.

The default response (show_payment_html=false or null) returns a JSON response with URLs that you can present to your customer any way you wish. QR code, SMS, email, or a payment button are common examples. If your account supports mobile payments you can present the mobile_check_url which will attempt to launch any installed mobile app for payment, otherwise, it will default the user to the payment page.

Create a Payment & Redirect User

To simplify your integration you can post to the endpoint from a form and with show_payment_html=true **** we will generate the payment and display the payment page on the fly.

Request Refund