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

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

Get Account Config

Request

Security
accountId and apiKey
curl -i -X GET \
  https://api.test.easypay.pt/2.0/config \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'

Responses

OK

Bodyapplication/json
genericstring

URL for generic notification.

authorisationstring

URL for authorisation notification.

transactionstring

URL for transaction notification.

visa_fwdstring

URL for redirect clients on credit card forward.

visa_detailstring

URL for credit card payment detail.

accountstring(uuid)

The UUID of the related account.

Example: "b2080452-bad1-4455-8ae7-9f5ea552a274"
client_idstring

The id of the related client.

Example: "EASYP030002"
payment_methodsArray of strings

The available payments for the related account.

Response
application/json
{
  "generic": "https://www.easypay.pt/generic",
  "authorisation": "https://www.easypay.pt/authorisation",
  "transaction": "https://www.easypay.pt/transaction",
  "visa_fwd": "https://www.easypay.pt/visa_fwd",
  "visa_detail": "https://www.easypay.pt/visa_detail",
  "account": "b2080452-bad1-4455-8ae7-9f5ea552a274",
  "client_id": "EASYP030002",
  "payment_methods": [
    "mb"
  ]
}

Patch Account Config

Request

This endpoint is useful for setting up the correct URLs for event notifications. For more details, see Notifications-Webhooks.

Security
accountId and apiKey
Bodyapplication/jsonrequired

Configuration object to edit an account.

genericstring<= 255 characters

URL for generic notification.

Example: "https://www.easypay.pt/generic"
authorisationstring<= 255 characters

URL for authorisation notification.

Example: "https://www.easypay.pt/authorisation"
transactionstring<= 255 characters

URL for transaction notification.

Example: "https://www.easypay.pt/transaction"
visa_fwdstring<= 255 characters

URL for redirect clients on credit card forward.

Example: "https://www.easypay.pt/visa_fwd"
visa_detailstring<= 255 characters

URL for credit card payment detail.

Example: "https://www.easypay.pt/visa_detail"
curl -i -X PATCH \
  https://api.test.easypay.pt/2.0/config \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92' \
  -H 'Content-Type: application/json' \
  -d '{
    "generic": "https://www.easypay.pt/generic",
    "authorisation": "https://www.easypay.pt/authorisation",
    "transaction": "https://www.easypay.pt/transaction",
    "visa_fwd": "https://www.easypay.pt/visa_fwd",
    "visa_detail": "https://www.easypay.pt/visa_detail"
  }'

Responses

OK

Bodyapplication/json
genericstring

URL for generic notification.

authorisationstring

URL for authorisation notification.

transactionstring

URL for transaction notification.

visa_fwdstring

URL for redirect clients on credit card forward.

visa_detailstring

URL for credit card payment detail.

accountstring(uuid)

The UUID of the related account.

Example: "b2080452-bad1-4455-8ae7-9f5ea552a274"
client_idstring

The id of the related client.

Example: "EASYP030002"
payment_methodsArray of strings

The available payments for the related account.

Response
application/json
{
  "generic": "https://www.easypay.pt/generic",
  "authorisation": "https://www.easypay.pt/authorisation",
  "transaction": "https://www.easypay.pt/transaction",
  "visa_fwd": "https://www.easypay.pt/visa_fwd",
  "visa_detail": "https://www.easypay.pt/visa_detail",
  "account": "b2080452-bad1-4455-8ae7-9f5ea552a274",
  "client_id": "EASYP030002",
  "payment_methods": [
    "mb"
  ]
}

Checkout

Embedded payment form solution for websites

Operations

System

System health check endpoints

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