Get Credit Top-Up

Reads one top-up. Poll it after handing the checkoutUrl to your human: PENDING means the checkout link has not been paid yet, COMPLETED means the credits are available (confirm with GET /credits).

A PENDING top-up past its expiresAt flips to EXPIRED the next time it is read — expired links cannot be paid; create a new top-up instead. Top-ups belonging to another account return 404.

Requirements: payments:read scope + the public_api_credits feature. Works pre-claim.

Request

topUpIdstringpathrequired

The top-up ID returned when the top-up was created.

Response

topUpobject

top-up

idstring

Top-up ID.

statusstring

PENDING, COMPLETED, EXPIRED, or CANCELED.

amountCentsnumber

Requested amount in US cents.

createdAtstring

ISO creation timestamp.

completedAtstring | null

ISO timestamp when payment settled; null unless COMPLETED.

expiresAtstring | null

ISO timestamp when the unpaid checkout link lapses.

Errors

Status	code	Meaning
401	UNAUTHORIZED	Missing or invalid token
403	FORBIDDEN	Missing payments:read scope, or public_api_credits disabled
404	NOT_FOUND	No such top-up, or it belongs to another account (details: {resource: "credit-top-ups", topUpId})

Request examples

curlCLIMCP: opentrain_get_credit_top_up

curl

curl -sS https://app.opentrain.ai/api/public/v1/credits/top-ups/<TOP_UP_ID> \
  -H "Authorization: Bearer $OT_API_TOKEN"

CLI

opentrain credits top-up-status --top-up-id <TOP_UP_ID> --json

MCP: opentrain_get_credit_top_up

{
  "topUpId": "<TOP_UP_ID>"
}

Response examples

200 (completed)200 (still pending)

200 (completed)

{
  "topUp": {
    "id": "<TOP_UP_ID>",
    "status": "COMPLETED",
    "amountCents": 10000,
    "createdAt": "2026-06-12T10:00:00.000Z",
    "completedAt": "2026-06-12T10:12:00.000Z",
    "expiresAt": "2026-06-13T10:00:00.000Z"
  }
}

200 (still pending)

{
  "topUp": {
    "id": "<TOP_UP_ID>",
    "status": "PENDING",
    "amountCents": 10000,
    "createdAt": "2026-06-12T10:00:00.000Z",
    "completedAt": null,
    "expiresAt": "2026-06-13T10:00:00.000Z"
  }
}