Get top-up status
GET
/v1/wallet/top-up/{reference}
Check the status of a top-up or redeem you started earlier, using the reference it returned. This is how an agent confirms credit has landed before resuming a batch that paused waiting on payment.
Authorizations
Bearer
JWT bearer token from POST /v1/auth/login.
Type
HTTP (bearer)
or
ApiKey
Scoped API key for non-interactive clients (issued by PBI #1426).
Type
API Key (header: X-Api-Key)
Parameters
Path Parameters
reference*
Type
Requiredstring
Responses
OK
application/json
An agent-facing view of a single top-up / redeem (#1429): the reference to poll, its lifecycle status,
and — once confirmed — how much landed and the resulting balance. A string? WalletTopUpView.CheckoutUrl is present
only when a payment provider needs the human to complete a hosted checkout (the manual / redeem paths
credit immediately, returning a confirmed view with no URL).
The amount the top-up/redeem is for, in USD.
Format
"double"Pattern
"^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"The wallet balance to show alongside (post-credit once confirmed).
Format
"double"Pattern
"^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"A hosted checkout link to hand to the human, or null when credit is immediate.
How much was credited once confirmed; null while pending/failed.
Format
"double"Pattern
"^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"For a pending crypto checkout, the deposit address the invoice resolved; otherwise null.
For a pending crypto checkout, the exact coin amount to send to string? WalletTopUpView.CryptoAddress; otherwise null.
For a pending crypto checkout, the coin the invoice resolved (e.g. BTC); otherwise null.
Currency code (always USD for now).
Default
"USD"A human-readable result the agent can surface.
Lowercase payment method: manual | card | crypto.
Opaque reference to poll this transaction via GET /v1/wallet/top-up/{reference}.
Lowercase lifecycle: confirmed | pending | failed | cancelled | expired.