Create an Invoice
Creates an invoice/bill for a user to pay with crypto
POST Request to {Endpoint}/createInvoice
Header Parameters
content-type
String
application/json
apikey
String
api-key provided by support
merchantID
String
User ID associated with merchant. provided by support
JSON Body Parameters
client.name
String
(Optional) Client's full name
client.email
String
(Optional) Client's email
client.phone
String
(Optional) Client's phone number, must include country code with plus sign. Ex: "+11234567890"
client.referenceID
String
(Optional) External Client ID to allow you to associate a user with your system.
amount
number
Amount in USD to be billed
description
String
(Optional) Description associated with payment
partialPaymentsEnabled
Boolean
(Optional) Allows spenders split the invoice, from 50% to 25%. False by default, which only allows full payment.
btcOnly
Boolean
If true, only Bitcoin will be an available payment option
JSON Body Example
{
"client": {
"name": "First Name",
"email": "[email protected]",
"phone": "+11234567890",
"referenceID": "abc123-123-abc"
},
"amount": 23.1,
"description": "This is an optional payment description to be displayed on the invoice. Max of 250 chars",
"partialPayments": true,
"btcOnly": true
}
Successful Response (Status 200)
Client's can make a payment by accessing the paymentURL
Last updated