Skip to content

Easypay Payments API (2.0)

Terms conditions and legal terms
Privacy Policy

Download OpenAPI description
openapi.json
openapi.yaml
Overview
Easypay Documentation
correio@easypay.pt
License
MIT
Languages
Servers
Sandbox
https://api.test.easypay.pt/2.0
Production
https://api.prod.easypay.pt/2.0

Single Payment

Create and manage one-time payment transactions

Operations

Frequent Payment

Tokenize payment details for variable on-demand charges

Operations

Subscription Payment

Set up and manage automated recurring payments

Operations

Captures

Operations for managing payment captures

Operations

Authorisations

Operations for managing payment authorisations

Operations

Voids

Operations for managing payment voids

Operations

Refunds

Operations for managing payment refunds

Operations

Chargebacks

Operations for managing chargebacks

Operations

Notifications / Webhooks

Configure and manage webhook notifications for payment events

Webhooks

Generic NotificationWebhook

Request

We will send you this json in our notifications

Security
BasicAuth
Bodyapplication/jsonrequired

Notification Payload

idstring(uuid)

ID of the related notified resource

Example: "1bbc14c3-8ca8-492c-887d-1ca86400e4fa"
keystring

Merchant identification key

Example: "Example Key"
typestring
Enum"authorisation""capture""frequent_create""void""refund""chargeback""subscription_create""subscription_capture""out_payment"
Example: "capture"
statusstring
Enum"failed""success"
Example: "success"
messagesArray of strings
Example: ["Your request was successfully created"]
datestring
Example: "2022-01-01 10:20:30"
application/json
{
  "id": "1bbc14c3-8ca8-492c-887d-1ca86400e4fa",
  "key": "Example Key",
  "type": "capture",
  "status": "success",
  "messages": [
    "Your request was successfully created"
  ],
  "date": "2022-01-01 10:20:30"
}

Responses

Indicates that the data was received successfully

Headers
X-Easypay-Codestring

A user defined code

Authorisation NotificationWebhook

Request

We will send you this json in our notification

Security
BasicAuth
Bodyapplication/jsonrequired

Notification Payload

idstring(uuid)

The unique identifier for the notification

Example: "131d25c8-404d-4075-a264-67091620b0b3"
valuestring

The monetary amount

Example: "10.5"
currencystring

ISO 4217 currency code

Example: "EUR"
keystring

Merchant identification key

Example: "Example Key"
expiration_timestring(date-time)

The expiration time for the payment

Example: "2025-12-26T10:32:45Z"
methodstring

Payment method used

Example: "MBW"
customerobject
accountobject
authorisationobject
application/json
{
  "id": "131d25c8-404d-4075-a264-67091620b0b3",
  "value": "10.5",
  "currency": "EUR",
  "key": "Example Key",
  "expiration_time": "2025-12-26T10:32:45Z",
  "method": "MBW",
  "customer": {
    "id": "00ef522f-6a34-4d03-8448-834830cabb91",
    "name": "Josefa Gomes",
    "email": "customer@example.com",
    "phone": "921234567",
    "phone_indicative": "+351",
    "fiscal_number": "PT123456789",
    "key": "Customer Key"
  },
  "account": {
    "id": "131d25c8-404d-4075-a264-67091620b066"
  },
  "authorisation": {
    "id": "131d25c8-404d-4075-a264-67091620b0b3"
  }
}

Responses

Indicates that the data was received successfully

Headers
X-Easypay-Codestring

A user defined code

Transaction NotificationWebhook

Request

We will send you this json in our notification

Security
BasicAuth
Bodyapplication/jsonrequired

Notification Payload

idstring(uuid)

The unique identifier for the notification

Example: "ad3a0bb3-15a0-462c-8049-4abeb2e11f11"
valuestring

The monetary amount

Example: "10.5"
currencystring

ISO 4217 currency code

Example: "EUR"
keystring

Merchant identification key

Example: "Example Key"
expiration_timestring(date-time)

The expiration time for the payment

Example: "2025-12-26T10:32:45Z"
methodstring

Payment method used

Example: "MBW"
customerobject
accountobject
transactionobject
application/json
{
  "id": "ad3a0bb3-15a0-462c-8049-4abeb2e11f11",
  "value": "10.5",
  "currency": "EUR",
  "key": "Example Key",
  "expiration_time": "2025-12-26T10:32:45Z",
  "method": "MBW",
  "customer": {
    "id": "4a908674-3bfb-47e5-b518-052a5e14b8fb",
    "name": "Josefa Gomes",
    "email": "customer@example.com",
    "phone": "911234567",
    "phone_indicative": "+351",
    "fiscal_number": "PT123456789",
    "key": "Customer Key"
  },
  "account": {
    "id": "3ab50128-567c-4624-9268-04c5899ffb66"
  },
  "transaction": {
    "id": "3ab50128-567c-4624-9268-04c5899ffb60",
    "key": "Transaction_key",
    "type": "capture",
    "date": "2025-12-26T10:32:45Z",
    "transfer_date": "2025-12-29T00:00:00Z",
    "document_number": "MARCEL0208220658120320251226103247",
    "values": { … }
  }
}

Responses

Indicates that the data was received successfully

Headers
X-Easypay-Codestring

A user defined code

Reports

Access transaction and ledger reports

Operations

Out Payment

Transfer funds from Easypay accounts to SEPA bank accounts

Operations

Config

Configure account URLs for notifications and credit card transactions

Operations

Checkout

Embedded payment form solution for websites

Operations

System

System health check endpoints

Operations
© 2026 easypay - Bank of Portugal N.º 8706