Use the Click to Pay APIs to enroll consumers and payment instruments, retrieve Click to Pay information, manage lifecycle updates, and process deletion or opt-out requests.
| API capability | Purpose | When to use it |
|---|---|---|
| Enroll Data | Enroll cardholder and payment instrument data. | Use for initial enrollment of an eligible cardholder and card/payment instrument. |
| Get Payment Instrument Information | Retrieve Click to Pay payment instrument details and status. | Use before updates, during support review, or for reconciliation. |
| Enroll Payment Instruments | Add a payment instrument for an existing consumer. | Use when an existing Click to Pay consumer receives an additional eligible card. |
| Manage Payment Instrument | Update payment instrument details. | Use when card data, expiration, billing address, or payment instrument status changes. |
| Manage Consumer Information | Update cardholder or consumer information. | Use when name, email, phone, address, or other consumer profile data changes. |
| Delete Payment Instrument | Remove a card/payment instrument. | Use when a card is closed, replaced, lost/stolen, no longer eligible, or the cardholder opts out for that card. |
| Delete Consumer Information | Remove consumer-level information where applicable. | Use when the consumer profile must be removed and no longer maintained for Click to Pay. |