Digital Checkout

Click to Pay

Click to Pay provides cardholders with a simplified online checkout experience by allowing eligible cards to be used at participating merchants without requiring the cardholder to manually enter card details at checkout.

For applicable Visa consumer card programs, Click to Pay enrollment is required for eligible cards. Payblr provides APIs to support Click to Pay enrollment and lifecycle management.

Click to Pay uses a token instead of exposing the card PAN during checkout. This helps reduce manual card entry for the cardholder and lowers security exposure because merchants do not need to view or store the cardholder’s card details.

Updated 15 minutes ago

On this page

Overview Client responsibilities Enrollment flow Sequence diagram Lifecycle management API Explorer Reference Implementation notes Next steps

Overview

Click to Pay allows eligible cards to be enrolled so cardholders can use them at participating merchants without manually entering card details during checkout.

Payblr provides APIs to support enrollment and lifecycle management. Your system is responsible for identifying eligible cards, submitting enrollment data, storing results, keeping data synchronized, and supporting opt-out or deletion flows when required.

Client responsibilities

The client implementation owns Click to Pay enrollment and lifecycle behavior for eligible cardholders and payment instruments.

Enroll eligible cards

Your system is responsible for enrolling eligible cardholders and payment instruments into Click to Pay when required.

Store enrollment results

Store the enrollment result returned by Payblr so your system can track the current Click to Pay state.

Keep data synchronized

Update Click to Pay data when cardholder or payment instrument details change.

Support opt-out and deletion

Support deletion, disablement, or opt-out flows when the payment instrument should no longer be available through Click to Pay.

Enrollment flow

The recommended Click to Pay implementation flow is listed below.

Create or activate card

Client creates or activates the card in Payblr before Click to Pay enrollment.

Enroll cardholder and card

Client submits cardholder and publicToken data using the Enroll Data endpoint.

Store enrollment result

Client stores the request trace ID and enrollment state returned by Payblr.

Add additional payment instruments

Client can add a new card to an existing profile using Enroll Payment Instruments.

Update data when needed

Client updates consumer or payment instrument data when cardholder or card details change.

Delete when required

Client deletes consumer information or a payment instrument when required.

Click to Pay Sequence Diagram

Click to Pay enrollment and lifecycle sequence

User

Cardholder

System

Client System

Platform

Payblr APIs

Checkout

Click to Pay

1. Create or activate card

Click to Pay

Endpoint

Create Card

Method

POST /program-manager/thr/cards

Client creates or activates the eligible card before Click to Pay enrollment.

Client SystemPayblr APIs

2. Enroll Data

Click to Pay

Endpoint

Enroll Data

Method

POST /program-manager/thr/ctp/api/v1/enrolldata

Client registers the cardholder and card for Click to Pay using cardholder details and publicToken.

Client SystemPayblr APIs

3. Return enrollment result

Click to Pay

Payblr returns the Click to Pay enrollment result, such as requestTraceId or related response identifiers.

Payblr APIsClient System

4. Store enrollment result

Client stores the enrollment result and current Click to Pay state for the cardholder and payment instrument.

Client SystemstoresClient System

5. Enroll Payment Instruments

Click to Pay

Endpoint

Enroll Payment Instruments

Method

POST /program-manager/thr/ctp/api/v1/enrollpaymentinstruments

Client adds a new card to an existing Click to Pay consumer profile when required.

Client SystemPayblr APIs

6. Get payment instrument

Endpoint

Get Payment Instrument Information

Method

GET /program-manager/thr/ctp/api/v1/paymentinstrument/{customerReferenceId}/{publicToken}

Client retrieves payment instrument information when the current Click to Pay state must be checked.

Client SystemPayblr APIs

7. Use Click to Pay at checkout

Click to Pay

Cardholder can use the enrolled payment instrument at participating merchants without manually entering card details.

CardholderClick to Pay

8. Manage payment instrument

Endpoint

Manage Payment Instrument

Method

PUT /program-manager/thr/ctp/api/v1/paymentinstrument

Client updates payment instrument details, such as billing address, when required.

Client SystemPayblr APIs

9. Manage consumer information

Endpoint

Manage Consumer Information

Method

PUT /program-manager/thr/ctp/api/v1/consumerinformation

Client updates consumer information created from the Enroll Data endpoint when cardholder data changes.

Client SystemPayblr APIs

10. Delete payment instrument

Endpoint

Delete Payment Instrument

Method

DELETE /program-manager/thr/ctp/api/v1/paymentinstrument/{customerReferenceId}/{publicToken}

