Skip to main content
GET
Get secure payment data by token

Headers

x-client-id
string
required

Client ID for frontend authentication

Origin
string
required

Origin header (automatically set by browser)

Path Parameters

token
string
required

Secure payment token (ULID) returned by POST /v2/secure-payments, POST /v2/secure-payments/payouts, or POST /v2/secure-payments/multicall-payouts. Distinct from the token query parameter, which selects the crosschain source currency.

Query Parameters

token
enum<string>

The source token of the crosschain payment. Pair with chain; both must be sent together. Not the secure payment token — that is the {token} path parameter.

Available options:
USDC,
USDT,
EURC,
USDT0
wallet
string

The wallet address of the payer (optional, used to check existing approvals)

chain
enum<string>

The source chain of the crosschain payment

Available options:
BASE,
OPTIMISM,
ARBITRUM,
ETHEREUM,
POLYGON,
BNB
eoaWallet
string

The EOA wallet address that holds the funds. When provided, balance checks and LiFi quotes use this address while the wallet param is used for calldata building (smart account flow).

isSafe
enum<string>

When true, prepares calldata for a Gnosis Safe multisig payer (wallet must be the Safe address). Mutually exclusive with eoaWallet.

Available options:
true,
false

Response

Secure payment data retrieved successfully

paymentType
enum<string>
required

Type of payment: single or batch

Available options:
single
status
enum<string>
required
Available options:
pending,
completed,
expired,
invalidated,
compliance_failed
redirectUrl
string | null
required

Optional redirect URL configured at creation time. Null when no redirect was set.

redirectLabel
string | null
required

Optional label describing the redirect destination. Null when no label was provided.

branding
object | null
required
requestIds
string[]
required

Request Network request IDs represented by this payment

payee
string
required

Payee wallet address

network
string
required

Blockchain network

amount
string
required

Payment amount

paymentCurrency
string
required

Payment currency ID

isNativeCurrency
boolean
required

Whether the payment currency is the native currency (e.g., ETH)

destination
object | null
required

Resolved destination for this payment, or null when the payment is not linked to a stored destination (e.g., payouts created from raw recipient details).

reference
string | null
required

Merchant reference for the payment

feePlan
object | null
required

Fee plan snapshot captured at creation time. Null when fees don't apply (non-stablecoin currency, payment created before fee plan rollout, etc.).

orchestratorId
string | null

Orchestrator ID associated with the secure payment, if any

paymentOptions
object
analytics
object

Vendor-neutral analytics metadata that SPP maps into Mixpanel shared properties. Amount values are decimal USD strings to avoid frontend precision loss.

isPayeeAddressMasked
boolean

Whether payee-address fields are intentionally masked until access is approved

accessDecision
object