v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB

Single Payment

Lists single payments

Full report with all the single payments from your Account

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

get/single

Query parameters

pageinteger

Example:1

Specifies the page number of the results to retrieve. This parameter is used for paginating through a collection of records, allowing the client to navigate to different pages of the dataset. The value must be a positive integer (e.g., "1" for the first page).

records_per_pageinteger

Example:20

Specifies the number of records to retrieve per page. This parameter is used for controlling the size of each page in a paginated collection of records. The value must be a positive integer, determining how many records are displayed on each page (e.g., "20" for 20 records per page).

type'sale' | 'authorisation'

Example:sale

Filter by type of financial operation being performed. Possible values are "Sale" (a complete transaction where funds are immediately captured) or "Authorisation" (a temporary hold on funds pending a future capture).

expiration_timestring

Example:interval(2006-01-02 15:04,2006-01-02 15:04)

Filter records by expiration datetime interval. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM)

method'CC' | 'VI' | 'DD' | 'MB' | 'MBW' | 'AP' | 'GP'

Example:MB

Filter by payment method used in the transaction.

customerstring

Example:01J32EDWGNX94XMWP8PWB23KBK

A user-defined identifier used to filter the customers. This parameter allows the client to specify a key to retrieve records or transactions that match the provided key. The value is a string and may not be unique, as it is determined by the user.

idstring uuid

Example:bb3e7e60-20f3-4208-9b21-64c635a51f42

Filter by the unique identifier for the resource. Typically formatted as a UUID (Universally Unique Identifier).

keystring

Example:01J32EESEC1Z543P7J3PKSF1Q9

A user-defined identifier used to filter the results. This parameter allows the client to specify a key to retrieve records or transactions that match the provided key. The value is a string and may not be unique, as it is determined by the user.

valuenumber double

Example:10.32

Filter records by the exact transaction amount.

created_atstring

Example:interval(2006-01-02 15:04,2006-01-02 15:04)

Filter records by creation datetime interval in UTC. Maximum allowed range is 30 days. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM).

Response

Example response

{
  "meta": {
    "links": {
      "first": "?page=1",
      "next": "?page=2",
      "last": "?page=826"
    }
  },
  "data": [
    {
      "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb",
      "key": "Payment of Invoice Nº 1982652",
      "descriptive": "Payment of Invoice Nº 1982652",
      "expiration_time": "2024-06-30 21:38:31",
      "customer": {
        "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb",
        "name": "Jos*** Gom***",
        "email": "cus***@example.com",
        "phone": "911***567",
        "phone_indicative": "+351",
        "fiscal_number": "PT123***89",
        "key": "Key Example",
        "language": "PT"
      },
      "method": {
        "sdd_mandate": {
          "id": "50389142122",
          "iban": "PT500027**XX7833",
          "key": "SDD Mandate key",
          "name": "Fre*** DD***",
          "email": "Cam***@yahoo.com",
          "phone": "911***567",
          "account_holder": "Acc*** Exa***",
          "country_code": "PT",
          "max_num_debits": "12",
          "billing_entity": "PT16103627"
        },
        "mbway": {
          "phone": "+351911234567"
        },
        "last_four": "1234",
        "url": "https://cc.easypay.pt/v3/public/card-details/cec55ab6-bda3-4ab3-af22-04d2ad2c046a",
        "entity": "11683",
        "reference": "665876931",
        "iban": "PT50002700000001234567833"
      },
      "currency": "EUR",
      "value": 17.5,
      "created_at": "2024-06-30 21:38:31",
      "multibanco": {
        "expiration_time": "2025-09-28T12:41:08Z",
        "start_time": "2025-08-26T12:41:09Z"
      },
      "terminal": {
        "id": "458b2fc4-3092-4de3-abd4-fe1600c09420"
      },
      "notification": {
        "customer_method_instructions_email": true
      }
    }
  ]
}

All 62 operations