Manage Payment Links
Last updated: December 8, 2022
On this page, find out how to:
- Have you registered to begin using Payment Links? Contact your Solution Engineer or [email protected]. During integration, you'll be able to specify your payment capture and 3D Secure settings.
- Find your secret and public API keys in the Hub.
- You can set up webhooks to be notified when the payment has been approved, so you can continue the sales fulfilment flow.
- To practice API calls request a test account and use the Sandbox version of the endpoint.
Note
Checkout.com does not support Payment Links embedded within an iframe.
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 get a detailed view of all required and optional fields, see our API reference.
Information
To display a button that will redirect the customer after their payment is approved, make sure your API request includes a return_url
parameter with your chosen URL value.
Note
http://localhost/ can only be used for the URL fields during testing and will not work in production.
post
https://api.checkout.com/payment-links
Note
Depending on the payment method, certain parameters are required. To find out which ones, use 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": "Bruce Wayne",12"email": "[email protected]"13},14"return_url": "https://example.com/payments/return"15}
We've listed the available payment methods for the Payment Links below.
Different payment methods have different required and optional fields when making a request. We've shown examples of these below.
You can view a request example with all of these fields on our API reference.
Payment method | Field requirements |
---|---|
Bancontact |
|
EPS |
|
Giropay |
|
Google Pay | Google Pay is processed as a card transaction, so all required fields are the same as with a card payment. This also means it will be rendered as a payment option when |
iDEAL |
|
Klarna | Klarna only accepts primary currency and address combinations. We use the 2-letter ISO country code, and a 3-letter ISO currency code. These country and currency combinations also expect specific locales. They are specified in the following list.
Required fields for all accepted countries:
|
KNET |
|
Mada |
|
Multibanco |
|
PayPal |
|
Przelewy24 |
|
SEPA Direct Debit |
|
Sofort |
|
1{2"id": "pl_ELqQJXdXzabU",3"reference": "ORD-123A",4"expires_on": "2020-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 will be presented with a Checkout.com-hosted payment page to complete their payment. Once they have completed the payment, they will be 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. It will look like 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": "Bruce Wayne",12"email": "[email protected]"13},14"billing": {15"address": {16"address_line1": "Checkout.com",17"address_line2": "90 Tottenham Court Road",18"city": "London",19"state": "London",20"zip": "W1T 4TJ",21"country": "GB"22},23"phone": {24"country_code": "+1",25"number": "4155552671"26}27},28"products": [29{30"name": "Gold Necklace",31"quantity": 1,32"price": 20033}34],35"_links": {36"self": {37"href": "https://api.sandbox.checkout.com/payment-links/pl_ELqQJXdXzabU"38},39"redirect": {40"href": "https://pay.sandbox.checkout.com/link/pl_ELqQJXdXzabU"41}42}43}