One top-up
GET/v1/topups/{id}
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
| Name | In | Description |
|---|---|---|
| idrequired | path |
Example
curl https://api.woyra.io/v1/topups/email_01J... \
-H "Authorization: Bearer $WOYRA_KEY"Response
200 The top-up.
| Field | Type | Description |
|---|---|---|
| object | string | One of topup. |
| id | string | |
| status | string | One of pending, paid, expired, failed. |
| provider | string | |
| url | string | Where to pay. Present while pending. |
| amount_micros | integer | |
| currency | string | |
| reference | string | The provider's payment reference once paid; also on the ledger line. |
| created_at | timestamp | |
| paid_at | timestamp |
Errors
| Status | Codes |
|---|---|
| 404 | not_found, product_not_offered |
Also in Billing
- POST /v1/topups — Add funds by card
- POST /v1/subscriptions — Start a product subscription
- GET /v1/subscriptions/{product} — Current product subscription
- POST /v1/payments/stripe/webhook — Stripe's webhook
- GET /v1/ledger — The account statement
- GET /v1/billing/payment_options — How this account can pay
- PUT /v1/billing/payment_currency — Choose to pay in birr or in US dollars
- GET /v1/billing/bank_deposits — Recent birr bank deposits
- POST /v1/billing/bank_deposits — Request a birr bank deposit
- POST /v1/billing/bank_deposits/{id}/receipt — Upload the bank receipt for a deposit
- POST /v1/billing/bank_deposits/{id}/cancel — Cancel a deposit that has not been submitted or was returned
- GET /v1/balance — Retrieve account balance
- GET /v1/billing/email_tariff — The email price this account pays
- GET /v1/billing/email_subscription — This account's monthly email plan
- PUT /v1/billing/email_subscription — Take an email plan, or change it
- POST /v1/billing/email_subscription/cancel — Stop the email plan renewing
- GET /v1/pricing/email — The published email tariff