--- title: "Shows authorisation details" method: GET path: "/authorisation/{id}" tags: ["Authorisations"] --- # Shows authorisation details `GET /authorisation/{id}` Retrieves the details of an authorisation **Required scope:** authorisation:read ## Path parameters - `id` string, uuid, required ## Response `200` OK - AuthorisationGetByIdResponse - `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. - `status` 'waiting' | 'pending' | 'failed' | 'canceled' | 'deleted' | 'success' — 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. - `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` 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` object - `type` 'MB' | 'CC' | 'DD' | 'MBW' — 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. - `status` 'waiting' | 'pending' | 'active' | 'failed' | 'canceled' | 'deleted' - `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. - `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. - `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. - `expiration_date` string, date-time — 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 - `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. - `value_captured` number, double — The monetary amount requested for the capture transaction. This field is formatted as a double, and will be rounded to two decimal places. - `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 ## Other responses - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `429` — Too Many Requests - `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)