Endpoints: Click to Pay Drop-In UI

Server URLs

Use the base URL for your environment as the URL prefix. See API Server URLs for the full reference.

Environment	Base URL
Production	`api.cybersource.com`
Production (India)	`api.in.cybersource.com`
Production (Saudi Arabia)	`api.sa.cybersource.com`
Sandbox / Test	`apitest.cybersource.com`
Sandbox / Test (Saudi Arabia)	`apitest.sa.cybersource.com`

Environment	Base URL
Production	`api.visaacceptance.com`
Sandbox / Test	`apitest.visaacceptance.com`

Environment	Base URL
Production	`api.smartpayfuse.barclaycard`
Sandbox / Test	`apitest.smartpayfuse.barclaycard`

Environment	Base URL
Production	`api.merchant.services.bankofamerica.com`
Sandbox / Test	`apitest.merchant.services.bankofamerica.com`

Environment	Base URL
Production	`gateway.cliq.com`
Sandbox / Test	`gatewaytest.cliq.com`

Environment	Base URL
Production	`nabgateway.nab.com.au`
Sandbox / Test	`nabgatewaytest.nab.com.au`

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
`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
`POST`	`/uc/v1/sessions`

Payment Details

This endpoint retrieves the decrypted payment details captured during a Click to Pay Drop-In UI session:

Method	Path
`GET`	`/flex/v2/payment-details/{jti}`

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
`GET`	`/flex/v2/payment-credentials/{paymentCredentialsReference}`

The {paymentCredentialsReference} is the reference ID returned in the id field when you created the payment credentials.

Was this page helpful?

Last published: September 29, 2026