Endpoints: Click to Pay Drop-In UI
Server URLs
Use the base URL for your environment as the URL prefix.
| Environment | Base URL |
|---|---|
| Production | |
| Sandbox / Test |
Boarding
These endpoints register a merchant for Click to Pay Drop-In UI. The same registration endpoint enables the product itself and enables Click to Pay customer authentication:
| Method | Path | Details | |
|---|---|---|---|
POST | /boarding/v1/registrations | — |
Capture Context
This endpoint supports the Sessions API. Requesting a capture context initializes a Click to Pay Drop-In UI session and returns the session data that the client-side SDK uses to render checkout:
| Method | Path | Details |
|---|---|---|
POST | /uc/v1/sessions | Creating the Capture Context |
Payment Details
This endpoint retrieves the decrypted payment details captured during a Click to Pay Drop-In UI session:
| Method | Path | Details |
|---|---|---|
GET | /flex/v2/payment-details/{jti} | Payment Details |
The {jti} is the ID of the JWT within the transient token returned by Unified Checkout. The transient token is a JWT object that you retrieved as part of a successful capture of payment information from a cardholder.
Payment Credentials
This endpoint retrieves the decrypted payment credentials created during a Click to Pay Drop-In UI session:
| Method | Path | Details |
|---|---|---|
GET | /flex/v2/payment-credentials/{paymentCredentialsReference} | Payment Credentials |
The {paymentCredentialsReference} is the reference ID returned in the id field when you created the payment credentials.
Thanks for your feedback!
Last published: October 28, 2026