Skip to main content
GET
/
checkouts
/
{checkout_id}
Get a checkout
curl --request GET \
  --url https://api.billing.io/v1/checkouts/{checkout_id} \
  --header 'Authorization: Bearer <token>'
{
  "checkout_id": "co_1a2b3c4d5e",
  "deposit_address": "<string>",
  "amount_usd": 123,
  "amount_atomic": "49990000",
  "tx_hash": "<string>",
  "confirmations": 123,
  "required_confirmations": 19,
  "expires_at": "2023-11-07T05:31:56Z",
  "detected_at": "2023-11-07T05:31:56Z",
  "confirmed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "metadata": {}
}
Retrieve full details for a specific checkout by ID. 
curl https://api.billing.io/v1/checkouts/co_a1b2c3d4e5f6a7b8c9d0e1f2 \
  -H "Authorization: Bearer $BILLING_API_KEY"

Authorizations

​
Authorization
string
header
required

Use your secret API key as a Bearer token. Keys are prefixed: sk_live_ (production) or sk_test_ (sandbox).

Path Parameters

​
checkout_id
string
required

The checkout identifier (prefixed co_)

Response

Checkout details

​
checkout_id
string

Unique identifier (prefixed co_)

Example:

"co_1a2b3c4d5e"

​
deposit_address
string

Blockchain address to send funds to

​
chain
enum<string>

Blockchain network

Available options:
tron,
arbitrum
​
token
enum<string>

Stablecoin token

Available options:
USDT,
USDC
​
amount_usd
number<double>

Original USD amount

​
amount_atomic
string

Token amount in smallest unit (string to avoid precision loss)

Example:

"49990000"

​
status
enum<string>
  • pending — Waiting for payment
  • detected — Transaction seen on-chain, unconfirmed
  • confirming — Confirmations in progress
  • confirmed — Payment fully confirmed (terminal)
  • expired — Checkout TTL exceeded without payment (terminal)
  • failed — Unrecoverable error (terminal)
Available options:
pending,
detected,
confirming,
confirmed,
expired,
failed
​
tx_hash
string | null

On-chain transaction hash (null until detected)

​
confirmations
integer

Current confirmation count

​
required_confirmations
integer

Confirmations needed for this chain

Example:

19

​
expires_at
string<date-time>
​
detected_at
string<date-time> | null
​
confirmed_at
string<date-time> | null
​
created_at
string<date-time>
​
metadata
object