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

Shows void details

Request

Security
accountId and apiKey
Path
idstring(uuid)required

Resource Identification

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

Responses

OK

Bodyapplication/json
statusany

Indicates the current status of the refund. Possible values include:

  • processing: This is the initial state, and it means that the void is queued.
  • success: The void has been completed successfully.
  • failed: The void could not be completed due to an error or issue. This field provides a clear indication of the current state of the refund, helping users understand its progress and outcome.
Enum"success""processing""failed"
idstring(uuid)

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.

transaction_keystring

A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system.

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

authorisationobject
Response
application/json
{
  "status": "success",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "transaction_key": "string",
  "descriptive": "string",
  "authorisation": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "status": "waiting",
    "key": "string",
    "customer": { … },
    "method": { … },
    "currency": "EUR",
    "value": 15.78
  }
}

Voids a Single Auth or Frequent Auth

Request

Security
accountId and apiKey
Path
idstring(uuid)required

Resource Identification

Bodyapplication/jsonrequired

Void details

descriptivestring<= 255 charactersrequired

This will appear in the bank statement/mbway application.

transaction_keystring<= 50 characters

Your internal key identifying this void.

curl -i -X POST \
  'https://api.test.easypay.pt/2.0/void/{id}' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92' \
  -H 'Content-Type: application/json' \
  -d '{
    "descriptive": "string",
    "transaction_key": "string"
  }'

Responses

Created

Bodyapplication/json
statusstring
Example: "ok"
messageArray of strings

An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.

Example: ["Your request was successfully created"]
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: "8010e7d5-9985-4ae3-b1bf-6b70019439c7"
Response
application/json
{
  "status": "ok",
  "message": [
    "Your request was successfully created"
  ],
  "id": "8010e7d5-9985-4ae3-b1bf-6b70019439c7"
}

Refunds

Operations for managing payment refunds

Operations

Chargebacks

Operations for managing chargebacks

Operations

Notifications / Webhooks

Configure and manage webhook notifications for payment events

Webhooks

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