Enable Remember Me
Beta

Last updated: July 16, 2025

Information

Remember Me is only available for merchants in the United Arab Emirates (UAE), United Kingdom (UK), and United States (US). To enable Remember Me, contact your account manager or request support.

The Remember Me feature enables customers to save their card details during checkout. The next time the customer shops at any merchant that has Remember Me enabled, we display their saved card details.

This means you can provide a faster checkout experience even if the customer did not save their details directly with you.

Remember Me is available for the following integrations:

Additionally, you can integrate the:

Address component to collect the customer's shipping address.
Authentication component to collect the customer's email address and authenticate returning Remember Me customers.

Remember Me supports both customer-initiated transactions (CITs) and merchant-initiated transactions (MITs).

If you use Remember Me to store your customer payment details in the following scenarios, you automatically receive the payment instrument ID in the payment response:

CITs performed with your existing saved card-on-file system.

For more information, see the store_payment_details field reference.
MITs that your process with Flow. For example, if the payment_type is recurring, installment, or unscheduled.

For more information, see the payment_type field reference.

When a customer chooses to save their card details during checkout we save and link their following details:

Email address
Payment details
Phone number

The next time the customer shops with a merchant that enabled Remember Me:

Checkout.com uses the email address the customer provided to detect if they have previously saved their details.
We send them a one-time code to securely verify their identity and authenticate their session.
If successful, we display their saved card details to provide a faster checkout experience.

Customers can manage their saved details and view their purchase history on their personal dashboard.

Information

Remember Me's authentication does not replace any additional payment authentication required by the issuer, scheme, or merchant. For example, 3D Secure authentication.

Information

To test your Remember Me integration in the sandbox environment, request your one-time password (OTP) to be sent via email when prompted.

Remember Me requires a customer email to display the new and returning user options on the checkout page. You can:

Provide the customer.email field when you Request a Payment Session. Recommended if you already collect the customer email in your checkout flow.
Collect the customer email using Flow. Recommended if you do not collect the customer email in your checkout flow.
Integrate the Flow authentication component to handle email collection and Remember Me authentication. Recommended if you also want to make use of the Flow address component.

To provide a better experience for returning customers, we recommend that you also request the customer's phone number and provide it in the customer.phone field.

post

https://api.checkout.com/payment-sessions


1{
2  "amount": 1000,
3  "currency": "GBP",
4  "reference": "ORD-123A",
5  "billing": {
6    "address": {
7      "country": "GB"
8    }
9  },
10  "customer": {
11    "name": "Jia Tsang",
12    "email": "[email protected]",
13    "phone": {
14      "country_code": "+44",
15      "number": "7700900000"
16    }
17  },
18  "success_url": "https://example.com/payments/success",
19  "failure_url": "https://example.com/payments/failure"
20}


1{
2  "id": "ps_2Un6I6lRpIAiIEwQIyxWVnV9CqQ",
3  "payment_session_secret": "pss_9823241e-2cec-4c98-b23d-7b29ow4e2e34",
4  "payment_session_token": "YmFzZTY0:eyJpZCI6InBzXzJVbjZJNmxScElBaUlFd1FJeXhXVm5WOUNxUSIsImFtb3VudCI6MTAwMCwibG9jYWxlIjoiZW4tR0IiLCJjdXJyZW5jeSI6IkdCUCIsInBheW1lbnRfbWV0aG9kcyI6W3sidHlwZSI6ImNhcmQiLCJjYXJkX3NjaGVtZXMiOlsiVmlzYSIsIk1hc3RlcmNhcmQiLCJBbWV4Il19XSwicmlzayI6eyJlbmFibGVkIjp0cnVlfSwiX2xpbmtzIjp7InNlbGYiOnsiaHJlZiI6Imh0dHBzOi8vYXBpLnNhbmRib3guY2hlY2tvdXQuY29tL3BheW1lbnQtc2Vzc2lvbnMvcHNfMlVuNkk2bFJwSUFpSUV3UUl5eFdWblY5Q3FRIn19fQ==",
5  "_links": {
6    "self": {
7      "href": "https://api.sandbox.checkout.com/payment-sessions/ps_2Un6I6lRpIAiIEwQIyxWVnV9CqQ"
8    }
9  }
10}

Remember Me requires a customer email to display the new and returning user options on the checkout page. You can:

Provide the customer.email field when you Create a Hosted Payments Page session. Recommended if you already collect the customer email in your checkout flow.
Collect the customer email using Hosted Payments Page. Recommended if you do not collect the customer email in your checkout flow.

To provide a better experience for returning customers, we recommend that you also request the customer's phone number and provide it in the customer.phone field.

Information

When you enable Remember Me, you must set the payment_method_configuration.card.store_payment_details field to enabled to get the payment instrument in the response.

post

https://api.checkout.com/hosted-payments


