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

Report Ledger

Request

The /reports/ledger endpoint provides access to detailed reports of ledger entries within the Easypay reconciliation system. This endpoint retrieves comprehensive financial data for each transaction recorded in the ledger, including captures, refunds, fees, and other financial operations, and it was designed to help users generate precise and relevant financial reports, aiding in effective account reconciliation and financial management.

By using this endpoint, clients can obtain an itemized list of all ledger entries, including relevant financial details such as transaction amounts, fees, taxes, and net transferred amounts. The data returned by this endpoint is ideal for accounting, auditing, and financial analysis purposes, as it ensures transparency and accuracy in financial reporting.

Security
accountId and apiKey
Query
cursorstring

The cursor parameter is used for pagination. It specifies the pointer to the start of the next set of results in a sequence of paginated data. Typically, this is a unique identifier of the last item from the previous response. If not provided, the API fetches the first page of results.

limitnumber

The maximum number of records to return in a single response. This value determines how many items are included in each page of the results. The default value is 100, and the maximum allowable limit is 100. If not specified, the default limit will be used. Adjust the limit to control the size of the response and manage the data load for each request.

Default 100
created_atstring

Filter records by creation datetime interval in UTC. Maximum allowed range is 30 days. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM).

Example: created_at=interval(2006-01-02 15:04,2006-01-02 15:04)
transaction_typestring

LedgerTransactionType is a string enum that represents various types of financial transactions recorded in a ledger. Each transaction type is abbreviated with a code and corresponds to a specific financial operation.

The following are the possible values and their descriptions:

• CP (Capture): Represents the capture of funds, typically after a payment authorization. This transaction finalizes a payment and moves the funds from the payer's account to the payee's account.

• RF (Refund): Represents a refund transaction where previously captured funds are returned to the payer's account. This transaction often occurs when a customer returns goods or services.

• RV (Revert): Indicates a revert transaction that undoes a previously made transaction, often used to correct errors or reverse transactions.

• SP (Split Payment): Represents a split payment transaction, where a payment is divided among multiple recipients or for different purposes within the same transaction.

• FEE (Fee): Represents a fee transaction, which is a charge applied for a specific service or transaction. This could include service fees, processing fees, or other types of charges.

• MAN (Manual Movement): Represents a manual movement of funds, typically entered manually by an administrator or accountant to adjust balances or correct errors.

• TB (Bank Transfer): Represents a bank transfer transaction, where funds are moved between different bank accounts. This can be a transfer within the same bank or across different banks.

• OT (Out Transfer): Indicates an out transfer transaction, where funds are transferred out of the current ledger or account to another external account or ledger.

• CB (Chargeback): Represents a chargeback transaction, typically initiated by the payer's bank to reverse a disputed or fraudulent transaction. This transaction withdraws the funds from the payee's account and returns them to the payer.

• OP (Out Payment): Represents an out payment transaction, where funds are paid out from the ledger to an external party or account. This transaction is usually used to settle debts or make external payments.

• TF (Transfer Funds): Represents a movement of funds from an Easypay account to a bank account.

Enum"CP""RF""RV""FEE""SP""MAN""TB""OT""CB""OP"
Example: transaction_type=CP
transfer_batchstring

Filter by LedgerTransferBatch

Example: transfer_batch=584
curl -i -X GET \
  'https://api.test.easypay.pt/2.0/report/ledger?cursor=string&limit=100&created_at=interval%282006-01-02+15%3A04%2C2006-01-02+15%3A04%29&transaction_type=CP&transfer_batch=584' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'

Responses

OK

Body
metadataobject(metadata-cursor)

An object containing additional information about the response. It includes details that help manage and navigate the retrieved data.

dataArray of objects(LedgerEntry)
Response
{
  "metadata": {
    "next_cursor": "lL_j7ilk7rc",
    "count": 10
  },
  "data": [
    { … }
  ]
}

Report Transactions

Request

List your transactions

Security
accountId and apiKey
Query
start_datestring(Y-m-d H:i)

Filter from this date (inclusive). The date and time must be provided in UTC, using the format Y-m-d H:i.

end_datestring(Y-m-d H:i)

Filter until this date (inclusive). The date and time must be provided in UTC, using the format Y-m-d H:i.

pagenumber

Page Number

records_per_pagenumber

Limit records per page (Max: 2500)

Default 20
curl -i -X GET \
  'https://api.test.easypay.pt/2.0/report/transactions?start_date=string&end_date=string&page=0&records_per_page=20' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'

Responses

OK

Body
metaobject(metadata-page)required

The Pagination object contains detailed information about the pagination of a collection of records.

This object is used to provide navigation and context for paginated results, allowing users to easily move between pages and understand the scope of the dataset.

meta.​pageobjectrequired

An object containing information about the pagination of pages within the collection.

meta.​page.​currentintegerrequired

The current page number being viewed.

meta.​page.​totalintegerrequired

The total number of pages available in the collection.

meta.​recordsobjectrequired

An object containing information about the records within the collection.

meta.​records.​totalintegerrequired

The total number of records available in the collection.

meta.​records.​per_pageintegerrequired

The number of records displayed per page.

meta.​linksobject

An object containing URLs for navigation between different pages of the collection.

dataArray of objects(transaction-report-data)
Response
{
  "meta": {
    "page": { … },
    "records": { … },
    "links": { … }
  },
  "data": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

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