CoinPay
Invoices

Get invoice

Full invoice detail including deposit addresses (with accepted tokens), payments, and settlements. Webhook delivery history is omitted for API-key auth.

GET
/v1/invoices/{id}

Full invoice detail including deposit addresses (with accepted tokens), payments, and settlements. Webhook delivery history is omitted for API-key auth.

Authorization

bearerAuth
AuthorizationBearer <token>

Merchant API key (test_... or live_...)

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/invoices/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",  "environment": "test",  "status": "CREATED",  "token": "string",  "amount": "string",  "amountReceived": "string",  "referenceId": "string",  "metadata": {},  "successUrl": "string",  "cancelUrl": "string",  "chainId": "9e7fb22a-9e5b-420e-8fd7-e3454fcfd5fd",  "checkoutUrl": "http://example.com",  "expiresAt": "2019-08-24T14:15:22Z",  "underpaidTopUpExpiresAt": "2019-08-24T14:15:22Z",  "addresses": [    {      "chainId": "9e7fb22a-9e5b-420e-8fd7-e3454fcfd5fd",      "chainName": "string",      "family": "evm",      "networkId": 0,      "depositAddress": "string",      "tokens": [        {          "symbol": "string",          "contractAddress": "string",          "decimals": 0        }      ]    }  ],  "payments": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "chainId": "9e7fb22a-9e5b-420e-8fd7-e3454fcfd5fd",      "chainName": "string",      "txHash": "string",      "logIndex": 0,      "fromAddress": "string",      "amount": "string",      "cumulativeAmount": "string",      "status": "detected",      "detectedAt": "2019-08-24T14:15:22Z",      "finalizedAt": "2019-08-24T14:15:22Z",      "invalidatedAt": "2019-08-24T14:15:22Z",      "invalidatedReason": "string",      "explorerUrl": "string"    }  ],  "statusEvents": [    {}  ],  "settlements": [    {}  ],  "webhookDeliveries": [    {}  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}
{  "error": {    "code": "string",    "message": "string"  }}

Create invoice POST

Creates a new invoice and pre-computes deposit addresses for merchant-enabled chains in the API key's environment. Optionally pass `networkId` and/or `token` to lock the payment route; checkout then only shows the allowed choices. Prefer sending customers to `checkoutUrl` for payment.

Get invoice status GET

Lightweight status for polling.