Manage Payment Links

Last updated: June 25, 2025

On this page, find out how to:

Make sure you've registered to begin using Payment Links. Contact your Solution Engineer or request support. During integration, you can specify your payment capture and 3D Secure settings.
Create your secret and public API keys in the Dashboard.
You can set up webhooks to be notified when the payment has been approved, so you can continue the sales fulfillment flow.

When requesting a payment from a customer using Payment Links solution, you can create a Payment Links session. This can be sent to the customer through a method that best suits you.

To display a button that redirects the customer after their payment is approved, make sure your API request includes a return_url parameter with your chosen URL value.

To get a detailed view of all required and optional fields, see our API reference.

Note

Checkout.com does not support Payment Links embedded within an iframe.

Information

You can enable Remember Me to allow 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.

Note

http://localhost/ can only be used for the URL fields during testing and does not work in production.

post

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

The fields you're required to supply in your request vary depending on the payment method used. To see which fields are required, refer to the Payment methods table.


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

Some payment methods may require you to provide additional fields or specific values when you perform a payment request. Refer to the API reference for more details.

Payment method	Field requirements
Card payments	No additional requirements.
Apple Pay	Apple Pay is processed as a card transaction. `currency` and `billing.address.country` must be supported by Apple Pay.
Google Pay	Google Pay is processed as a card transaction. `currency` and `billing.address.country` must be supported by Google Pay.
Alipay CN	`customer.email` or `customer.id` must be provided `payment_type` must be set to `Regular` or `Recurring` `products[]` must be provided For each `product` in `products[]`, the following must be provided: `name` `quantity` `reference` `unit_price` `billing.address.country` value must be `CN`, for China `currency` value must be one of: `CNY` `HKD` `SGD`
Alipay HK	`customer.email` or `customer.id` must be provided `payment_type` must be set to `Regular` or `Recurring` `products[]` must be provided For each `product` in `products[]`, the following must be provided: `name` `quantity` `reference` `unit_price` `billing.address.country` value must be `HK`, for Hong Kong `currency` value must be one of: `HKD` `SGD`
Alma	`billing.address.country` value must be `FR`, for France `currency` value must be `EUR`
Bancontact	`customer.name` must be provided `billing.address.country` value must be `BE`, for Belgium `currency` value must be `EUR`
Benefit Payment Gateway	`billing.address.country` value must be `BH`, for Bahrain `currency` value must be `BHD` `reference` must be provided
Dana	`customer.email` or `customer.id` must be provided `payment_type` must be set to `Regular` or `Recurring` `products[]` must be provided For each `product` in `products[]`, the following must be provided: `name` `quantity` `reference` `unit_price` `billing.address.country` value must be `ID`, for Indonesia `currency` value must be one of: `IDR` `HKD` `SGD`
EPS	`billing.address.country` value must be `AT`, for Austria `currency` value must be `EUR`
GCash	`customer.email` or `customer.id` must be provided `payment_type` must be set to `Regular` or `Recurring` `products[]` must be provided For each `product` in `products[]`, the following must be provided: `name` `quantity` `reference` `unit_price` `billing.address.country` value must be `PH`, for the Philippines `currency` value must be one of: `PHP` `HKD` `SGD`
iDEAL	`billing.address.country` value must be `NL`, for Netherlands `currency` value must be `EUR`
Kakao Pay	`customer.email` or `customer.id` must be provided `payment_type` must be set to `Regular` or `Recurring` `products[]` must be provided For each `product` in `products[]`, the following must be provided: `name` `quantity` `reference` `unit_price` `billing.address.country` value must be `KR`, for South Korea `currency` value must be one of: `KRW` `HKD` `SGD`
Klarna	`products[]` must be provided `customer.name` must be provided `billing.address.country` value must be one of: `AT` for Austria `AU` for Australia `BE` for Belgium `CH` for Switzerland `CZ` for Czech Republic `DE` for Germany `DK` for Denmark `ES` for Spain `FR` for France `FI` for Finland `GB` for United Kingdom `GR` for Greece `IE` for Ireland `IT` for Italy `NL` for Netherlands `NO` for Norway `PL` for Poland `PT` for Portugal `SE` for Sweden `US` for United States `currency` value must be one of: `AUD` `CHF` `CZK` `DKK` `EUR` `GBP` `NOK` `PLN` `SEK` `USD`
KNET	`billing.address.country` value must be `KW`, for Kuwait `currency` value must be `KWD` `locale` value must be `ar` – if no value is provided, the `en-GB` locale is used by default
MB WAY	`billing.address.country` value must be `PT`, for Portugal `currency` value must be `EUR` `reference` must be provided
MobilePay	`billing.address.country` value must be one of: 1- `DK` for Denmark 2- `FI` for Finland `currency` value must be one of: 1- `EUR` 2- `DKK`
Multibanco	`customer.name` must be provided `billing.address.country` value must be `PT`, for Portugal `currency` value must be `EUR`
PayPal	`products[]` must be provided. `currency` and `billing.address.country` must be supported by PayPal.
Przelewy24	`customer.name` must be provided `customer.email` must be provided `billing.address.country` value must be `PL`, for Poland `currency` value must be `EUR` or `PLN`
QPay	`billing.address.country` value must be `QA`, for Qatar `currency` value must be `QAR` `description` must be provided
SEPA Direct Debit	`billing.address.address_line1` must be provided `billing.address.city` must be provided `billing.address.country` value must be set to a country in the Single Euro Payments Area (SEPA) `billing.address.zip` must be provided `currency` value must be `EUR`
stc pay	`billing.address.country` must be set to `SA` `currency` value must be `SAR` `reference` must be provided
Tabby	`billing.address.country` value must be one of: `AE` for United Arab Emirates `SA` for Saudi Arabia `KW` for Kuwait `currency` value must be one of: `AED` `SAR` `KWD` `reference` must be provided The following shipping information must be provided: `shipping.address_line1` `shipping.city` `shipping.zip` `items[]` must be provided For each `item` in `items[]`, the following must be provided: `name` `unit_price` `quantity`
Tamara	`reference` must be provided. `items[]` must be provided. `billing.address.address_line1` and `billing.address.city` must be provided. For each `item` in `items[]`, the following must be provided: `name` `unit_price` `quantity` `billing.address.country` must be one of: `SA` for Saudi Arabia `AE` for United Arab Emirates `currency` must be one of: `SAR` `AED`
Touch 'n Go	`customer.email` or `customer.id` must be provided `payment_type` must be set to `Regular` or `Recurring` `products[]` must be provided For each `product` in `products[]`, the following must be provided: `name` `quantity` `reference` `unit_price` `billing.address.country` value must be `MY`, for Malaysia `currency` value must be one of: `MYR` `HKD` `SGD`
TrueMoney	`customer.email` or `customer.id` must be provided `payment_type` must be set to `Regular` or `Recurring` `products[]` must be provided For each `product` in `products[]`, the following must be provided: `name` `quantity` `reference` `unit_price` `billing.address.country` value must be `TH`, for Thailand `currency` value must be one of: `THB` `HKD` `SGD`
Venmo	`billing.address.country` must be `US`, for the United States `currency` value must be `USD`
Vipps	`billing.address.country` value must be one of: 1- `NO` for Norway 2- `SE` for Sweden `currency` value must be one of: 1- `NOK` 2- `SEK`


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}

