Guides
API Reference

Our reference library for integrating with our API

FAQ

Find answers to our most frequently asked questions

Classic Docs

Documentation for our Classic API

Manage Payment Links

On this page, find out how to:

  • Have you registered to begin using payment links? Contact your Solution Engineer or integration@checkout.com. During integration, you'll be able to specify your payment capture and 3D Secure settings.
  • You can set up webhooks to be notified when the payment has been approved, so you can continue the sales fulfilment flow.
  • To practise API calls request a test account and use the Sandbox version of the endpoint.

When requesting a payment from a customer using Payment Links solution, you can to 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.

You can provide a return_url in your API request. Once their payment is confirmed, the customer will be redirected to wherever the link is directed to. This could be back to your website, for example.

Testing

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


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

Required parameters for certain payment methods

Depending on the payment method, certain parameters are required. Please use the drop-down below to find out more.


 Parameters for supported payment methods
Payment methodbilling.address.countrycurrencyreference
KNETKW - KuwaitKWD

OPTIONAL

MadaSA - Saudi ArabiaSAR

OPTIONAL

PayPalAny supportedAny supported

REQUIRED

Sofort

AT - Austria

BE - Belgium

DE - Germany

IT - Italy

NL - Netherlands

ES - Spain

EUR

OPTIONAL

iDEAL

NL - Netherlands

EUR

OPTIONAL

{
  "amount": 200,  
  "currency": "GBP",
  "reference": "ORD-123A",
  "expires_in": 604800,
  "customer": {
    "name": "Jack Napier",
    "email": "jokershere@email.com"
  },
  "billing": {
    "address": {
      "country": "GB"
    }
  },
  "return_url": "https://example.com/home"
}
{
  "amount": 200,  
  "currency": "KWD",
  "reference": "ORD-123A",
  "expires_in": 604800,
  "customer": {
    "name": "Jack Napier",
    "email": "jokershere@email.com"
  },
  "billing": {
    "address": {
      "country": "KW"
    }
  },
  "return_url": "https://example.com/home"
}
{
  "amount": 200,  
  "currency": "SAR",
  "reference": "ORD-123A",
  "expires_in": 604800,
  "customer": {
    "name": "Jack Napier",
    "email": "jokershere@email.com"
  },
  "billing": {
    "address": {
      "country": "SA"
    }
  },
  "return_url": "https://example.com/home"
}
{
  "amount": 200,  
  "currency": "GBP",
  "reference": "ORD-123A",
  "expires_in": 604800,
  "customer": {
    "name": "Jack Napier",
    "email": "jokershere@email.com"
  },
  "billing": {
    "address": {
      "country": "GB"
    }
  },
  "return_url": "https://example.com/home"
}
{
  "amount": 200,  
  "currency": "EUR",
  "reference": "ORD-123A",
  "expires_in": 604800,
  "customer": {
    "name": "Jack Napier",
    "email": "jokershere@email.com"
  },
  "billing": {
    "address": {
      "country": "DE"
    }
  },
  "return_url": "https://example.com/home"
}
{
  "amount": 200,  
  "currency": "EUR",
  "reference": "ORD-123A",
  "expires_in": 604800,
  "customer": {
    "name": "Jack Napier",
    "email": "jokershere@email.com"
  },
  "billing": {
    "address": {
      "country": "NL"
    }
  },
  "return_url": "https://example.com/home"
}
{
  "id": "pl_ELqQJXdXzabU",
  "reference": "ORD-123A",
  "expires_on": "2020-08-20T20:25:28+08:00",
  "_links": {
    "redirect": {
	  "href": "https://pay.sandbox.checkout.com/link/pl_ELqQJXdXzabU"
    }
  }
}

Send the Payment Link you received in the _links.redirect object of the above response 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. The button at the bottom of the page redirects the customer to the specified URL only if you provide a return_url when creating a Payment Link, so make sure you include it in your API request. 

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.