1{
2  "amount": 1000,
3  "currency": "GBP",
4  "reference": "ORD-123A",
5  "billing": {
6    "address": {
7      "country": "GB"
8    }
9  },
10  "customer": {
11    "name": "Jia Tsang",
12    "email": "[email protected]",
13    "phone": {
14      "country_code": "+44",
15      "number": "7700900000"
16    }
17  },
18  "success_url": "https://example.com/payments/success",
19  "failure_url": "https://example.com/payments/failure",
20  "cancel_url": "https://example.com/payments/cancel"
21}


1{
2  "id": "hpp_xGQBg0AXl3cM",
3  "reference": "ORD-123A",
4  "_links": {
5    "self": {
6      "href": "https://api.checkout.com/hosted-payments/hpp_xGQBg0AXl3cM"
7    },
8    "redirect": {
9      "href": "https://pay.checkout.com/page/hpp_xGQBg0AXl3cM"
10    }
11  }
12}

Remember Me requires a customer email to display the new and returning user options on the checkout page. You can:

Provide the customer.email field when you Create a Payment Link. Recommended if you already collect the customer email in your checkout flow.
Collect the customer email using Payment Links. Recommended if you do not collect the customer email in your checkout flow.

To provide a better experience for returning customers, we recommend that you also request the customer's phone number and provide it in the customer.phone field.

Information

If you generate a payment link using the Dashboard, the customer must manually provide their phone number when they enable the Remember Me option for the first time. The field will not auto-populate.

post

https://api.checkout.com/payment-links


1{
2  "amount": 1000,
3  "currency": "GBP",
4  "reference": "ORD-123A",
5  "billing": {
6    "address": {
7      "country": "GB"
8    }
9  },
10  "customer": {
11    "name": "Jia Tsang",
12    "email": "[email protected]",
13    "phone": {
14      "country_code": "+44",
15      "number": "7700900000"
16    }
17  },
18  "return_url": "https://example.com/payments/return"
19}


1{
2  "id": "pl_ELqQJXdXzabU",
3  "reference": "ORD-123A",
4  "expires_on": "2024-08-20T20:25:28+08:00",
5  "_links": {
6    "redirect": {
7      "href": "https://pay.sandbox.checkout.com/link/pl_ELqQJXdXzabU"
8    }
9  }
10}

Information

To enable Remember Me in your production environment, contact your account manager or request support.

Use the Flow authentication component to collect the customer's email address and authenticate returning Remember Me customers.

If the customer has a Remember Me account, they are prompted to securely authenticate via an OTP. When they authenticate successfully, their saved payment details are automatically populated in the Flow card component.

If they do not have an account and choose a payment method supported by Remember Me, they are prompted to sign up.

This helps to:

Provide a streamlined user experience for new and returning Remember Me customers.
Simplify your integration logic – When the payment is complete, the customer email is returned in the response.

Information

The email the customer provides in the authentication component is returned in the payment response. This email address overrides the email used to initiate the payment session.

Use your integration's existing CheckoutWebComponents instance to create an authentication object and use the onChange event handler to retrieve the customer's email address:


1const authenticationComponent = checkout.create('authentication', {
2  onChange: (_self, data) => {
3    // Access the email value via data.email
4  },
5});

Mount the authentication component to the website using the mount() method. The method takes an Element selector or an Element as an argument. For example, #authentication-container or document.getElementById(#authentication-container), respectively.


1authenticationComponent.mount('#authentication-container');


1const authenticationElement = document.getElementById('authentication-container');
2authenticationComponent.mount(authenticationElement);

Note

Embedding the authentication component within an iframe or onto a Shadow DOM is not supported.

Information

You must integrate the authentication component to use the address component with Remember Me.

Use the Flow address component to collect the customer's shipping address.

If the customer has a Remember Me account, their saved shipping address is automatically populated when they sign in.

Use your integration's existing CheckoutWebComponents instance to create a shipping_address object and use the onChange event handler to retrieve the customer's shipping address:


1const addressComponent = checkout.create('shipping_address', {
2  onChange: (_self, data) => {
3    // Access the shipping address value via data.shippingAddress
4  },
5});

Mount the address component to the website using the mount() method. The method takes an Element selector or an Element as an argument. For example, #authentication-container or document.getElementById(#authentication-container), respectively.


1addressComponent.mount('#address-container');


1const addressElement = document.getElementById('address-container');
2addressComponent.mount(addressElement);

Note

Embedding the address component within an iframe or onto a Shadow DOM is not supported.

Enable Remember Me
Beta

Information

Customer experience

Information

Add Remember Me to your integration

Information

Request example

Response example

Information

Request example

Response example

Information

Request example

Response example

Information

Integrate the authentication component (optional)

Information

Note

Integrate the address component (optional)

Information

Note