Retrieve the Payment Link from _links.redirect.href to send to your customer.

This could be by email, text message, social media, live chat – wherever your customer wants to pay.

When they visit the link, they're presented with a Hosted Payments Page to complete their payment. Once they complete the payment, they're redirected to a Checkout.com-hosted confirmation page.

To keep track of the payments you request through Payment Links, you can check the status using the id returned when you created the session. For example, pl_ELqQJXdXzabU.

There are three statuses:

Active – The Payment Link can accept a payment from the customer. A payment may have been attempted by the customer but not completed successfully.
Payment Received – A payment has been received successfully using this Payment Link.
Expired – The Payment Link has expired and can no longer be accessed.

For a full explanation of the fields, see our API reference.

get

https://api.checkout.com/payment-links/{id}


1{
2  "id": "pl_ELqQJXdXzabU",
3  "status": "Active",
4  "payment_id": "undefined",
5  "amount": 200,
6  "currency": "GBP",
7  "reference": "ORD-123A",
8  "description": "Payment for Gold Necklace",
9  "expires_on": "2021-08-20T20:25:28+08:00",
10  "customer": {
11    "name": "John Smith",
12    "email": "[email protected]"
13  },
14  "billing": {
15    "address": {
16      "address_line1": "123 High St.",
17      "address_line2": "Flat 456",
18      "city": "London",
19      "zip": "SW1A 1AA",
20      "country": "GB"
21    },
22    "phone": {
23      "country_code": "+44",
24      "number": "1234567890"
25    }
26  },
27  "products": [
28    {
29      "name": "Gold Necklace",
30      "quantity": 1,
31      "price": 200
32    }
33  ],
34  "_links": {
35    "self": {
36      "href": "https://api.sandbox.checkout.com/payment-links/pl_ELqQJXdXzabU"
37    },
38    "redirect": {
39      "href": "https://pay.sandbox.checkout.com/link/pl_ELqQJXdXzabU"
40    }
41  }
42}


