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

List chargebacks

Pedido

This endpoint retrieves a list of chargebacks associated with your account. A Chargeback is a mandatory transaction reversal initiated by the consumer's card issuer or bank, usually due to a dispute over a transaction. When a chargeback occurs, the costumer effectively reverses the transaction, resulting in a debit of the disputed amount from the merchant's account. This endpoint allows you to view details of chargebacks, including the reason for the dispute, transaction amount, and status, providing insights into consumer disputes and their impact on your financials.

Segurança
accountId and apiKey
Consulta
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 limit parameter is used for pagination. It specifies the maximum number of entries to return in a single page of results. Max 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).

Exemplo: created_at=interval(2006-01-02 15:04,2006-01-02 15:04)
capture.idstring(uuid)

Filter chargebacks by capture UUID. Returns only chargebacks associated with the specified capture.

Exemplo: capture.id=c6056234-a3f9-42de-b944-3ed793fcb6bb
curl -i -X GET \
  'https://api.test.easypay.pt/2.0/chargeback?cursor=string&limit=0&created_at=interval%282006-01-02+15%3A04%2C2006-01-02+15%3A04%29&capture.id=c6056234-a3f9-42de-b944-3ed793fcb6bb' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'

Respostas

OK

Corpoapplication/json
dataArray of objects
metadataobject(metadata-cursor)

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

Resposta
application/json
{
  "data": [
    { … }
  ],
  "metadata": {
    "next_cursor": "lL_j7ilk7rc",
    "count": 10
  }
}

Shows chargeback details

Pedido

This endpoint retrieves the details of a specific chargeback by its unique identifier. A Chargeback is a mandatory transaction reversal initiated by the consumer's card issuer or bank, usually due to a dispute over a transaction.

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

Resource Identification

curl -i -X GET \
  'https://api.test.easypay.pt/2.0/chargeback/{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"
created_atstring

The timestamp indicating when the resource was created. It is formatted as "YYYY-MM-DD HH:MM".

Exemplo: "2006-01-02 15:04"
messagestring

The message field provides a human-readable explanation of the chargeback reason code, making it easier to understand the cause of the dispute without needing to interpret technical codes. This message clarifies the issue, such as incorrect account information, insufficient funds, or unauthorized transactions, and helps merchants quickly identify the nature of the problem.

Exemplo: "MD06 - Refund Request by End Customer"
codestring

The code field provides the specific SEPA or Visa/Masterd code associated with the chargeback. This code identifies the reason for the chargeback, offering insight into why the transaction was disputed by the consumer's bank or card issuer. SEPA reasons:

  • AC01: Incorrect Account Number
  • AC04: Closed Account Number
  • AC06: Blocked Account
  • AC13: Invalid Debitor Account Type
  • AG01: Transaction Forbidden
  • AG02: Invalid Bank Operation Code
  • AM04: Insufficient Funds
  • AM05: Duplication
  • BE05: Unrecognised Initiating Party
  • CNOR: Creditor Bank is Not Registered
  • DNOR: Debitor Bank is Not Registered
  • ED05: Settlement Failed
  • FF01: Invalid File Format
  • MD01: No Mandate
  • MD02: Missing Mandatory Mandate Information
  • MD06: Refund Request by End Customer
  • MD07: End Customer Deceased
  • MS02: Not Specified Reason Customer Generated
  • MS03: Not Specified Reason Agent Generated
  • RC01: Bank Identifier Incorrect
  • RR01: Missing Debitor Account Or Identification
  • RR02: Missing Debitor Name Or Address
  • RR03: Missing Creditor Name or Address
  • RR04: Regulatory Reason
  • SL01: Specific Service Offered By Debitor Agent Visa Reasons:
  • 10.1: EMV Liability Shift Counterfeit Fraud
  • 10.2: EMV Liability Shift Non-Counterfeit Fraud
  • 10.3: Other Fraud, Card-Present Environment
  • 10.4: Other Fraud, Card-Absent Environment
  • 10.5: Visa Fraud Monitoring Program
  • 11.1: Card Recovery Bulletin
  • 11.2: Declined Authorization
  • 11.3: No Authorization
  • 12.1: Late Presentment
  • 12.2: Incorrect Transaction Code
  • 12.3: Incorrect Currency
  • 12.4: Incorrect Account Number
  • 12.5: Incorrect Amount
  • 12.6: Duplicate Processing / Paid By Other Means
  • 12.7: Invalid Data
  • 13.1: Merchandise / Services Not Received
  • 13.2: Cancelled Recurring Transaction
  • 13.3: Not As Described Or Defective Merchandise / Services
  • 13.4: Counterfeit Merchandise
  • 13.5: Misrepresentation
  • 13.6: Credit Not Processed
  • 13.7: Cancelled Merchandise / Services
  • 13.8: Original Credit Transaction Not Accepted
  • 13.9: Non-Receipt of Cash or Load Transaction Value

