Solverr

Invoices

Get an invoice

Returns one invoice with its status, flags and receipt URL. Rate limit: 1200 per minute per API key, counted separately from other endpoints.

GET
/api/v1/invoices/{id}

Authorization

bearerAuth
headerAuthorizationBearer <token>

A live API key, sk_live_ followed by 32 base58 characters.

Path Parameters

id*string

Invoice id, starting with inv_.

Response Body

The invoice.

application/json
  1. response
id*string
object*string
mode*Mode

Always live on the objects your API key creates and reads. Only demo store invoices, seen through the public checkout endpoints, are test.

Value in"live""test"
status*InvoiceStatus
Value in"created""awaiting_payment""detected""processing""paid""underpaid""refunded""failed""expired"
amount*string

Decimal string with 2 decimals.

currency*Currency
Value in"USD""EUR""INR"
order_id*string|null
description*string|null
customer_email*|

Where the receipt is sent. When you created the invoice without one, anyone with the checkout link can enter it on the checkout page, so it is not a verified identity of the customer.

redirect_url*string|null
metadata*
settlement*

The coin and amount the business receives.

late*boolean

True when the payment arrived on a deposit address that was already replaced or expired.

extra_payment*boolean

True when a second payment also succeeded for this invoice.

checkout_url*string

The hosted checkout page for this invoice.

Formaturi
receipt_url*|

The public receipt page, once the invoice is paid.

Formaturi
redeemed_at*|

When the payment was used with POST /api/v1/invoices/{id}/redeem; a used payment cannot be redeemed again.

Formatdate-time
expires_at*string
Formatdate-time
created_at*string
Formatdate-time
Example Request
curl -X GET 'https://example.com/api/v1/invoices/string'
Example Response
{  "id": "inv_7h3K9dWq2LmN4pRt6vXy",  "object": "invoice",  "mode": "live",  "status": "created",  "amount": "string",  "currency": "USD",  "order_id": "string",  "description": "string",  "customer_email": "string",  "redirect_url": "string",  "metadata": {    "property1": "string",    "property2": "string"  },  "settlement": {    "asset_id": "string",    "symbol": "string",    "blockchain": "string",    "amount": "string",    "amount_base": "string"  },  "late": true,  "extra_payment": true,  "checkout_url": "http://example.com",  "receipt_url": "http://example.com",  "redeemed_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z"}