Sandbox is a testing area, so you can practise API calls. Request a test account.

GEThttps://api.checkout.com/payment-links/{id}
GEThttps://api.sandbox.checkout.com/payment-links/{id}
{
  "id": "pl_ELqQJXdXzabU",
  "status": "Active",
  "payment_id": "undefined",
  "amount": 200,
  "currency": "GBP",
  "reference": "ORD-123A",
  "description": "Payment for Gold Necklace",
  "expires_on": "2021-08-20T20:25:28+08:00",
  "customer": {
    "email": "jokershere@email.com",
    "name": "Jack Napier"
  },
  "billing": {
    "address": {
      "address_line1": "Checkout.com",
      "address_line2": "90 Tottenham Court Road",
      "city": "London",
      "state": "London",
      "zip": "W1T 4TJ",
      "country": "GB"
    },
    "phone": {
      "country_code": "+1",
      "number": "4155552671"
    }
  },
  "products": [
    {
      "name": "Gold Necklace",
      "quantity": 1,
      "price": 200
    }
  ],
  "_links": {
    "self": {
      "href": "https://api.sandbox.checkout.com/payment-links/pl_ELqQJXdXzabU"
    },
    "redirect": {
      "href": "https://pay.sandbox.checkout.com/link/pl_ELqQJXdXzabU"
    }
  }
}
{
  "id": "pl_ELqQJXdXzabU",
  "status": "Payment Received",
  "payment_id": "pay_mbabizu24mvu3mela5njyhpit4",
  "amount": 200,
  "currency": "GBP",
  "reference": "ORD-123A",
  "description": "Payment for Gold Necklace",
  "expires_on": "2021-08-20T20:25:28+08:00",
  "customer": {
    "email": "jokershere@email.com",
    "name": "Jack Napier"
  },
  "billing": {
    "address": {
      "address_line1": "Checkout.com",
      "address_line2": "90 Tottenham Court Road",
      "city": "London",
      "state": "London",
      "zip": "W1T 4TJ",
      "country": "GB"
    },
    "phone": {
      "country_code": "+1",
      "number": "4155552671"
    }
  },
  "products": [
    {
      "name": "Gold Necklace",
      "quantity": 1,
      "price": 200
    }
  ],
  "_links": {
    "self": {
      "href": "https://api.sandbox.checkout.com/payment-links/pl_ELqQJXdXzabU"
    },
    "redirect": {
      "href": "https://pay.sandbox.checkout.com/link/pl_ELqQJXdXzabU"
    },
    "payment": {
      "href": "https://api.sandbox.checkout.com/payments/pay_mbabizu24mvu3mela5njyhpit4"
    },
    "payment_actions": {
      "href": "https://api.sandbox.checkout.com/payments/pay_mbabizu24mvu3mela5njyhpit4/actions"
    }
  }
}
{
  "id": "pl_ELqQJXdXzabU",
  "status": "Expired",
  "payment_id": "undefined",
  "amount": 200,
  "currency": "GBP",
  "reference": "ORD-123A",
  "description": "Payment for Gold Necklace",
  "expires_on": "2021-08-20T20:25:28+08:00",
  "customer": {
    "email": "jokershere@email.com",
    "name": "Jack Napier"
  },
  "billing": {
    "address": {
      "address_line1": "Checkout.com",
      "address_line2": "90 Tottenham Court Road",
      "city": "London",
      "state": "London",
      "zip": "W1T 4TJ",
      "country": "GB"
    },
    "phone": {
      "country_code": "+1",
      "number": "4155552671"
    }
  },
  "products": [
    {
      "name": "Gold Necklace",
      "quantity": 1,
      "price": 200
    }
  ],
  "_links": {
    "self": {
      "href": "https://api.sandbox.checkout.com/payment-links/pl_ELqQJXdXzabU"
    },
    "redirect": {
      "href": "https://pay.sandbox.checkout.com/link/pl_ELqQJXdXzabU"
    }
  }
}