Volumedocs

Get an invoice

GET
/v1/invoices/{invoice_id}

The invoice, its status, and every transfer that paid towards it.

Authorization

ApiKey
AuthorizationBearer <token>

A merchant API key, sent as Authorization: Bearer vk_live_…. The prefix selects the mode: vk_test_ for testnets, vk_live_ for real money.

In: header

Path Parameters

invoice_id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/invoices/string"
{  "object": "invoice",  "id": "string",  "livemode": true,  "status": "open",  "amount": "string",  "currency": "usd",  "description": "string",  "customer": "string",  "customer_email": "string",  "metadata": {    "property1": "string",    "property2": "string"  },  "payments": [    {      "object": "payment",      "id": "string",      "checkout_session": "string",      "asset": "USDT",      "network": "tron",      "amount": "string",      "status": "detected",      "tx_hash": "string",      "detected_at": "2019-08-24T14:15:22Z",      "confirmed_at": "2019-08-24T14:15:22Z"    }  ],  "paid_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z"}