Pay By Link

Single Payment

Create and manage one-time payment transactions

Operations

Frequent Payment

Tokenize payment details for variable on-demand charges

Operations

Subscription Payment

Set up and manage automated recurring payments

Operations

Captures

Operations for managing payment captures

Operations

Authorisations

Operations for managing payment authorisations

Operations

Voids

Operations for managing payment voids

Operations

Refunds

Operations for managing payment refunds

Operations

Chargebacks

Operations for managing chargebacks

Operations

Notifications / Webhooks

Configure and manage webhook notifications for payment events

Webhooks

Reports

Access transaction and ledger reports

Operations

Out Payment

Transfer funds from Easypay accounts to SEPA bank accounts

Operations

Config

Configure account URLs for notifications and credit card transactions

Operations

Checkout

Embedded payment form solution for websites

Operations

Pay By Link

Generate and manage shareable payment links

Operations

Create a payment link

Request

Generates a link that takes customers straight to a secure and ready-to-pay checkout.

Security

accountId and apiKey

Bodyapplication/json

expiration_timestring(date-time)

RFC3339 formatted time for the link expiration date.

Example: "2026-06-10T09:27:55.339Z"

typestring(payment-types-request)required

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"

customerobject(customer-request)required

The Customer object contains detailed information about the customer involved in the transaction.

customer.idstring(uuid)

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.

customer.namestring<= 255 charactersrequired

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"

customer.emailstring(email)<= 70 charactersrequired

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"

customer.phonestring<= 15 charactersrequired

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"

customer.languagestring= 2 charactersrequired

The language preference of the customer, specified in the ISO 639-1 Alpha-2 format (e.g., "EN" for English, "PT" for Portuguese). This field is used to indicate the customer's preferred language for communication and documentation.

Default "PT"

communication_channelsArray of strings(communication-channels-request)required

The communication channels specifies where the final customer link should be forwarded.

Items Enum"SMS""EMAIL"

Example: ["SMS"]

paymentobjectrequired

Payment object with the payment method, capture object and payment type object (Single, Frequent, Subscription).

payment.methodsArray of strings(payment-methods-request)required

All the payment methods available to create a pay-by-link payment.

Items Enum"MB""MBW""DD""CC""VI""AP""GP"

Example: ["MBW"]

payment.captureobject(capture-request)

Capture object with all the fields necessary to create a Pay-by-Link request

payment.singleobject(single-request)

Single object with all the fields necessary to create a Pay-by-Link request.

payment.frequentobject(frequent-request)

This frequent object is not implemented yet. For now, we can only use Pay By Link with Single payments.

payment.subscriptionobject(subscription-request)

This subscription object is not implemented yet. For now, we can only use Pay By Link with Single payments.

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"
    ]
  }'

Responses

Created

Bodyapplication/json

idstring(uuid)read-only

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.

created_atstring(date-time)read-only

String with the date on which this Pay By Link was created.

Example: "2025-06-16T13:32:32Z"

modified_atstring(date-time)read-only

String with the date on which this Pay By Link was modified.

Example: "2025-06-16T13:32:32Z"

expiration_timestring(date-time)

The last possible time to make the payment.

Example: "2026-06-10T09:27:55Z"

typestring(payment-types-response)

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"

customerobject(customer-response)

The Customer object contains detailed information about the customer required to create a pay-by-link.

communication_channelsArray of strings(communication-channels-response)

The communication channels specifies where the final customer link should be forwarded.

Items Enum"SMS""EMAIL"

Example: ["SMS"]

paymentobject

urlstring(url)

Link that redirects to the Easypay checkout payment page.

Example: "https://easypay.pt/s/XStDvnMKZaN"

imagestring(url)

Link that redirects to a QR code to access the payment checkout page.

Example: "https://cdn.easypay.pt/images/qr/XStDvnMKZaN"

statusstring(status-response)

All the payment status after creating a pay-by-link payment.

Enum"ACTIVE""EXPIRED""DISABLED""FINALIZED"

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"
}

List all payment links

Request

List all the payment links.

Security

accountId and apiKey

Query

cursorstring

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.

limitnumber

The limit parameter is used for pagination. It specifies the maximum number of entries to return in a single page of results. Max 100.

idstring

UUID from a created Pay By Link.

amountstring

Filter Pay By Links by a certain amount.

customer_namestring

Filter Pay By Links by customer name.

emailstring

Filter Pay By Links by customer email.

phone_numberstring

Filter Pay By Links by customer phone number.

created_atstring

Filter Pay By Links by creation date.

modified_atstring

Filter Pay By Links by modification date.

expiration_timestring

Filter Pay By Links by expiration date.

payment_method[]string

Filter Pay By Links by payment methods.

status[]string

Filter Pay By Links by payment status.

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'

Responses

OK

Bodyapplication/json

metadataobject(metadata-cursor)required

An object containing additional information about the response. It includes details that help manage and navigate the retrieved data.

metadata.next_cursorstringrequired

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"

metadata.countnumber

The total number of records in the current response. This field indicates the number of items returned in the current set of results.

Example: 10

dataArray of objects(Link)read-onlyrequired

data[].idstring(uuid)read-only

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.

data[].created_atstring(date-time)

String with the date on which this Pay By Link was created.

Example: "2025-06-16T13:32:32Z"

data[].modified_atstring(date-time)

String with the date on which this Pay By Link was modified.