1{
2  "id": "pl_ELqQJXdXzabU",
3  "status": "Payment Received",
4  "payment_id": "pay_mbabizu24mvu3mela5njyhpit4",
5  "amount": 200,
6  "currency": "GBP",
7  "reference": "ORD-123A",
8  "description": "Payment for Gold Necklace",
9  "expires_on": "2021-08-20T20:25:28+08:00",
10  "customer": {
11    "name": "John Smith",
12    "email": "[email protected]"
13  },
14  "billing": {
15    "address": {
16      "address_line1": "123 High St.",
17      "address_line2": "Flat 456",
18      "city": "London",
19      "zip": "SW1A 1AA",
20      "country": "GB"
21    },
22    "phone": {
23      "country_code": "+44",
24      "number": "1234567890"
25    }
26  },
27  "products": [
28    {
29      "name": "Gold Necklace",
30      "quantity": 1,
31      "price": 200
32    }
33  ],
34  "_links": {
35    "self": {
36      "href": "https://api.sandbox.checkout.com/payment-links/pl_ELqQJXdXzabU"
37    },
38    "redirect": {
39      "href": "https://pay.sandbox.checkout.com/link/pl_ELqQJXdXzabU"
40    },
41    "payment": {
42      "href": "https://api.sandbox.checkout.com/payments/pay_mbabizu24mvu3mela5njyhpit4"
43    },
44    "payment_actions": {
45      "href": "https://api.sandbox.checkout.com/payments/pay_mbabizu24mvu3mela5njyhpit4/actions"
46    }
47  }
48}


1{
2  "id": "pl_ELqQJXdXzabU",
3  "status": "Expired",
4  "payment_id": "undefined",
5  "amount": 200,
6  "currency": "GBP",
7  "reference": "ORD-123A",
8  "description": "Payment for Gold Necklace",
9  "expires_on": "2021-08-20T20:25:28+08:00",
10  "customer": {
11    "name": "John Smith",
12    "email": "[email protected]"
13  },
14  "billing": {
15    "address": {
16      "address_line1": "123 High St.",
17      "address_line2": "Flat 456",
18      "city": "London",
19      "zip": "SW1A 1AA",
20      "country": "GB"
21    },
22    "phone": {
23      "country_code": "+44",
24      "number": "1234567890"
25    }
26  },
27  "products": [
28    {
29      "name": "Gold Necklace",
30      "quantity": 1,
31      "price": 200
32    }
33  ],
34  "_links": {
35    "self": {
36      "href": "https://api.sandbox.checkout.com/payment-links/pl_ELqQJXdXzabU"
37    },
38    "redirect": {
39      "href": "https://pay.sandbox.checkout.com/link/pl_ELqQJXdXzabU"
40    }
41  }
42}

Customize Payment Links

Find out how a Payment Link can be customized.

Manage Payment Links

Before you begin

Create a Payment Link

Step 1: Create a new Payment Link session

Note

Information

Endpoints

Note

Request example

Payment method field requirements

Response example

Step 2: Send the link to your customer

Check the status of a Payment Link

Endpoints

Response examples

Next steps

Customize Payment Links