Creating invoice
POST
/api/public/v1/invoices
This endpoint creates invoices.
Headers
Name | Value |
---|---|
Content-Type |
|
Authorization |
|
Request Body
Name | Type | Required | Description |
---|---|---|---|
data.type | string | Yes | Can only be |
data.attributes.amountBilled | string | Yes | Invoice amount to display to end users. Determines the amount due after conversion. |
data.attributes.billedCurrency | string | Yes | Invoice currency to display to end users. Determines the currency due after conversion. Refer to supported currencies. |
data.attributes.chargedCurrency | string | Yes | Crypto currency that customer must pay in. Refer to supported currencies. |
data.attributes.network | string | Yes | Payment network. Refer to supported networks. |
data.attributes.reference | string | No | The custom reference ID to tie the invoice to end-user who pays. This can be anything you choose. Must be a unique value for each invoice you create. |
data.attributes.successRedirectUrl | string | No | URL you want your customer to be redirected from our hosted page to if the invoice completes. |
data.attributes.unsuccessRedirectUrl | string | No | URL you want your customer to be redirected from our hosted page to if the invoice gets expired, cancelled or rejected. |
cURL
Response Body
Name | Type | Description |
---|---|---|
data.id | string | Invoice ID. |
data.type | string | Entity type returned. Always |
data.attributes | object | Set of invoice attributes. |
data.attributes.amountBilled | string | Invoice amount to display to end users. Determines the amount due after conversion. |
data.attributes.amountCharged | string | Amount due. Determines the amount of cryptucurrency the end-user is required to pay. |
data.attributes.billedCurrency | string | Invoice currency to display to end users. Determines the currency due after conversion. Refer to supported currencies. |
data.attributes.chargedCurrency | string | Crypto currency that customer must pay in. Refer to supported currencies. |
data.attributes.reference | string | The custom reference ID to tie the invoice to end-user who pays. This can be anything you choose. |
data.attributes.statusContext | string | Invoice status context. Refer to Invoice status flow. |
data.attributes.network | string | Network code. Refer to Supported currencies. |
data.attributes.networkName | string | Network name to display. |
data.attributes.status | string | Invoice status. Refer to Invoice status flow. |
data.attributes.successRedirectUrl | string | URL your customer will be redirected from our hosted page to if the invoice completes. |
data.attributes.unsuccessRedirectUrl | string | URL your customer will be redirected from our hosted page to if the invoice gets expired, cancelled or rejected. |
data.attributes.paymentStatus | string | Invoice payment status. Refer to Invoice status flow. |
data.attributes.exchangeRate | string | Invoice exchange rate valid for 20 minutes. |
data.attributes.expiresAt | string | Invoice expiry date and time. |
data.attributes.createdAt | string | Date and time invoice was created at. |
data.attributes.hostedPageUrl | string | Invoice hosted page. |
included.type(addresses).attributes | object | Invocie receiving address. This is the address the end-user must send their crytpocurrency payment to. |
Response
Last updated