Skip to content

API Objects

The core object representing one customer-facing payment intent.

FieldTypeNotes
idstringpi_...
amountintegerSmallest unit
currencystringUSDT, USDC, ETH, SOL
networkstringPOLYGON, ETHEREUM, SOLANA
statusenumpending, processing, succeeded, failed, expired, canceled
pay_addressstringAddress customer should send funds to
expires_attimestampAfter this, status → expired if unpaid
settlementobjectSee Settlement below
metadataobjectArbitrary key/value (max 50 keys, 500 chars/value)
pending ──────► processing ──────► succeeded
│ │
├──► canceled ├──► refunded (via Refund)
└──► expired └──► failed (chargeback / reversal)

A hosted payment page session. cs_....

An in-store / POS QR-code-based payment. qrs_....

A full reversal of a succeeded Payment. re_.... v1 supports full refunds only.

A delivery record of a server-side event. evt_.... See Webhooks → Event types.

A merchant-registered URL receiving event deliveries. we_....

Each error response carries a code field. The catalog below lists codes by error.type.

CodeMeaning
api_key_missingNo Authorization header was sent
api_key_invalidThe API key is malformed or has been revoked
api_key_expiredThe API key has been rotated and the old key is no longer accepted
CodeMeaning
publishable_key_not_allowedA pk_* key was used for an endpoint that requires a secret key (e.g., refunds, list operations)
livemode_mismatchA test-mode key was used against live-mode resources, or vice versa
CodeMeaning
parameter_missingA required parameter is absent
parameter_invalidA parameter has the wrong type or format
amount_too_smallamount is below the minimum for the chosen currency
network_unsupportednetwork is not one of POLYGON, ETHEREUM, SOLANA
currency_unsupportedcurrency is not one of USDT, USDC, ETH, SOL
currency_network_mismatchThe token does not exist on the chosen network (e.g., SOL on POLYGON)
settlement_invalidsettlement.mode is invalid, or splits percentages do not sum to 100
CodeMeaning
resource_not_foundThe object referenced by id does not exist (Payment, Checkout Session, QR Session, Refund, Webhook Endpoint)
CodeMeaning
idempotency_key_in_useThe Idempotency-Key was previously used with a different request body
payment_not_cancelableThe Payment is in a terminal state (succeeded, failed, expired, canceled) and cannot be canceled
payment_already_refundedThe Payment has already been refunded
CodeMeaning
rate_limit_exceededMore than 100 req/sec on this API key — see Rate Limits
CodeMeaning
insufficient_balanceRefund cannot proceed because the account’s balance in the source token is too low
network_rejectedOn-chain transaction was rejected (gas, nonce, etc.)
CodeMeaning
rpc_unavailableBlockchain RPC is unreachable. Retry with an Idempotency-Key.
rpc_timeoutBlockchain RPC did not respond within the deadline. Retry.
CodeMeaning
internal_errorUnhandled ParaSta server error. Report with request_id.