List Checkouts
https://sandboxapi.bitnob.co/api/v1/checkout (opens in a new tab)
Query Params
| Parameter | type | Required |
|---|---|---|
| order | string | Defaults to ASC |
| page | string | take |
| period | string | Defaults to allTime |
| q | string |
Request
Hosted checkout/List Checkouts [GET]
curl --request GET \
--url 'https://sandboxapi.bitnob.co/api/v1/checkout?order=ASC&period=allTime' \
--header 'Authorization: Bearer API-KEY' \
--header 'accept: application/json'Response
🟢 200 OK
{
"status": true,
"message": "successfully fetched all checkouts",
"data": {
"checkouts": [
{
"id": "0fe33b67-7b1b-4e52-8304-6f56c8e6f546",
"createdAt": "2022-01-25T11:02:10.513Z",
"updatedAt": "2022-01-25T11:02:10.513Z",
"reference": "checkoutref",
"satAmount": "1000",
"satAmountPaid": "0",
"description": "string",
"currency": "btc",
"status": "unpaid",
"expiresAt": "2022-01-26T11:02:10.509Z",
"lightningExpiresAt": "2022-01-25T14:02:10.000Z",
"callbackUrl": "https://string.com",
"successUrl": "https://string.com",
"btcAmount": "0.00001000",
"amount": "0.36"
},
{
"id": "556dbd30-39bc-4ad1-91b9-3fd46b81c831",
"createdAt": "2022-01-21T14:12:22.172Z",
"updatedAt": "2022-01-21T14:12:22.172Z",
"reference": "string",
"satAmount": "200",
"satAmountPaid": "0",
"description": "string",
"currency": "btc",
"status": "unpaid",
"expiresAt": "2022-01-22T14:12:22.161Z",
"lightningExpiresAt": "2022-01-21T17:12:21.000Z",
"callbackUrl": "https://string",
"successUrl": "htpps://string",
"btcAmount": "0.00000200",
"amount": "0.07"
}
],
"meta": {
"page": 1,
"take": 10,
"itemCount": 2,
"pageCount": 1,
"hasPreviousPage": false,
"hasNextPage": false
}
}
}