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.
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.
[ "SMS" ]
Payment object with the payment method, capture object and payment type object (Single, Frequent, Subscription).
- 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": "2023-12-29T23:59:59.999Z",
"payment": {
"single": {
"requested_amount": "21.55"
},
"methods": [
"CC",
"MBW",
"MB",
"DD",
"VI",
"UF"
],
"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.
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 specifies where the final customer link should be forwarded.
[ "SMS" ]
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": { "methods": [ … ], "capture": { … }, "single": { … }, "frequent": { … }, "subscription": { … } }, "url": "https://easypay.pt/s/XStDvnMKZaN", "image": "https://cdn.easypay.pt/images/qr/XStDvnMKZaN", "status": "ACTIVE" }