List payment link details

Pedido

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

Required scope: link:read

Segurança

accountId and apiKey

Caminho

idstring, (uuid)obrigatório

Unique identifier of the payment link.

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'

Respostas

Corpoapplication/json

idstring, (uuid)read-onlyobrigatório

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-onlyobrigatório

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

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

modified_atstring, (date-time)read-only

String with the date on which this Pay By Link was modified. Omitted while the link has never been modified.

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

expiration_timestring, (date-time)obrigatório

The last possible time to make the payment.

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

typestring(PayByLinkPaymentTypes)obrigatório

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)obrigatório

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

communication_channelsArray of strings(Communication-Channels)obrigatório

The communication channels the final customer link was forwarded to. Always present, and empty when the link was created without any channel.

Items Enum:"SMS""EMAIL"

Exemplo:

[
  "SMS"
]

paymentobjectobrigatório

Payment object with the payment methods, capture object and payment type object. Only the payment type you asked for is present.

urlstring, (uri)obrigatório

Link that redirects to the Easypay checkout payment page.

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

imagestring, (uri)obrigatório

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

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

statusstring(Status)obrigatório

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

Enum:"ACTIVE""EXPIRED""FINALIZED""CANCELLED"

Response

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