# Shows single payment details

Retrieve a single payment details

Endpoint: GET /single/{id}
Version: 2.0
Security: accountId, apiKey

## Path parameters:

  - `id` (string, required)
    Resource Identification

## Response 200 fields (application/json):

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

  - `created_at` (string)

  - `captures` (array)

  - `captures.status` (string, 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.
    Enum: "delayed", "waiting", "success", "pending", "failed", "refunded"

  - `captures.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".
    Example: "Payment of Invoice Nº 1982652"

  - `captures.transaction_key` (string)
    Example: "Payment of Invoice Nº 1982652"

  - `captures.capture_date` (string)
    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.
    Example: "2024-06-30"

  - `captures.account` (object)
    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.

  - `captures.account.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.

  - `captures.splits` (array)

  - `captures.splits.split_key` (string)
    A customizable text field for users to input their own identifier for the split.
    Example: "Payment of Invoice Nº 1982652"

  - `captures.splits.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".
    Example: "Payment of Invoice Nº 1982652"

  - `captures.splits.account` (object)
    The account to receive the split funds

  - `captures.splits.value` (number, 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.
    Example: 17.5

  - `captures.splits.clearing_date` (string)
    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.
    Example: "2024-06-30"

  - `captures.splits.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.

  - `captures.splits.margin_value` (number)
    The margin amount to be deducted from this split
    Example: 0.25

  - `captures.splits.reverts` (object)

  - `captures.splits.reverts.id` (string)
    The unique identifier for the split associated with the capture.
    Example: "c6056234-a3f9-42de-b944-3ed793fcb6bb"

  - `captures.splits.reverts.value` (number)
    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.
    Example: 17.5

  - `captures.splits.reverts.margin_value` (number)
    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.
    Example: 0.25

  - `key` (string)
    Example: "Payment of Invoice Nº 1982652"

  - `expiration_time` (string)

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

  - `customer` (object)
    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.

  - `customer.id` (string)
    Unique identifier for the customer. When provided, it links the transaction to an existing customer record.
    Example: "649e88cf-0b78-4c36-8f99-33f5ebb812a1"

  - `customer.name` (string)
    Full name of the customer. This is typically displayed on receipts and statements.
    Example: "John Doe"

  - `customer.email` (string)
    Customer's email address. Used for sending receipts, notifications, and payment confirmations.
    Example: "john.doe@example.com"

  - `customer.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 MBWAY, the phone_number is required and is used to send the MBWAY push notification.
    Example: "911234567"

  - `customer.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.
    Example: "+351"

  - `customer.fiscal_number` (string)
    Customer's tax identification number or fiscal number. Format may vary by country.
    Example: "PT123456789"

  - `customer.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.
    Example: "customer Key Example"

  - `customer.language` (string)
    Preferred language for customer communications. Uses ISO 639-1 language codes.
    Enum: "PT", "EN", "ES"

  - `method` (object)

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

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

  - `method.sdd_mandate` (object)
    SDD Mandate information as returned in detail responses

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

  - `method.sdd_mandate.iban` (string)
    International Bank Account Number (IBAN) in standard format

  - `method.sdd_mandate.key` (string)
    Mandate key
    Example: "Sdd mandate Key Example"

  - `method.sdd_mandate.name` (string)
    Account holder name
    Example: "John Doe"

  - `method.sdd_mandate.email` (string)
    Account holder email
    Example: "john.doe@easypay.pt"

  - `method.sdd_mandate.phone` (string)
    Account holder phone
    Example: "911345678"

  - `method.sdd_mandate.account_holder` (string)
    Account holder name as registered with bank
    Example: "John Doe"

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

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

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

  - `method.sdd_mandate.reference_adc` (string)
    Example: "987654321123"

  - `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"

  - `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"

  - `method.expiration_date` (string)

  - `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"

  - `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"

  - `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"

  - `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.

  - `paid_at` (string)

  - `transactions` (array)

  - `transactions.id` (string)
    Unique identifier for the transaction
    Example: "4fb3ac57-c7fe-4157-aeb7-4362ae24deec"

  - `transactions.key` (string)
    Merchant identification key
    Example: "Merchant identification key"

  - `transactions.created_at` (string)
    When the transaction was created
    Example: "2025-05-30T17:21:46Z"

  - `transactions.date` (string)
    Transaction date
    Example: "2025-05-30T17:21:47Z"

  - `transactions.values` (object)
    Transaction value breakdown

  - `transactions.values.requested` (number)
    Requested amount
    Example: 12.55

  - `transactions.values.paid` (number)
    Amount actually paid
    Example: 12.55

  - `transactions.values.fixed_fee` (number)
    Fixed fee charged
    Example: 0.07

  - `transactions.values.variable_fee` (number)
    Variable fee charged
    Example: 0.09

  - `transactions.values.tax` (number)
    Tax amount
    Example: 0.04

  - `transactions.values.transfer` (number)
    Amount transferred to merchant
    Example: 12.35

  - `transactions.transfer_date` (string)
    When the transfer occurred
    Example: "2025-06-02T00:00:00Z"

  - `transactions.transfer_batch` (string)
    Transfer batch identifier

  - `transactions.method` (string)
    Payment method used
    Example: "mbw"

  - `transactions.document_number` (string)
    Document number for the transaction
    Example: "MARCEL0208220628294020250530172147"

  - `transactions.descriptive` (string)
    Transaction description
    Example: "Descriptive Josefa"

  - `payment_status` (string)
    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.
    Enum: "pending", "paid", "authorised", "error", "deleted", "failed", "active"

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

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

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

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

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

  - `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 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.