Crypto Payments
Create Payment
Initiate crypto payment using this API endpoint:
Please note, to access this endpoint, please send the following header:
This endpoint overrides version 0.1 with breaking changes. If no version header is specified, version '0.1' will be used and you will receive an error.
Once all our partners move to this endpoint the old one will be deprecated and the default version will be '0.2'.
Example API call using curl:
Important: For security, the required email
field in the customer
object is the only email address to which refund instructions will be sent in the event of an overpaid, underpaid or invalid payment. Submit the customer's email only.
Note: Payment receipts issued via Issue a Receipt may be sent to any valid email address.
Example response:
The response contains:
trackingId
to associate this payment to incoming webhooks to your specified webhook URLDictionary of
paymentUrls
with links to the Hosted Payment Page. For now, onlyWeb
URLs are supported.
After receiving the response, the payment app should redirect the user to the Hosted Payment Page where the customer payment interaction will be handled. All payment updates will be sent to the specified webhook URL for this terminal.
If redirectUrl
is provided, the customer will be automatically redirected back to the specified link after completing payment at the Hosed Payment Page.
Possible values of paymentUrlType
:
Issue a Receipt
To send a receipt to a customer, use the following endpoint:
You may specify email, phone number or both when issuing a receipt to a customer.
If you wish to issue a receipt to the customer via other means, such as a print, it is required to provide the following information for the customer:
Receipt Field | Description |
---|---|
Date-time | e.g. 1 Jan 2024 1:23 PM |
Payment Code |
|
Status | e.g. Complete |
Total Price |
|
Exchange Rate | Exchange rate of payment crypto (e.g. 26,540.16 USD) |
Amount Due | The amount due in crypto (e.g. 0.003768 BTC) |
Amount Paid | Amount paid by customer in crypto, not including Network Cost (e.g. 0.003768 BTC) |
Refundable | Overpaid, Underpaid and Invalid only: the amount of crypto that will be refunded to the customer. |
Last updated