Mastercard reasons:

  • 4837: No Cardholder Authorization
  • 4840: Fraudulent Processing Of Transactions
  • 4849: Questionable Merchant Activity - Global Merchant Audit Program (GMAP)
  • 4849: Questionable Merchant Activity - Mastercard Rule 3.7 Violation for Coercion Claim
  • 4849: Questionable Merchant Activity - Questionable Merchant Audit Program (QMAP)
  • 4863: Cardholder Does Not Recognize, Potential Fraud
  • 4870: EMV Chip Liability Shift
  • 4871: Chip Liability Shift – Lost / Stolen / Never Received Fraud
  • 4807: Warning Bulletin
  • 4808: Authorization Chargeback - Cardholder-Activated Terminal (CAT) 3 Device
  • 4808: Authorization Chargeback - Expired Chargeback Protection Period
  • 4808: Authorization Chargeback - Multiple Authorization Requests
  • 4808: Authorization Chargeback - Required Authorization Not Obtained
  • 4812: Account Number Not On File
  • 4853: Cardholder Dispute - Credit Posted as a Purchase
  • 4853: Cardholder Dispute - Digital Goods Purchase of $25 or Less
  • 4853: Cardholder Dispute - Goods or Services Not as Described or Defective
  • 4853: Cardholder Dispute - Goods or Services Not Provided
  • 4853: Cardholder Dispute - Issuer Dispute of a Recurring Transaction
  • 4853: Cardholder Dispute - Timeshares
  • 4853: Cardholder Dispute - "No Show" Hotel Charge
  • 4853: Cardholder Dispute - Transaction Did Not Complete
  • 4853: Cardholder Dispute - Addendum Dispute
  • 4853: Cardholder Dispute - Cardholder Dispute of a Recurring Transaction
  • 4853: Cardholder Dispute - Counterfeit Goods
  • 4853: Cardholder Dispute - Credit Not Processed
  • 4855: Goods or Services Not Provided
  • 4859: Addendum, No-Show, or ATM Dispute (Europe)
  • 4859: Addendum, No-Show, or ATM Dispute (Non-European Bank)
  • 4860: Credit Not Processed
  • 4831: Incorrect Transaction Amount
  • 4834: POI Error - Charges for Loss, Theft, or Damages
  • 4834: POI Error - Late Presentment
  • 4834: POI Error - Merchant Credit Correcting Error, Cardholder Currency Exchange Loss
  • 4834: POI Error - Transaction Amount Differs
  • 4834: POI Error - Currency Conversion (Dynamic Currency Conversion)
  • 4834: POI Error - Unreasonable Amount (Europe)
  • 4834: POI Error - ATM Disputes
  • 4834: POI Error - Cardholder Debited More than Once
  • 4841: Canceled Recurring or Digital Goods Transactions
  • 4842: Late Presentment (Europe)
  • 4842: Late Presentment (Non-European Banks)
  • 4846: Correct Transaction Currency Code Not Provided / Currency Errors (Non-European Bank)
  • 4846: Correct Transaction Currency Code Not Provided / Currency Error (Europe)
Exemplo: "MD06"
amountnumber(double)>= 0.5

The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places. The value must be greater than or equal to 0.5.

Exemplo: 12.87
captureobject
Resposta
application/json
{
  "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb",
  "created_at": "2006-01-02 15:04",
  "message": "MD06 - Refund Request by End Customer",
  "code": "MD06",
  "amount": 12.87,
  "capture": {
    "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb",
    "payment_id": "c6056234-a3f9-42de-b944-3ed793fcb6bb",
    "payment_type": "SINGLE"
  }
}

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

Terminals (coming soon)

Manage terminals (POS devices)

Operações

System

System health check endpoints

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