--- title: "Lists single payments" method: GET path: "/single" tags: ["Single Payment"] --- # Lists single payments `GET /single` Full report with all the single payments from your Account **Required scope:** single:read ## Query parameters - `page` integer - `records_per_page` integer - `type` 'sale' | 'authorisation' - `expiration_time` string - `method` 'CC' | 'VI' | 'DD' | 'MB' | 'MBW' | 'AP' | 'GP' - `customer` string - `id` string, uuid - `key` string - `value` number, double - `created_at` string ## Response `200` OK - object - `meta` Meta — Metadata object containing pagination and result information for list responses. - `page` object — Pagination details - `current` integer — Current page number - `total` integer — Total number of pages - `records` object — Record details - `per_page` integer — Number of records per page - `total` integer — Total number of records - `links` object — Navigation links for pagination - `first` string — Link to the first page - `prev` string — Link to the previous page - `next` string — Link to the next page - `last` string — Link to the last page - `data` Single[] - `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. - `type` 'sale' | 'authorisation' — 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. | - `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. - `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". - `expiration_time` string - `customer` CustomerResponseOnList — Customer information as returned in list responses (may contain masked/partial data for privacy) - `id` string - `name` string — Customer name (may be partially masked for privacy) - `email` string — Customer email (may be partially masked for privacy) - `phone` string — Customer phone (may be partially masked for privacy) - `phone_indicative` string — Phone country code - `fiscal_number` string — Fiscal number (may be partially masked for privacy) - `key` string — Customer key - `language` string — Customer preferred language - `method` SingleAllMethodResponse - `type` 'CC' | 'DD' | 'VI' | 'MBW' | 'MB' | 'AP' | 'GP' | 'SW' | 'IPP' - `status` 'active' | 'deleted' | 'pending' - `sdd_mandate` SddMandateResponseOnList — SDD Mandate information as returned in list responses (contains masked data for privacy) - `id` string — Mandate ID - `iban` string — IBAN (partially hidden for data security reasons) - `key` string — Mandate key - `name` string — Account holder name (partially hidden for data security reasons) - `email` string — Account holder email (partially hidden for data security reasons) - `phone` string — Account holder phone (partially hidden for data security reasons) - `account_holder` string — Account holder name (partially hidden for data security reasons) - `country_code` string — Country code - `max_num_debits` string — Maximum number of debits allowed - `billing_entity` string — Billing entity identifier - `mbway` ResponseMbway — An object that holds the details specific to an MB WAY payment. - `phone` string — The phone number charged for the MB WAY payment, in full E.164 format (leading `+` and country code). - `card_type` 'VISA' | 'MasterCard' — Indicates the type of credit card used for the payment (e.g., "Visa", "MasterCard"). This field is only applicable for credit card transactions. - `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. - `expiration_date` string - `url` string, uri — 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. - `alias` string — A unique identifier for the user within the MB WAY system, used to identify the user in the MB WAY SDK. This field is only applicable and available for MB WAY transactions. - `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. - `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. - `iban` string — International Bank Account Number (IBAN) in standard format - `currency` string — ISO 4217 currency code. If not specified, the default currency is set to EUR. - `value` number, double — 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. - `created_at` string - `payment_status` 'pending' | 'paid' | 'authorised' | 'error' | 'deleted' | 'failed' | 'active' — | 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. | - `multibanco` ResponseMultibanco — An object that holds the details specific to a Multibanco transaction response. - `expiration_time` string, date-time, nullable — When the Multibanco reference expires - `start_time` string, date-time — When the Multibanco reference becomes valid - `product` 'SPG' | 'CHECKDIGIT' | 'FILE' — The Multibanco product type used - `terminal` ResponseTerminal — An object that holds the details specific to an IPP terminal response. - `id` string, uuid — The unique identifier of the terminal. - `notification` Notification — Notification settings for payment methods. - `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. ## Other responses - `403` — Forbidden - `404` — Not Found - `412` — Pre condition failed - `500` — Internal Server Error --- [API](https://skmtc.net/easypay/apis/easypay-payments-api.md) · [All operations](https://skmtc.net/easypay/apis/easypay-payments-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/easypay/easypay-payments-api/versions/cdf25a9ad7b2/schema)