WoyraDocs
Get an API key

One top-up

GET/v1/topups/{id}

Billing · Requires an API key

By Woyra's id, or by the provider's checkout session id, which is what the return URL carries. The console asks this on return to learn whether the money has landed yet. Requires billing:read.

Parameters

NameInDescription
idrequiredpath

Example

curl https://api.woyra.io/v1/topups/email_01J... \
  -H "Authorization: Bearer $WOYRA_KEY"

Response

200 The top-up.

FieldTypeDescription
objectstring
One of topup.
idstring
statusstring
One of pending, paid, expired, failed.
providerstring
urlstringWhere to pay. Present while pending.
amount_microsinteger
currencystring
referencestringThe provider's payment reference once paid; also on the ledger line.
created_attimestamp
paid_attimestamp

Errors

StatusCodes
404not_found, product_not_offered

Also in Billing