# Lists single payments

Full report with all the single payments from your Account

Endpoint: GET /single
Version: 2.0
Security: accountId, apiKey

## Query parameters:

  - `page` (integer)
    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).
    Example: 1

  - `records_per_page` (integer)
    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).
    Example: 20

  - `type` (string)
    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).
    Enum: "sale", "authorisation"

  - `expiration_time` (string)
    Filter records by expiration datetime interval. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM)
    Example: "interval(2006-01-02 15:04,2006-01-02 15:04)"

  - `method` (string)
    Filter by payment method used in the transaction.
    Enum: "cc", "vi", "dd", "mb", "mbw", "ap", "gp", "sc", "uf"

  - `customer` (string)
    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.
    Example: "01J32EDWGNX94XMWP8PWB23KBK"

  - `id` (string)
    Filter by the unique identifier for the resource. Typically formatted as a UUID (Universally Unique Identifier).
    Example: "bb3e7e60-20f3-4208-9b21-64c635a51f42"

  - `key` (string)
    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.
    Example: "01J32EESEC1Z543P7J3PKSF1Q9"

  - `value` (number)
    Filter records by the exact transaction amount.
    Example: 10.32

  - `created_at` (string)
    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).
    Example: "interval(2006-01-02 15:04,2006-01-02 15:04)"

## Response 200 fields (application/json):

  - `meta` (object)
    Metadata object containing pagination and result information for list responses.

  - `meta.page` (object)
    Pagination details
    Example: 1

  - `meta.page.current` (integer)
    Current page number

  - `meta.page.total` (integer)
    Total number of pages

  - `meta.records` (object)
    Record details
    Example: 20

  - `meta.records.per_page` (integer)
    Number of records per page

  - `meta.records.total` (integer)
    Total number of records

  - `meta.links` (object)
    Navigation links for pagination

  - `meta.links.first` (string)
    Link to the first page
    Example: "?page=1"

  - `meta.links.prev` (string)
    Link to the previous page

  - `meta.links.next` (string)
    Link to the next page
    Example: "?page=2"

  - `meta.links.last` (string)
    Link to the last page
    Example: "?page=826"

  - `data` (array)

  - `data.id` (string)
    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.
    Example: "c6056234-a3f9-42de-b944-3ed793fcb6bb"

  - `data.type` (string)
    Specifies the type of financial operation being performed. 

