Saltar para o conteúdo

Easypay Payments API (2.0)

Terms conditions and legal terms
Privacy Policy

Transferir a descrição da OpenAPI
openapi.json
openapi.yaml
Visão geral
Easypay Documentation
correio@easypay.pt
Licença
MIT
Idiomas
Servidores
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

Operações

Frequent Payment

Tokenize payment details for variable on-demand charges

Operações

Subscription Payment

Set up and manage automated recurring payments

Operações

Captures

Operations for managing payment captures

Operações

Authorisations

Operations for managing payment authorisations

Operações

Voids

Operations for managing payment voids

Operações

Refunds

Operations for managing payment refunds

Operações

Chargebacks

Operations for managing chargebacks

Operações

Notifications / Webhooks

Configure and manage webhook notifications for payment events

Webhooks

Reports

Access transaction and ledger reports

Operações

Out Payment

Transfer funds from Easypay accounts to SEPA bank accounts

Operações

Config

Configure account URLs for notifications and credit card transactions

Operações

Get Account Config

Pedido

Segurança
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'

Respostas

OK

Corpoapplication/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.

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

The id of the related client.

Exemplo: "EASYP030002"
payment_methodsArray of strings

The available payments for the related account.

Resposta
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

Pedido

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

Segurança
accountId and apiKey
Corpoapplication/jsonobrigatório

Configuration object to edit an account.

genericstring<= 255 characters

URL for generic notification.

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

URL for authorisation notification.

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

URL for transaction notification.

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

URL for redirect clients on credit card forward.

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

URL for credit card payment detail.

Exemplo: "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"
  }'

Respostas

OK

Corpoapplication/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.

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

The id of the related client.

Exemplo: "EASYP030002"
payment_methodsArray of strings

The available payments for the related account.

Resposta
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

Operações

System

System health check endpoints

Operações
© 2026 easypay - Bank of Portugal N.º 8706