Client deletes a payment instrument from Click to Pay when the payment instrument should no longer be available.

Client SystemPayblr APIs

Sequence diagram showing Click to Pay enrollment, result storage, checkout usage, and lifecycle maintenance using the Click to Pay API operations.

Lifecycle management

Click to Pay is not only an enrollment action. Your system should also support result storage, additional payment instrument enrollment, status retrieval, updates, failure handling, and deletion when required.

Operation	Method	Path	Purpose
Enroll Data	`POST`	`/program-manager/thr/ctp/api/v1/enrolldata`	Register a cardholder and card to use Click to Pay.
Enroll Payment Instruments	`POST`	`/program-manager/thr/ctp/api/v1/enrollpaymentinstruments`	Add a new card to an existing Click to Pay consumer profile.
Get Payment Instrument Information	`GET`	`/program-manager/thr/ctp/api/v1/paymentinstrument/{customerReferenceId}/{publicToken}`	Retrieve payment instrument information for a card enrolled onto Click to Pay.
Manage Payment Instrument	`PUT`	`/program-manager/thr/ctp/api/v1/paymentinstrument`	Update an existing payment instrument, such as billing address details.
Manage Consumer Information	`PUT`	`/program-manager/thr/ctp/api/v1/consumerinformation`	Update consumer information created from the Enroll Data endpoint.
Delete Consumer Information	`DELETE`	`/program-manager/thr/ctp/api/v1/consumerinformation/{customerReferenceId}`	Remove consumer information when required.
Delete Payment Instrument	`DELETE`	`/program-manager/thr/ctp/api/v1/paymentinstrument/{customerReferenceId}/{publicToken}`	Delete a payment instrument from Click to Pay when required.

Click to Pay request patterns

POST /program-manager/thr/ctp/api/v1/enrolldata
Authorization: Bearer [ACCESS_TOKEN]
Content-Type: application/json

POST /program-manager/thr/ctp/api/v1/enrollpaymentinstruments
Authorization: Bearer [ACCESS_TOKEN]
Content-Type: application/json

GET /program-manager/thr/ctp/api/v1/paymentinstrument/{customerReferenceId}/{publicToken}
Authorization: Bearer [ACCESS_TOKEN]
Accept: application/json

PUT /program-manager/thr/ctp/api/v1/paymentinstrument
Authorization: Bearer [ACCESS_TOKEN]
Content-Type: application/json

PUT /program-manager/thr/ctp/api/v1/consumerinformation
Authorization: Bearer [ACCESS_TOKEN]
Content-Type: application/json

DELETE /program-manager/thr/ctp/api/v1/consumerinformation/{customerReferenceId}
Authorization: Bearer [ACCESS_TOKEN]

DELETE /program-manager/thr/ctp/api/v1/paymentinstrument/{customerReferenceId}/{publicToken}
Authorization: Bearer [ACCESS_TOKEN]

API Explorer Reference

Confirm request fields, response fields, required identifiers, and examples in the API Explorer before implementation. Start with the Enroll Click to Pay Data operation.

Confirm request and response fields for Enroll Data.
Confirm whether the implementation needs Enroll Payment Instruments for additional cards.
Validate Get Payment Instrument Information behavior when payment instrument status must be retrieved.
Confirm update behavior for Manage Payment Instrument and Manage Consumer Information.
Confirm delete behavior for Delete Consumer Information and Delete Payment Instrument.

Open Enroll Click to Pay Data Open API Explorer

Implementation notes

Before enabling Click to Pay, confirm card eligibility, enrollment requirements, lifecycle behavior, required identifiers, retry behavior, and deletion or opt-out requirements.

For applicable Visa consumer card programs, Click to Pay enrollment is required for eligible cards.
Payblr provides APIs to support Click to Pay enrollment and lifecycle management.
Your system is responsible for enrolling eligible cardholders and payment instruments.
Your system must store enrollment results and keep Click to Pay data synchronized.
Click to Pay uses a token instead of exposing the card PAN during checkout.
Do not log PAN, sensitive card data, token details, request bodies, or response payloads in application logs, analytics tools, screenshots, or browser storage.
Confirm exact request fields, response fields, and required identifiers in the API Explorer before implementation.

Keep card data protected

Click to Pay reduces card data exposure by using a token instead of exposing the card PAN during checkout.

Keep enrollment data synchronized

Update Click to Pay data when cardholder or payment instrument details change, and delete or disable the payment instrument when required.

Next steps

After reviewing Click to Pay, confirm request fields, response fields, required identifiers, and supported environments in the API Explorer before implementation.