# Shows authorisation details

Retrieves the details of an authorisation

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

## Path parameters:

  - `id` (string, required)
    Resource Identification

## Response 200 fields (application/json):

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

  - `status` (string)
    Indicates the current status of the authorisation. Possible values include:
- waiting: The payment 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.
- success: The authorisation has been completed successfully.
- failed: The authorisation could not be completed due to an error or issue.
This field provides a clear indication of the current state of the authorisation, helping users understand its progress and outcome.
    Enum: "waiting", "pending", "failed", "canceled", "deleted", "success"

  - `message` (string)
    A string human-readable message included in the response.

  - `key` (string)
    This can be any string that helps the user uniquely identify or reference the resource in their own system.

  - `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` (string)
    Specifies the payment method type used for the authorisation. Possible values include:
- mb: Multibanco
- cc: Credit Card
- dd: Direct Debit
- mbw: MB WAY
- This field helps to identify the payment method chosen by the customer for the transaction.
    Enum: "mb", "cc", "dd", "mbw"

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

  - `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.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: "1354"

  - `method.card_type` (any)
    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.expiration_date` (string)
    The timestamp indicating when the resource will expire. It is formatted as "YYYY-MM-DD HH:MM

  - `currency` (string)
    The currency code in ISO 4217 format (e.g., "EUR" for Euro). This field specifies the type of currency used in financial operation
    Example: "EUR"

  - `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: 125.89

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

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

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