Read invoice status
Read the owned top-up invoice status and local archive download
GET https://tokenlane.de/api/credits/topups/{id}/invoice
Authorizations
[ [ { "name": "Authorization", "description": "Organization management key: Authorization: Bearer sk-tl-v1-…. Existing sk-eu- keys remain valid. Required scopes are listed in x-scopes; gateway inference keys cannot authorize management operations.", "type": "http bearer", "location": "", "scopes": [] } ] ]
curl
curl --request GET \
--url 'https://tokenlane.de/api/credits/topups/top_01k7tm3w8vfz6b2r4m9q5xyz7c/invoice' \
--header 'Authorization: Bearer YOUR_API_KEY'
node
const response = await fetch("https://tokenlane.de/api/credits/topups/top_01k7tm3w8vfz6b2r4m9q5xyz7c/invoice", {
method: "GET",
headers: {
"Authorization": "Bearer " + process.env.TOKENLANE_API_KEY,
},
});
console.log(await response.text());
python
import os
import urllib.request
request = urllib.request.Request(
"https://tokenlane.de/api/credits/topups/top_01k7tm3w8vfz6b2r4m9q5xyz7c/invoice",
method="GET",
headers={
"Authorization": "Bearer " + os.environ["TOKENLANE_API_KEY"],
},
)
with urllib.request.urlopen(request) as response:
print(response.read().decode("utf-8"))
vercel
// This operation uses HTTP directly.
const response = await fetch("https://tokenlane.de/api/credits/topups/top_01k7tm3w8vfz6b2r4m9q5xyz7c/invoice", {
method: "GET",
headers: {
"Authorization": "Bearer " + process.env.TOKENLANE_API_KEY,
},
});
console.log(await response.text());
path: id (required)
Top-up ID
s21: string
Top-up ID
{}
"top_01k7tm3w8vfz6b2r4m9q5xyz7c"
Response 200: application/json
Request successful
{
"id": "YOUR_ID",
"topupId": "YOUR_TOPUPID",
"status": "not_requested",
"invoiceNumber": "YOUR_INVOICENUMBER",
"downloadUrl": "YOUR_DOWNLOADURL",
"archivedAt": "YOUR_ARCHIVEDAT",
"creditNotes": [
{
"amount": "5.00",
"currency": "EUR",
"reason": "refund",
"status": "pending",
"createdAt": "YOUR_CREATEDAT"
}
]
}
s30: object
{}
- id (required): s93
s93: string | null
Local immutable invoice identity as a cin_ TypeID
{}
- topupId (required): s35
s35: string
{}
- status (required): s94
s94: string
"not_requested", "pending", "waiting_profile", "creating", "needs_review", "archiving", "ready", "legacy"
{}
- invoiceNumber (required): s87
s87: string | null
{}
- downloadUrl (required): s87
- archivedAt (required): s87
- creditNotes (required): s95
s95: array
Credit notes owed for money returned on this payment, oldest first
{}
s161: object
{}
- amount (required): s181
s181: string
{}
"5.00"
- currency (required): s81
s81: string
"EUR"
{}
- reason (required): s182
s182: string
Refund through Tokenlane, refund in the Mollie dashboard, or chargeback
"refund", "external_refund", "chargeback"
{}
- status (required): s183
s183: string
pending: Tokenlane issues the credit note against this invoice; void: the return was reversed, no credit note is needed
"pending", "void"
{}
- createdAt (required): s35
Response 400: application/json
Bad request (validation error, invalid input)
{
"status": 400,
"code": "VALIDATION_ERROR",
"message": "Request validation failed"
}
s11: object
{}
- requestId (optional): s56
s56: string
Server correlation ID for an internal error. Also returned in X-Request-Id.
uuid
{}
- status (required): s57
s57: number
HTTP status code
{}
400
- code (required): s58
s58: string
Error code
{}
"VALIDATION_ERROR"
- message (required): s59
s59: string
Error message
{}
"Request validation failed"
- remedy_hint (optional): s60
s60: string
A safe, actionable remedy from the error catalog.
{}
- details (optional): s61
s61: array
Detailed validation errors
{}
s154: object
{}
- path (required): s179
s179: string
Field path
{}
"title"
- message (required): s180
s180: string
Field error message
{}
"Required"
Response 401: application/json
Authentication required (missing or invalid credentials)
{
"status": 400,
"code": "VALIDATION_ERROR",
"message": "Request validation failed"
}
Response 403: application/json
Insufficient scope (authenticated but not authorized) | This session can only access security setup until the required factor is verified
{
"status": 400,
"code": "VALIDATION_ERROR",
"message": "Request validation failed"
}
Response 404: application/json
Resource not found
{
"status": 400,
"code": "VALIDATION_ERROR",
"message": "Request validation failed"
}
Response 409: application/json
Conflict with the current state (e.g. a name that already exists)
{
"status": 400,
"code": "VALIDATION_ERROR",
"message": "Request validation failed"
}
Response 429: application/json
Retry after the indicated delay
{
"status": 400,
"code": "VALIDATION_ERROR",
"message": "Request validation failed"
}
Response 500: application/json
Internal server error
{
"status": 400,
"code": "VALIDATION_ERROR",
"message": "Request validation failed"
}
Response 503: application/json
Configured upstream timed out, failed or returned an invalid response
{
"status": 400,
"code": "VALIDATION_ERROR",
"message": "Request validation failed"
}