--- title: "Shows single payment details" method: GET path: "/single/{id}" tags: ["Single Payment"] --- # Shows single payment details `GET /single/{id}` Retrieve a single payment details **Required scope:** single:read ## Path parameters - `id` string, uuid, required ## Response `200` OK - object - `id` string - `created_at` string - `captures` SingleCaptureFull[] - `id` string, required - `status` 'delayed' | 'waiting' | 'success' | 'pending' | 'failed' | 'refunded', required — Represents the current state of a payment capture operation. This field provides clear visibility into the capture's progress and outcome: - **delayed**: The capture has been scheduled for a later time. - **waiting**: The capture is queued for processing. - **success**: The capture has been completed successfully. - **pending**: The capture is currently being processed. - **failed**: The capture could not be completed due to an error or issue. - **refunded**: The capture has been refunded. This field provides a clear indication of the current state of the capture, helping users understand its progress and outcome. - `descriptive` string, required — 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". - `transaction_key` string - `capture_date` string, date — The date when the action should be executed. This field specifies the exact day for capturing the transaction, formatted as "YYYY-MM-DD" (e.g., "2024-06-30"). It is optional and defaults to the current date if not specified. - `account` CaptureAccount — An object within the capture request that specifies the details of the account to which the funds should be routed, different from the initially requested account. This ensures that the captured funds are directed to the correct destination as per the specific routing requirements. - `id` string, required — The unique identifier of the account where the captured funds will be routed. This ID corresponds to an existing account in the system and is used to specify the destination for the capture transaction. - `splits` CaptureSplitResponse[] - `id` string, required - `status` string, required — The current state of this split. `pending` while the split is queued, `success` once the funds have been routed, `failed` if processing errored, `refunded` if the split was reversed. - `split_key` string — A customizable text field for users to input their own identifier for the split. - `split_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". - `account` object — The account to receive the split funds - `id` string, required - `value` number, double, required — 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. - `clearing_date` string, date — The clearing date refers to the specific date when a financial transaction is finalized and the funds are transferred from one account to another. This is the point at which the payment is officially completed and the amount is debited from the payer’s account and credited to the payee’s account. - `margin_account` object — The account to which the margin value should be routed. This field specifies the destination account for the margin portion of the funds, ensuring that the correct recipient receives the designated margin value. - `id` string, required - `margin_value` number, double — The margin amount to be deducted from this split - `reward` object — Reward credits generated from this split. The credits are associated with the customer provided at the top level of the payment request and can only be redeemed by that customer. Reward funds expire after the specified period. - `account` object, required — The account to which the reward credits are routed. - `id` string, required - `value` number, double, required — The reward amount generated from this split. - `expiration_date` string, date, required — The date until which the reward credits are valid. - `reverts` SplitReverts - `id` string, uuid — The unique identifier for the split associated with the capture. - `value` number, double — The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places (e.g., "100.00"). The value must be greater than or equal to 0.5. - `margin_value` number, double — The monetary amount designated as the margin in a split payment. This field is formatted as a double, and will be rounded to two decimal places (e.g., "10.00"). The value must be less than the total value of the split. This specifies the portion of the funds that should be routed to the margin account. - `reward_redemption` object — Reward credits redeemed in this payment. - `account` object - `id` string, required - `value` number, double — The redeemed reward amount. - `key` string - `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". - `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. - `expiration_time` string - `currency` 'EUR' — ISO 4217 currency code. If not specified, the default currency is set to EUR. - `customer` Customer — The Customer object contains the necessary details about the customer involved in the transaction. This includes identification information, contact details, and preferences. All fields are optional unless specified otherwise. - `id` string, uuid — Unique identifier for the customer. When provided, it links the transaction to an existing customer record. - `name` string — Full name of the customer. This is typically displayed on receipts and statements. - `email` string, email — Customer's email address. Used for sending receipts, notifications, and payment confirmations. - `phone` string — The contact phone number of the customer, excluding the country code indicator (e.g., "+351"). This field is used for communication purposes. If the payment method is MB WAY, the phone_number is required and is used to send the MB WAY push notification. - `phone_indicative` string — The country code indicator for the customer's phone number (e.g., "351" for Portugal). This field is used in conjunction with the phone number to ensure proper international dialing and communication. - `fiscal_number` string — Customer's tax identification number or fiscal number. Format may vary by country. - `key` string — A customizable text field for users to input their own identifier for the customer. This can be any string that helps the user uniquely identify the customer in their own system. - `language` 'PT' | 'EN' | 'ES' — Preferred language for customer communications. Uses ISO 639-1 language codes. - `method` SingleDetailMethodResponse - `type` 'CC' | 'DD' | 'VI' | 'MBW' | 'MB' | 'AP' | 'GP' | 'SW' | 'IPP' - `status` 'active' | 'deleted' | 'pending' - `sdd_mandate` SddMandateResponseOnDetail — SDD Mandate information as returned in detail responses - `id` string — Mandate ID - `iban` string — International Bank Account Number (IBAN) in standard format - `key` string — Mandate key - `name` string — Account holder name - `email` string, email — Account holder email - `phone` string — Account holder phone - `account_holder` string — Account holder name as registered with bank - `country_code` string — Country code - `max_num_debits` string — Maximum number of debits allowed - `billing_entity` string — Billing entity identifier - `reference_adc` string - `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 - `paid_at` string - `transactions` PaymentTransactions[] - `id` string, uuid — Unique identifier for the transaction - `key` string — Merchant identification key - `created_at` string, date-time — When the transaction was created - `date` string, date-time — Transaction date - `values` object — Transaction value breakdown - `requested` number, double — Requested amount - `paid` number, double — Amount actually paid - `fixed_fee` number, double — Fixed fee charged - `variable_fee` number, double — Variable fee charged - `tax` number, double — Tax amount - `transfer` number, double — Amount transferred to merchant - `transfer_date` string, date-time — When the transfer occurred - `transfer_batch` string — Transfer batch identifier - `method` string — Payment method used - `document_number` string — Document number for the transaction - `descriptive` string — Transaction description - `payment_status` 'pending' | 'paid' | 'authorised' | 'error' | 'deleted' | 'failed' | 'active' — Indicates the current status of the payment. Possible values include: "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 - `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)