Create and manage one-time payment transactions
- List all payment links
Create a payment link
List payment link details
Delete Link
Update Link
List all payment links
Easypay Payments API (2.0)
Download OpenAPI description
Overview
Easypay Documentation
License
Languages
Servers
Sandbox
https://api.test.easypay.pt/2.0
Production
https://api.prod.easypay.pt/2.0
Bodyapplication/json
RFC3339 formatted time for the link expiration date.
Example: "2026-06-10T09:27:55.339Z"
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).
Enum"SINGLE""FREQUENT""SUBSCRIPTION"
The Customer object contains detailed information about the customer involved in the transaction.
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.
The full name of the customer. This field is used to identify the customer and personalize interactions. It typically includes the customer's first name and last name.
Example: "Jonh Doe"
The email address of the customer. This field is used for communication purposes, including sending transaction confirmations, receipts, and other notifications related to the customer's activities. Also, this email will be used to send the payment link if the EMAIL channel was requested in the communication channels.
Example: "example@easypay.pt"
The contact phone number of the customer has the E.164 pattern and is always required. This number will be used to make the payment if the method is MBWAY and to send the payment link if the SMS channel was requested in the communication channels.
Example: "+351911234567"
The communication channels specifies where the final customer link should be forwarded.
Items Enum"SMS""EMAIL"
Example: ["SMS"]
Payment object with the payment method, capture object and payment type object (Single, Frequent, Subscription).
All the payment methods available to create a pay-by-link payment.
Items Enum"MB""MBW""DD""CC""VI""AP""GP"
Example: ["MBW"]
Capture object with all the fields necessary to create a Pay-by-Link request
Single object with all the fields necessary to create a Pay-by-Link request.
This frequent object is not implemented yet. For now, we can only use Pay By Link with Single payments.
- Sandboxhttps://api.test.easypay.pt/2.0/link
- Productionhttps://api.prod.easypay.pt/2.0/link
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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"
]
}'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.
Example: "2025-06-16T13:32:32Z"
String with the date on which this Pay By Link was modified.
Example: "2025-06-16T13:32:32Z"
The last possible time to make the payment.
Example: "2026-06-10T09:27:55Z"
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).
Enum"SINGLE""FREQUENT""SUBSCRIPTION"
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.
Items Enum"SMS""EMAIL"
Example: ["SMS"]
Link that redirects to the Easypay checkout payment page.
Example: "https://easypay.pt/s/XStDvnMKZaN"
Link that redirects to a QR code to access the payment checkout page.
Example: "https://cdn.easypay.pt/images/qr/XStDvnMKZaN"
Response
application/json
{ "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" }
Query
The cursor parameter is used for pagination. It specifies the pointer to the start of the next set of results in a sequence of paginated data. Typically, this is a unique identifier of the last item from the previous response. If not provided, the API fetches the first page of results.
The limit parameter is used for pagination. It specifies the maximum number of entries to return in a single page of results. Max 100.
- Sandboxhttps://api.test.easypay.pt/2.0/link
- Productionhttps://api.prod.easypay.pt/2.0/link
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.test.easypay.pt/2.0/link?cursor=string&limit=0&id=string&amount=string&customer_name=string&email=string&phone_number=string&created_at=string&modified_at=string&expiration_time=string&payment_method%5B%5D=string&status%5B%5D=string' \
-H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
-H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'OK
An object containing additional information about the response. It includes details that help manage and navigate the retrieved data.
Provides the cursor for the next set of records. This value should be used as the cursor parameter in subsequent requests to continue paginating through the data. If the cursor is an empty string or null, it indicates that there are no more results. To retrieve all available results, continue making subsequent requests until next_cursor is empty or null.
Example: "lL_j7ilk7rc"
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.
Example: "2025-06-16T13:32:32Z"
String with the date on which this Pay By Link was modified.
Example: "2025-06-16T13:32:32Z"
The last possible time to make the payment.
Example: "2026-06-10T09:27:55Z"
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).
Enum"SINGLE""FREQUENT""SUBSCRIPTION"
The communication channels specifies where the final customer link should be forwarded.
Items Enum"SMS""EMAIL"
Example: ["SMS"]
The Customer object contains detailed information about the customer required to create a pay-by-link.
Link that redirects to the Easypay checkout payment page.
Example: "https://easypay.pt/s/XStDvnMKZaN"
Link that redirects to a QR code to access the payment checkout page.
Example: "https://cdn.easypay.pt/images/qr/XStDvnMKZaN"
Response
application/json
{ "metadata": { "next_cursor": "lL_j7ilk7rc", "count": 10 }, "data": [ { … } ] }
- Sandboxhttps://api.test.easypay.pt/2.0/link/{id}
- Productionhttps://api.prod.easypay.pt/2.0/link/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.test.easypay.pt/2.0/link/{id}' \
-H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
-H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'OK
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.
Example: "2025-06-16T13:32:32Z"
String with the date on which this Pay By Link was modified.
Example: "2025-06-16T13:32:32Z"
The last possible time to make the payment.
Example: "2026-06-10T09:27:55Z"
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).
Enum"SINGLE""FREQUENT""SUBSCRIPTION"
The communication channels specifies where the final customer link should be forwarded.
Items Enum"SMS""EMAIL"
Example: ["SMS"]
The Customer object contains detailed information about the customer required to create a pay-by-link.
Link that redirects to the Easypay checkout payment page.
Example: "https://easypay.pt/s/XStDvnMKZaN"
Link that redirects to a QR code to access the payment checkout page.
Example: "https://cdn.easypay.pt/images/qr/XStDvnMKZaN"
Response
application/json
{ "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", "communication_channels": [ "SMS" ], "customer": { "name": "Jonh Doe", "email": "example@easypay.pt", "phone": "+351911234567" }, "payment": { "methods": [ … ], "capture": { … }, "single": { … }, "frequent": { … }, "subscription": { … } }, "url": "https://easypay.pt/s/XStDvnMKZaN", "image": "https://cdn.easypay.pt/images/qr/XStDvnMKZaN", "status": "ACTIVE" }
- Sandboxhttps://api.test.easypay.pt/2.0/link/{id}
- Productionhttps://api.prod.easypay.pt/2.0/link/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://api.test.easypay.pt/2.0/link/{id}' \
-H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
-H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'- Sandboxhttps://api.test.easypay.pt/2.0/link/{id}
- Productionhttps://api.prod.easypay.pt/2.0/link/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://api.test.easypay.pt/2.0/link/{id}' \
-H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
-H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92' \
-H 'Content-Type: application/json' \
-d '{
"expiration_time": "2019-08-24T14:15:22Z"
}'OK
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.
Example: "2025-06-16T13:32:32Z"
String with the date on which this Pay By Link was modified.
Example: "2025-06-16T13:32:32Z"
The last possible time to make the payment.
Example: "2026-06-10T09:27:55Z"
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).
Enum"SINGLE""FREQUENT""SUBSCRIPTION"
The communication channels specifies where the final customer link should be forwarded.
Items Enum"SMS""EMAIL"
Example: ["SMS"]
The Customer object contains detailed information about the customer required to create a pay-by-link.
Link that redirects to the Easypay checkout payment page.
Example: "https://easypay.pt/s/XStDvnMKZaN"
Link that redirects to a QR code to access the payment checkout page.
Example: "https://cdn.easypay.pt/images/qr/XStDvnMKZaN"
Response
application/json
{ "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", "communication_channels": [ "SMS" ], "customer": { "name": "Jonh Doe", "email": "example@easypay.pt", "phone": "+351911234567" }, "payment": { "methods": [ … ], "capture": { … }, "single": { … }, "frequent": { … }, "subscription": { … } }, "url": "https://easypay.pt/s/XStDvnMKZaN", "image": "https://cdn.easypay.pt/images/qr/XStDvnMKZaN", "status": "ACTIVE" }