Skip to main content

Overview

Payor routes are designed for client-side checkout and use session-based auth:
  • x-session-token
  • x-signature

Authentication

Payment session auth is derived from invoice creation. Your server creates an invoice and receives:
  • session_token → use as x-session-token
  • signature → use as x-signature

Request

Fetch session details

Response

Example session details response (truncated):
Notes:
  • remaining_time is milliseconds until expiration (clamped at 0).
  • remaining_seconds is seconds until expiration (clamped at 0).

Underpaid lock-in

If invoice_status is underpaid, the response includes:
  • locked_network
  • locked_token_id
  • locked_payment_address
Payors must complete the remaining balance using the locked network/token.

Errors

  • 401 invalid session token/signature
  • 404 session not found / expired

Examples

  • Combine getSessionDetails with listAvailableTokens and createPaymentAddress to build a complete payor checkout experience.
Next: Available tokens