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

Shows authorisation details

Pedido

Retrieves the details of an authorisation

Segurança
accountId and apiKey
Caminho
idstring(uuid)obrigatório

Resource Identification

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

Respostas

OK

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

Exemplo: "c6056234-a3f9-42de-b944-3ed793fcb6bb"
statusstring

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

  • waiting: The payment instruction has been given, but the chosen payment method requires confirmation from an external entity before the status of the operation is finalized.
  • pending: This is the initial state, and it means that the authorisation is queued.
  • success: The authorisation has been completed successfully.
  • failed: The authorisation could not be completed due to an error or issue. This field provides a clear indication of the current state of the authorisation, helping users understand its progress and outcome.
Enum"waiting""pending""failed""canceled""deleted""success"
messagestring

A string human-readable message included in the response.

keystring

This can be any string that helps the user uniquely identify or reference the resource in their own system.

customerobject(customer)

The Customer object contains the necessary details about the customer involved in the transaction. This includes identification information, contact details, and preferences. All fields are optional unless specified otherwise.

methodobject
currencystring

The currency code in ISO 4217 format (e.g., "EUR" for Euro). This field specifies the type of currency used in financial operation

Exemplo: "EUR"
valuenumber(double)

The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places.

Exemplo: 125.89
value_capturednumber(double)

The monetary amount requested for the capture transaction. This field is formatted as a double, and will be rounded to two decimal places.

Exemplo: 10.87
transactionsArray of objects(payment-transactions)
Resposta
application/json
{
  "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb",
  "status": "waiting",
  "message": "string",
  "key": "string",
  "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": {
    "type": "mb",
    "status": "waiting",
    "url": "https://cc.easypay.pt/v3/public/card-details/cec55ab6-bda3-4ab3-af22-04d2ad2c046a",
    "last_four": "1354",
    "card_type": "VISA",
    "expiration_date": "2019-08-24T14:15:22Z"
  },
  "currency": "EUR",
  "value": 125.89,
  "value_captured": 10.87,
  "transactions": [
    { … }
  ]
}

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

Checkout

Embedded payment form solution for websites

Operações

System

System health check endpoints

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