LogoLogo
StartAPI EndpointPayments API
Payments API
Payments API
  • Getting Started
  • Managing Terminals
  • API Reference
    • Verify Credentials
    • QuickPay SDK
    • Payments API
      • Create eCommerce Payment
      • Create Point of Sale Payment
      • Create Point of Sale Payment (ON)
      • Redirect Examples
      • Postback Examples
      • Get Payment
        • Underpaid Examples
        • Overpaid Examples
        • Full paid Examples
      • Get Point of Sale Payment
      • Payment State Change
      • Payment Price Update
      • Payment Unconfirmed Update
      • Payment Status List
    • Request Refund
Powered by GitBook
On this page
  • Create a Point of Sale Payment
  • Example
  1. API Reference
  2. Payments API

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

hash*

String

MD5 Hash

{
  "status": "nok",
  "error": "The asset not allow for POS create payment"
}
{
    "status": "ok",
    "message": "Create POS Payment Successfully",
    "paymentId": "61af3e476cb0b9603d21f3e6",
    "payment_code": "1cJauhjK3n",
    "payment_address": "2MxajxTWeGm3zYvLvD8rDuD3rgjXCsW4wz6",
    "payment_amount": "0.00039304",
    "payment_amount_asset": "BTC",
    "exchange_rate": "50885.41",
    "payment_payreq": "lntb393040n1ps670jgpp5zv26tw8n2jf52nryltlmkwegf746jnf6qfxusnm0trk3m86ryr2sdpvx9355ct4dp4ykvmwyqkjq3r9d4hjqstrvdjhqarfveuscqzpgxqzjhsp5rca29tttet8h52d73uysf68jzxuxty0jc326krett5mjp2fsd3jq9qyyssqydtsrz508f9lcla0c8zvz98prsjpreh6xzvc5rr6zt6zrtt8ffs4j3kwmp9eaau4l2swekpfvqk0ajwmzamafzlpf3cal4mwrz336fgqftxytm",
    "expires_at": 1638875295
}

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.

PreviousCreate eCommerce PaymentNextCreate Point of Sale Payment (ON)

Last updated 3 years ago

key+asset+amount+

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 that is sent to your specified postback_url at the expiry time.

postback price update response
Terminal API ID
api_secret