TYPE | DESCRIPTION |
---------|----------|
 sale          | a complete transaction where funds are immediately captured. |
 authorisation | a temporary hold on funds pending a future capture.          |
    Enum: "sale", "authorisation"

  - `data.key` (string)
    A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system.
    Example: "Payment of Invoice Nº 1982652"

  - `data.descriptive` (string)
    A text field that describes the transaction as it will appear on the end user's account statement. This is typically used to provide clear, recognizable information about the payment, such as "Payment of Invoice Nº 1982652" or "Ticket for Queen".
    Example: "Payment of Invoice Nº 1982652"

  - `data.expiration_time` (string)
    Example: "2024-06-30 21:38:31"

  - `data.customer` (object)
    Customer information as returned in list responses (may contain masked/partial data for privacy)

  - `data.customer.id` (string)
    Example: "c6056234-a3f9-42de-b944-3ed793fcb6bb"

  - `data.customer.name` (string)
    Customer name (may be partially masked for privacy)
    Example: "Jos*** Gom***"

  - `data.customer.email` (string)
    Customer email (may be partially masked for privacy)
    Example: "cus***@example.com"

  - `data.customer.phone` (string)
    Customer phone (may be partially masked for privacy)
    Example: "911***567"

  - `data.customer.phone_indicative` (string)
    Phone country code
    Example: "+351"

  - `data.customer.fiscal_number` (string)
    Fiscal number (may be partially masked for privacy)
    Example: "PT123***89"

  - `data.customer.key` (string)
    Customer key
    Example: "Key Example"

  - `data.customer.language` (string)
    Customer preferred language
    Example: "PT"

  - `data.method` (object)

  - `data.method.type` (any)
    Enum: "CC", "DD", "VI", "MBW", "MB", "AP", "GP", "SW"

  - `data.method.status` (any)
    Enum: "active", "deleted", "pending"

  - `data.method.sdd_mandate` (object)
    SDD Mandate information as returned in list responses (contains masked data for privacy)

  - `data.method.sdd_mandate.id` (string)
    Mandate ID
    Example: "50389142122"

  - `data.method.sdd_mandate.iban` (string)
    IBAN (partially hidden for data security reasons)
    Example: "PT500027**XX7833"

  - `data.method.sdd_mandate.key` (string)
    Mandate key
    Example: "SDD Mandate key"

  - `data.method.sdd_mandate.name` (string)
    Account holder name (partially hidden for data security reasons)
    Example: "Fre*** DD***"

  - `data.method.sdd_mandate.email` (string)
    Account holder email (partially hidden for data security reasons)
    Example: "Cam***@yahoo.com"

  - `data.method.sdd_mandate.phone` (string)
    Account holder phone (partially hidden for data security reasons)
    Example: "911***567"

  - `data.method.sdd_mandate.account_holder` (string)
    Account holder name (partially hidden for data security reasons)
    Example: "Acc*** Exa***"

  - `data.method.sdd_mandate.country_code` (string)
    Country code
    Example: "PT"

  - `data.method.sdd_mandate.max_num_debits` (string)
    Maximum number of debits allowed
    Example: "12"

  - `data.method.sdd_mandate.billing_entity` (string)
    Billing entity identifier
    Example: "PT16103627"

  - `data.method.card_type` (string)
    Indicates the type of credit card used for the payment (e.g., "Visa", "MasterCard"). This field is only applicable for credit card transactions.
    Enum: "VISA", "MasterCard"

  - `data.method.last_four` (string)
    The last four digits of the credit card number used for the payment. This field is only applicable for credit card transactions.
    Example: "1234"

  - `data.method.expiration_date` (string)

  - `data.method.url` (string)
    The URL where the merchant should redirect the user to complete Credit Card Payments. This field is only applicable and available for credit card payment transactions.
    Example: "https://cc.easypay.pt/v3/public/card-details/cec55ab6-bda3-4ab3-af22-04d2ad2c046a"

  - `data.method.entity` (string)
    The identifier for the Multibanco entity to which the payment should be routed. This field specifies the entity code required for processing the payment through the Multibanco network, ensuring that the payment is directed to the correct recipient.
    Example: "11683"

  - `data.method.reference` (string)
    The unique payment reference number issued for the specific Multibanco entity. This field is used by the end user to make a payment at an ATM or through home banking. It ensures that the payment is correctly attributed to the intended transaction and recipient.
    Example: "665876931"

  - `data.method.iban` (string)
    International Bank Account Number (IBAN) in standard format
    Example: "PT50002700000001234567833"

  - `data.method.alias` (string)
    A unique identifier for the user within the MBWay system, used to identify the user in the MBWay SDK. This field is only applicable and available for MBWay transactions.

  - `data.currency` (string)
    ISO 4217 currency code. If not specified, the default currency is set to EUR.
    Example: "EUR"

  - `data.value` (number)
    The monetary amount for the transaction. This field specifies the value of the payment in the designated currency. It must be a positive decimal number representing the exact amount to be processed.
    Example: 17.5

  - `data.created_at` (string)
    Example: "2024-06-30 21:38:31"

  - `data.payment_status` (string)
    | Status | Description |
|--------|-------------|
| pending | The payment is awaiting processing. |
| paid | The payment has been completed successfully. |
| authorised | The payment has been authorized but not yet captured. |
| error | An error occurred during the payment process. |
| deleted | The payment has been deleted. |
| failed | The payment attempt failed. |
| active | The payment is currently active. |
| voided | The payment has been voided. |
    Enum: "pending", "paid", "authorised", "error", "deleted", "failed", "active"

  - `data.multibanco` (object)
    An object that holds the details specific to a Multibanco transaction response.

  - `data.multibanco.expiration_time` (string,null)
    When the Multibanco reference expires
    Example: "2025-09-28T12:41:08Z"

  - `data.multibanco.start_time` (string)
    When the Multibanco reference becomes valid
    Example: "2025-08-26T12:41:09Z"

  - `data.multibanco.product` (string)
    The Multibanco product type used
    Enum: "SPG", "CHECKDIGIT", "FILE"

  - `data.notification` (object)
    Notification settings for payment methods.

  - `data.notification.customer_method_instructions_email` (boolean)
    Specifies whether an email containing the payment instructions (e.g., Multibanco reference or Virtual IBAN details) should be sent to the customer's email address when the selected payment method is Multibanco or Virtual IBAN.
    Example: true

## Response 403 fields (application/json):

  - `status` (string, required)

  - `message` (array, required)
    An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.

## Response 404 fields (application/json):

  - `status` (string, required)

  - `message` (array, required)
    An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.

## Response 412 fields (application/json):

  - `status` (string, required)

  - `message` (array, required)
    An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.

## Response 500 fields (application/json):

  - `status` (string, required)

  - `message` (array, required)
    An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.