PaybytokenDocs
Paybytoken Pay · Private beta
API reference · Paybytoken Pay

Consumer funding sessions

Start and track an exact-output Base ETH to USDC funding session.

Consumer funding endpoints are used only by Paybytoken-owned experiences with a consumer access token. They are not merchant API endpoints.

MethodEndpointPurpose
POST/consumer/v1/funding-sessionsLock an exact USDC amount and the consumer's Base deposit watch.
GET/consumer/v1/funding-sessions/activeResume the consumer's one active session after reload.
GET/consumer/v1/funding-sessions/:idRead settlement-derived funding status.
POST/consumer/v1/funding-sessions/:id/submitAttach the Base ETH transaction hash as diagnostic evidence.

Creation requires an Idempotency-Key. If the consumer's persistent address is not ready, the API returns 202 with consumer_funding_setup; retry after Retry-After using the same request.

An active session includes a short-lived funding capability. Send it only to the quote_url returned in the same object. The Payments service verifies its mode, session, recipient, asset, amount and expiry before requesting an exact-output quote.

Submitting a transaction changes the session to processing; it does not credit balance. The session becomes succeeded only when the matching Base USDC ConsumerDeposit is confirmed and the ledger credit is committed in the same transaction.

Operations

The following endpoints require an administrator access token:

MethodEndpointPurpose
GET/admin/v1/paybytoken_pay/funding-sessionsInspect session, transaction, and linked deposit evidence.
POST/admin/v1/paybytoken_pay/funding-sessions/:id/reconcileLink an already-credited matching deposit when automatic attribution was interrupted.

The inspector requires at least one bounded identifier: id, consumer_account_id, or funding_transaction_hash. Reads and repairs are written to the Paybytoken Pay support audit log. Reconciliation never changes the consumer balance.

On this page

API Workbench

Full Explorer

Open in new tab