Skip to main content
GET
Find secure payment by request ID

Headers

Authorization
string
required

Bearer token for session authentication (or use session_token cookie)

Query Parameters

requestId
string
required

Request ID to look up the associated secure payment

Response

Secure payment found

token
string
required

Secure payment token

securePaymentUrl
string<uri>
required

URL to the secure payment page

status
enum<string>
required

Current status of the secure payment

Available options:
pending,
completed,
expired,
invalidated,
compliance_failed
paymentType
enum<string>
required

Type of payment: single or batch

Available options:
single,
batch
createdAt
string<date-time> | null
required

When the secure payment was created

expiresAt
string<date-time>
required

When the secure payment token expires

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.

completedAt
string<date-time> | null
required

When the secure payment was completed

payerAddress
string | null
required

Detected payer address for the completed secure payment

payerKytResults
object[]
required

KYT results for the actual detected payer wallets only

payeeKytResults
object[]
required

KYT results for outgoing payout payee wallets only

destination
object | null
required

Resolved destination for the selected request row, when stored

claimedDestination
object | null
required

Recipient claimed destination snapshot captured when the payout was created. Null when the recipient had no claimed destination or the row predates this snapshot.

orchestratorId
string | null
required

Orchestrator ID associated with the secure payment, if any

feePlan
object | null
required

Fee plan snapshot persisted at secure payment creation. Immutable, so it reflects the fees that applied to the payment whether it is still pending or already completed. Null when no snapshot was stored — e.g. non-stablecoin currency, or a batch that spans multiple currencies (not yet supported).

network
string
required

Request destination network. Dashboard uses this as an advisory multicall selection hint; creation and /pay still revalidate server-side.

currency
string | null
required

Request payment currency ID, when available. Null means the row predates the hint or has malformed stored currency data.

executionKind
enum<string> | null
required

Per-row execution-family hint for Dashboard selection. EVM rows can form same-chain or cross-chain multicalls depending on the selected set; Tron rows can only form Tron batches. Null means unsupported or inconsistent stored route data.

Available options:
evm_same_chain,
evm_cross_chain,
tron_batch
identityMode
enum<string>
required

Backend-derived identity bucket hint for multicall selection. Dashboard may use it to prevent mixed manual/clientId selections, but creation remains authoritative.

Available options:
manual_dashboard,
client_id
clientId
string | null
required

ClientId identity bucket when identityMode is client_id.

branding
object
required

Dashboard selection hint for neutral versus clientId-backed branding. Lets Dashboard distinguish neutral rows from clientId-backed rows so it can prevent mixed-branding selections at the UI level; creation remains authoritative.

childExecutable
boolean
required

Whether this secure-payment child currently passes creation-time child validation.

blockReason
enum<string> | null
required

Creation-validation block reason when childExecutable is false. Null when the child is currently executable.

Available options:
not_found,
not_owned,
not_outgoing,
not_single_payment,
invalid_child_linkage,
already_paid,
request_processing,
secure_payment_expired,
secure_payment_not_pending,
compliance_failed,
not_payable_child