Example: "2025-06-16T13:32:32Z"

data[].expiration_timestring(date-time)

The last possible time to make the payment.

Example: "2026-06-10T09:27:55Z"

data[].typestring(payment-types-response)

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"

data[].communication_channelsArray of strings(communication-channels-response)

The communication channels specifies where the final customer link should be forwarded.

Items Enum"SMS""EMAIL"

Example: ["SMS"]

data[].customerobject(customer-response)

The Customer object contains detailed information about the customer required to create a pay-by-link.

data[].paymentobject

data[].urlstring(url)

Link that redirects to the Easypay checkout payment page.

Example: "https://easypay.pt/s/XStDvnMKZaN"

data[].imagestring(url)

Link that redirects to a QR code to access the payment checkout page.

Example: "https://cdn.easypay.pt/images/qr/XStDvnMKZaN"

data[].statusstring(status-response)

All the payment status after creating a pay-by-link payment.

Enum"ACTIVE""EXPIRED""DISABLED""FINALIZED"

Response

application/json

{
  "metadata": {
    "next_cursor": "lL_j7ilk7rc",
    "count": 10
  },
  "data": [
    { … }
  ]
}

List payment link details

Request

Lists a payment link with all the details identified by its unique ID.

Security

accountId and apiKey

Path

idstringrequired

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'

Responses

OK

Bodyapplication/json

idstring(uuid)read-only

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.

created_atstring(date-time)

String with the date on which this Pay By Link was created.

Example: "2025-06-16T13:32:32Z"

modified_atstring(date-time)

String with the date on which this Pay By Link was modified.

Example: "2025-06-16T13:32:32Z"

expiration_timestring(date-time)

The last possible time to make the payment.

Example: "2026-06-10T09:27:55Z"

typestring(payment-types-response)

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"

communication_channelsArray of strings(communication-channels-response)

The communication channels specifies where the final customer link should be forwarded.

Items Enum"SMS""EMAIL"

Example: ["SMS"]

customerobject(customer-response)

The Customer object contains detailed information about the customer required to create a pay-by-link.

paymentobject

urlstring(url)

Link that redirects to the Easypay checkout payment page.

Example: "https://easypay.pt/s/XStDvnMKZaN"

imagestring(url)

Link that redirects to a QR code to access the payment checkout page.

Example: "https://cdn.easypay.pt/images/qr/XStDvnMKZaN"

statusstring(status-response)

All the payment status after creating a pay-by-link payment.

Enum"ACTIVE""EXPIRED""DISABLED""FINALIZED"

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"
}

Delete Link

Request

Deletes a payment link identified by its unique ID. Once deleted, the link becomes invalid and can no longer be used. This action is irreversible.

Security

accountId and apiKey

Path

idstringrequired

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'

Responses

No Content

Response

No content

Update Link

Request

Updates a payment link identified by its unique ID.

Security

accountId and apiKey

Path

idstringrequired

Bodyapplication/json

expiration_timestring(date-time)required

RFC3339 formatted time for the link expiration date

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"
  }'

Responses

OK

Bodyapplication/json

idstring(uuid)read-only

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.

created_atstring(date-time)

String with the date on which this Pay By Link was created.

Example: "2025-06-16T13:32:32Z"

modified_atstring(date-time)

String with the date on which this Pay By Link was modified.

Example: "2025-06-16T13:32:32Z"

expiration_timestring(date-time)

The last possible time to make the payment.

Example: "2026-06-10T09:27:55Z"

typestring(payment-types-response)

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"

communication_channelsArray of strings(communication-channels-response)

The communication channels specifies where the final customer link should be forwarded.

Items Enum"SMS""EMAIL"

Example: ["SMS"]

customerobject(customer-response)

The Customer object contains detailed information about the customer required to create a pay-by-link.

paymentobject

urlstring(url)

Link that redirects to the Easypay checkout payment page.

Example: "https://easypay.pt/s/XStDvnMKZaN"

imagestring(url)

Link that redirects to a QR code to access the payment checkout page.

Example: "https://cdn.easypay.pt/images/qr/XStDvnMKZaN"

statusstring(status-response)

All the payment status after creating a pay-by-link payment.

Enum"ACTIVE""EXPIRED""DISABLED""FINALIZED"

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"
}

System

System health check endpoints

Operations

Easypay Payments API (2.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Single Payment

Frequent Payment

Subscription Payment

Captures

Authorisations

Voids

Refunds

Chargebacks

Notifications / Webhooks

Reports

Out Payment

Config

Checkout

Pay By Link

Create a payment link

Request

Responses

Was this helpful?

List all payment links

Request

Responses

Was this helpful?

List payment link details

Request

Responses

Was this helpful?

Delete Link

Request

Responses

Was this helpful?

Update Link

Request

Responses

Was this helpful?

System

Easypay Payments API (2.0)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Single Payment

Frequent Payment

Subscription Payment

Captures

Authorisations

Voids

Refunds

Chargebacks

Notifications / Webhooks

Reports

Out Payment

Config

Checkout

Pay By Link

Create a payment link

RequestExpand all

Responses

Was this helpful?

List all payment links

Request

Responses

Was this helpful?

List payment link details

Request

Responses

Was this helpful?

Delete Link

Request

Responses

Was this helpful?

Update Link

Request

Responses

Was this helpful?

System

Easypay Payments API (2.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Request