Shows single payment details

Pedido

Retrieve a single payment details

Required scope: single:read

Segurança

accountId and apiKey

Caminho

idstring, (uuid)obrigatório

Resource Identification

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

Respostas

OK

Corpoapplication/json

idstring(identifier)

Exemplo:"c6056234-a3f9-42de-b944-3ed793fcb6bb"

created_atstring

capturesArray of objects(SingleCaptureFull)

keystring

Exemplo:"Payment of Invoice Nº 1982652"

descriptivestring, <= 255 characters(Descriptive)

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

Exemplo:"Payment of Invoice Nº 1982652"

valuenumber, (double), [ 0.5 .. 999999.99 ](Value)

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.

Exemplo:17.5

expiration_timestring

currencystring(Currency)

ISO 4217 currency code. If not specified, the default currency is set to EUR.

Value:"EUR"

Exemplo:"EUR"

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(SingleDetailMethodResponse)

paid_atstring

transactionsArray of objects(payment-transactions)

payment_statusstring(SinglePaymentStatus)

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"

Exemplo:"paid"

multibancoobject(ResponseMultibanco)

An object that holds the details specific to a Multibanco transaction response.

terminalobject(ResponseTerminal)

Present when method.type is IPP.

notificationobject(Notification)

Notification settings for payment methods.

Resposta

{
  "id": "2f1a5d8c-4b2f-4f3a-9e49-5d0f8b4f2d91",
  "created_at": "2024-07-01 12:00:00",
  "key": "IPP payment",
  "descriptive": "IPP payment",
  "value": 45,
  "expiration_time": "2024-07-01 12:00:00",
  "currency": "EUR",
  "customer": {
    "id": "2a88e01f-53f6-4c2c-8cf9-9dd5bff1d7b4",
    "name": "Mar*** Sil***",
    "email": "mar***@example.com",
    "phone": "912***345",
    "phone_indicative": "+351",
    "fiscal_number": "PT123***45",
    "key": "store 123",
    "language": "PT"
  },
  "method": {
    "type": "IPP",
    "status": "active"
  },
  "paid_at": "2024-07-01 12:05:00",
  "payment_status": "paid",
  "terminal": {
    "id": "458b2fc4-3092-4de3-abd4-fe1600c09420"
  }
}