Skip to content

Authorisations

Operations for managing payment authorisations

Operations

Shows authorisation details

Request

Retrieves the details of an authorisation

Required scope: authorisation:read

Security
accountId and apiKey
Path
idstring, (uuid)required

Resource Identification

curl -i -X GET \
  'https://api.test.easypay.pt/2.0/authorisation/{id}' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'

Responses

OK

Bodyapplication/json
idstring

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

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

A string human-readable message included in the response.

keystring

This can be any string that helps the user uniquely identify or reference the resource in their own system.

customerobject(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.

methodobject
currencystring

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"
valuenumber, (double)

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_capturednumber, (double)

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
transactionsArray of objects(payment-transactions)
Response
{
  "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb",
  "status": "waiting",
  "message": "string",
  "key": "string",
  "customer": {
    "id": "649e88cf-0b78-4c36-8f99-33f5ebb812a1",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": "911234567",
    "phone_indicative": "+351",
    "fiscal_number": "PT123456789",
    "key": "customer Key Example",
    "language": "PT"
  },
  "method": {
    "type": "MB",
    "status": "waiting",
    "url": "https://cc.easypay.pt/v3/public/card-details/cec55ab6-bda3-4ab3-af22-04d2ad2c046a",
    "last_four": "1354",
    "card_type": "VISA",
    "expiration_date": "2019-08-24T14:15:22Z"
  },
  "currency": "EUR",
  "value": 125.89,
  "value_captured": 10.87,
  "transactions": [
    { … }
  ]
}