Create Point of Sale Payment

Create a Point of Sale Payment for user with POS Terminals

The Point of Sale payments API is for creating payments from a POS Terminal and displaying the required information to the payee such as payment address and QR Code.

Create a Point of Sale Payment

POST /api/payment-pos/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 like to receive in the settlement asset

cart_items

Object

item_name,item_desc,item_quantity,unit_price (DVD1,Movie Name,1,80)

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

pos_price_update_postback_url

Strng

Price Update URL (posted at quote expiry)

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. +614123123123

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

{
  "status": "nok",
  "error": "The asset not allow for POS create payment"
}

Example

Create a Payment & Show Customer QR and Address

An example of how this API can be used is if a merchant would like to receive $50.00 USD and the customer would like to pay using their own Bitcoin balance. In this scenario, the merchant can request asset=USD and requested_asset=BTC.

This will result in a response containing a BTC payment address, amount of BTC required to complete the payment, the time until the price expires, and a price update request will be required or you can use the postback price update response that is sent to your specified postback_url at the expiry time.

Last updated