# Shows void details

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

## Path parameters:

  - `id` (string, required)
    Resource Identification

## Response 200 fields (application/json):

  - `status` (any)
    Indicates the current status of the refund. Possible values include: 
- processing: This is the initial state, and it means that the void is queued. 
- success: The void has been completed successfully. 
- failed: The void could not be completed due to an error or issue. This field provides a clear indication of the current state of the refund, helping users understand its progress and outcome.
    Enum: "success", "processing", "failed"

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

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

  - `authorisation` (object)

  - `authorisation.status` (any)
    - waiting: The authorisation instruction has been given, but the chosen payment method requires confirmation from an external entity before the status of the operation is finalized.
- pending: This is the initial state, and it means that the authorisation is queued.
- failed: The authorisation could not be completed due to an error or issue.
- canceled: The authorisation has been canceled.
- deleted: The authorisation has been deleted.
- success: The authorisation has been created successfully.
    Enum: "waiting", "pending", "failed", "canceled", "deleted", "success"

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

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

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

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

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

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

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

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

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

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

  - `authorisation.method` (object)

  - `authorisation.method.type` (any)
    Specifies the type of payment method being used for the transaction. 

TYPE | DESCRIPTION |
---------|----------|
 cc  | Credit Card |
 mbw | Multibanco |
 ap  | Apple Pay |
 gp  | Google Pay |
 sw  | Samsung Wallet |
    Enum: "cc", "mbw", "ap", "gp", "sw"

  - `authorisation.method.status` (any)
    Enum: "active", "inactive"

  - `authorisation.currency` (string)
    Enum: "EUR"

  - `authorisation.value` (number)
    The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places.
    Example: 15.78

## Response 401 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 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 429 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.