Generates a link that takes customers straight to a secure and ready-to-pay checkout.
Required scope: link:create
RFC3339 formatted time for the link expiration date. It has to be in the future and can't go past the year 2037. For subscriptions, it also can't be later than the subscription's own expiration_time.
Specifies the type of payment being performed. Possible values are "Single" (One-time transactions that will let your customers pay an amount of money to you), "Frequent" (Are repeatable transactions of varying sums without the client having to enter their payment details again), and "Subscription" (periodic payments of the same amount of money, configured through Checkout or our Payments API).
The Customer object contains detailed information about the customer involved in the transaction.
The communication channels specifies where the final customer link should be forwarded. Optional, leave it out and we won't send the link anywhere, so it is up to you to hand it to your customer. Asking for EMAIL requires the customer email, and asking for SMS requires the customer phone.
[ "SMS" ]
Payment object with the payment method, capture object and payment type object (Single, Frequent, Subscription). Send exactly one of single, frequent or subscription, and make it match the type you asked for. Only single is available for now, frequent and subscription links answer with a 501.
Opt-in notification preferences for the link. When enabled, the customer receives an email with the payment instructions after choosing the method on the Pay by Link page. You can only set this when you create the link. It isn't returned with the link and you can't change it later.
- Sandboxhttps://api.test.easypay.pt/2.0/link
- Productionhttps://api.prod.easypay.pt/2.0/link
- Create Single payment Pay-by-link with several payment methods and sms and email communication channel
- Create Single payment Pay-by-link with one payment method and no communication channel
curl -i -X POST \
https://api.test.easypay.pt/2.0/link \
-H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
-H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92' \
-H 'Content-Type: application/json' \
-d '{
"type": "SINGLE",
"expiration_time": "2033-12-29T23:59:59.999Z",
"payment": {
"single": {
"requested_amount": "21.55"
},
"methods": [
"CC",
"MBW",
"MB",
"DD",
"VI"
],
"capture": {
"descriptive": "string",
"key": "string"
}
},
"customer": {
"name": "pedro barros",
"email": "barros@gmail.com",
"phone": "+351911234567",
"language": "PT"
},
"communication_channels": [
"SMS",
"EMAIL"
],
"notification": {
"customer_method_instructions_email": true
}
}'Created
A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.
String with the date on which this Pay By Link was created.
String with the date on which this Pay By Link was modified. Omitted while the link has never been modified.
The last possible time to make the payment.
Specifies the type of payment being performed. Possible values are "Single" (One-time transactions that will let your customers pay an amount of money to you), "Frequent" (Are repeatable transactions of varying sums without the client having to enter their payment details again), and "Subscription" (periodic payments of the same amount of money, configured through Checkout or our Payments API).
The Customer object contains detailed information about the customer required to create a pay-by-link.
The communication channels the final customer link was forwarded to. Always present, and empty when the link was created without any channel.
[ "SMS" ]
Payment object with the payment methods, capture object and payment type object. Only the payment type you asked for is present.
Link that redirects to the Easypay checkout payment page.
Link that redirects to a QR code to access the payment checkout page.
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2025-06-16T13:32:32Z", "modified_at": "2025-06-16T13:32:32Z", "expiration_time": "2026-06-10T09:27:55Z", "type": "SINGLE", "customer": { "name": "Jonh Doe", "email": "example@easypay.pt", "phone": "+351911234567" }, "communication_channels": [ "SMS" ], "payment": { "id": "string", "methods": [ … ], "capture": { … }, "single": { … }, "frequent": { … }, "subscription": { … } }, "url": "https://easypay.pt/s/XStDvnMKZaN", "image": "https://cdn.easypay.pt/images/qr/XStDvnMKZaN", "status": "ACTIVE" }