List all payment links

Pedido

List all the payment links. Results come back a page at a time, with limit capped at 100. Ask for more than that and you get a 409, ask for less than 1 and you get a 400.

Required scope: link:read

Segurança

accountId and apiKey

Consulta

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)

UUID from a created Pay By Link.

amountstring^interval\(([-+]?[0-9]+)?(?:\.[0-9]+)?,([-+]?...

Filter Pay By Links by amount, as the range interval(min,max). Leave either bound empty to make the range open-ended, as in interval(10.00,) for everything from €10 up.

Exemplo:amount=interval(10.00,50.00)

customer_namestring

Filter Pay By Links by customer name.

emailstring, (email)

Filter Pay By Links by customer email.

phone_numberstring^\+[1-9]\d{1,14}$

Filter Pay By Links by customer phone number, in the E.164 pattern.

Exemplo:phone_number=+351911234567

created_atstring

Filter Pay By Links by creation date. Takes either a single RFC3339 timestamp or the range interval(from,to).

Exemplo:created_at=interval(2025-01-01T00:00:00Z,2025-01-31T23:59:59Z)

modified_atstring

Filter Pay By Links by modification date. Takes either a single RFC3339 timestamp or the range interval(from,to).

Exemplo:modified_at=interval(2025-01-01T00:00:00Z,2025-01-31T23:59:59Z)

expiration_timestring

Filter Pay By Links by expiration date. Takes either a single RFC3339 timestamp or the range interval(from,to).

Exemplo:expiration_time=interval(2025-01-01T00:00:00Z,2025-01-31T23:59:59Z)

payment_method[]Array of strings(PBL-Payment-Methods)

Filter Pay By Links by payment methods.

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

Exemplo:payment_method[]=MBW

status[]Array of strings

Filter Pay By Links by payment status.

curl -i -X GET \
  'https://api.test.easypay.pt/2.0/link?cursor=string&limit=0&id=497f6eca-6276-4993-bfeb-53cbbbba6f08&amount=interval(10.00%2C50.00)&customer_name=string&email=user%40example.com&phone_number=%2B351911234567&created_at=interval(2025-01-01T00%3A00%3A00Z%2C2025-01-31T23%3A59%3A59Z)&modified_at=interval(2025-01-01T00%3A00%3A00Z%2C2025-01-31T23%3A59%3A59Z)&expiration_time=interval(2025-01-01T00%3A00%3A00Z%2C2025-01-31T23%3A59%3A59Z)&payment_method%5B%5D=MBW&status%5B%5D=ACTIVE' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'

Respostas

Corpoapplication/json

metadataobject(Metadata)obrigatório

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

dataArray of objects(Link)read-onlyobrigatório

Response

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