Paybytoken Pay · Private beta
Merchant handoff endpoints
Create, retrieve and cancel Paybytoken Pay payment and account-link sessions.
Payment approval
| Method | Endpoint | Purpose |
|---|---|---|
POST | /api/v1/consumer_payment_sessions | Create a hosted approval for a paybytoken_pay Payment Intent. |
GET | /api/v1/consumer_payment_sessions/:id | Retrieve merchant-safe handoff state. |
POST | /api/v1/consumer_payment_sessions/:id/cancel | Cancel a pending handoff without canceling the Payment Intent. |
Creation requires payment_intent, return_url, and optionally locale (en, zh-Hans, or
zh-Hant). The returned hosted_url is available only on the idempotent creation response. Its
fragment is a capability: send it to the customer's browser, never log or persist it in analytics.
Account linking
| Method | Endpoint | Purpose |
|---|---|---|
POST | /api/v1/consumer_link_sessions | Create hosted merchant-link consent. |
GET | /api/v1/consumer_link_sessions/:id | Retrieve merchant-safe consent state. |
POST | /api/v1/consumer_link_sessions/:id/cancel | Cancel pending consent. |
Creation requires a merchant Customer ID and return_url. Approval returns a merchant-specific
consumer alias; the global consumer ID, balances and activity with other merchants are never
disclosed. Browser return is navigation only. Trust the canonical resource state and signed
webhooks for payment fulfillment.
Did this page answer your question?
Your feedback helps us improve the integration path.