You can retrieve a payment by its payment_id. A payment belongs either to your account or a connected account.
If a payment has multiple consecutive charge attempts that fail due to insufficient user balance, the metadata object will include a failed_dates array, listing the timestamps of each failed attempt.
Response field descriptions
payment_id (string) — Unique identifier for the payment.
origin (string) — Source of the payment. Possible values: subscriptions (Payment generated by a subscription) OR purchase_sessions (Payment from a one-time purchase)
origin_id (string) — ID of the subscription or purchase session that originated the payment.
amount (number, USD) — Payment amount in USD.
fee (number, USD) — Fee charged for processing, in USD.
status (string) — Current payment status. Possible values: pending/failed/completed.
account_id (string) — The customer platform account ID.
transaction_hash (string|null) — Blockchain transaction hash if processed on-chain; null if not applicable.
transaction_date (ISO-8601 string) — Timestamp when the payment was processed.
currency (string) — Currency code (currently always USD).
agreement_id (string) — Associated agreement (e.g., subscription/purchase session agreement).
metadata (object) — Additional context. May include: failed_dates (array of ISO-8601 strings; Timestamps of consecutive failed charge attempts due to insufficient user balance.)
