Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB
Single Payment

Shows single payment details

Retrieve a single payment details

Required scope: <code style="background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em">single:read</code>

get/single/{id}

Path parameters

idstring uuid required

Resource Identification

Response

OK

idstring
created_atstring
keystring
descriptivestring

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

valuenumber double

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.

expiration_timestring
currency'EUR'

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

paid_atstring
payment_status'pending' | 'paid' | 'authorised' | 'error' | 'deleted' | 'failed' | 'active'

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.

Example response

{
  "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb",
  "captures": [
    {
      "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb",
      "descriptive": "Payment of Invoice Nº 1982652",
      "transaction_key": "Payment of Invoice Nº 1982652",
      "capture_date": "2024-06-30",
      "splits": [
        {
          "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb",
          "status": "pending",
          "split_key": "Payment of Invoice Nº 1982652",
          "split_descriptive": "Payment of Invoice Nº 1982652",
          "account": {
            "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb"
          },
          "value": 17.5,
          "clearing_date": "2024-06-30",
          "margin_account": {
            "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb"
          },
          "margin_value": 0.25,
          "reward": {
            "account": {
              "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb"
            },
            "value": 1,
            "expiration_date": "2027-04-02"
          },
          "reverts": {
            "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb",
            "value": 17.5,
            "margin_value": 0.25
          }
        }
      ],
      "reward_redemption": {
        "account": {
          "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb"
        },
        "value": 5
      }
    }
  ],
  "key": "Payment of Invoice Nº 1982652",
  "descriptive": "Payment of Invoice Nº 1982652",
  "value": 17.5,
  "currency": "EUR",
  "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": {
    "sdd_mandate": {
      "id": "50389142122",
      "iban": "PT50002700000001234567833",
      "key": "Sdd mandate Key Example",
      "name": "John Doe",
      "email": "john.doe@easypay.pt",
      "phone": "911345678",
      "account_holder": "John Doe",
      "country_code": "PT",
      "max_num_debits": "12",
      "billing_entity": "PT16103627",
      "reference_adc": "987654321123"
    },
    "mbway": {
      "phone": "+351911234567"
    },
    "last_four": "1234",
    "url": "https://cc.easypay.pt/v3/public/card-details/cec55ab6-bda3-4ab3-af22-04d2ad2c046a",
    "entity": "11683",
    "reference": "665876931",
    "iban": "PT50002700000001234567833"
  },
  "transactions": [
    {
      "id": "4fb3ac57-c7fe-4157-aeb7-4362ae24deec",
      "key": "Merchant identification key",
      "created_at": "2025-05-30T17:21:46Z",
      "date": "2025-05-30T17:21:47Z",
      "values": {
        "requested": 12.55,
        "paid": 12.55,
        "fixed_fee": 0.07,
        "variable_fee": 0.09,
        "tax": 0.04,
        "transfer": 12.35
      },
      "transfer_date": "2025-06-02T00:00:00Z",
      "method": "mbw",
      "document_number": "MARCEL0208220628294020250530172147",
      "descriptive": "Descriptive Josefa"
    }
  ],
  "payment_status": "paid",
  "multibanco": {
    "expiration_time": "2025-09-28T12:41:08Z",
    "start_time": "2025-08-26T12:41:09Z"
  },
  "terminal": {
    "id": "458b2fc4-3092-4de3-abd4-fe1600c09420"
  },
  "notification": {
    "customer_method_instructions_email": true
  }
}