Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB
Pay By Link

Create a payment link

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

Required scope: <code style="background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em">link:create</code>

post/link

Request body

expiration_timestring date-time

RFC3339 formatted time for the link expiration date.

type'SINGLE' | 'FREQUENT' | 'SUBSCRIPTION' required
communication_channelsstring[] required

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

Example request

{
  "expiration_time": "2026-06-10T09:27:55.339Z",
  "customer": {
    "name": "Jonh Doe",
    "email": "example@easypay.pt",
    "phone": "+351911234567"
  },
  "communication_channels": [
    "SMS"
  ],
  "payment": {
    "methods": [
      "MBW"
    ],
    "single": {
      "requested_amount": "10.45"
    },
    "subscription": {
      "maximum_captures": 100,
      "start_time": "2025-01-15 00:00"
    }
  }
}

Response

Created

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.

created_atstring date-time

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

modified_atstring date-time

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

expiration_timestring date-time

The last possible time to make the payment.

type'SINGLE' | 'FREQUENT' | 'SUBSCRIPTION'
communication_channelsstring[]

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

urlstring url

Link that redirects to the Easypay checkout payment page.

imagestring url

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

status'ACTIVE' | 'EXPIRED' | 'DISABLED' | 'FINALIZED'

Example response

{
  "created_at": "2025-06-16T13:32:32Z",
  "modified_at": "2025-06-16T13:32:32Z",
  "expiration_time": "2026-06-10T09:27:55Z",
  "customer": {
    "name": "Jonh Doe",
    "email": "example@easypay.pt",
    "phone": "+351911234567"
  },
  "communication_channels": [
    "SMS"
  ],
  "payment": {
    "methods": [
      "MBW"
    ],
    "single": {
      "requested_amount": "10.45"
    },
    "frequent": {
      "minimum_amount": "5",
      "maximum_amount": "10"
    },
    "subscription": {
      "maximum_captures": 100,
      "start_time": "2025-01-15 00:00"
    }
  },
  "url": "https://easypay.pt/s/XStDvnMKZaN",
  "image": "https://cdn.easypay.pt/images/qr/XStDvnMKZaN"
}