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

Lists out payments

Pedido

Full report with all the out payments from your Account Id

Segurança
accountId and apiKey
Consulta
pageinteger

Specifies the page number of the results to retrieve. This parameter is used for paginating through a collection of records, allowing the client to navigate to different pages of the dataset. The value must be a positive integer (e.g., "1" for the first page).

Padrão 1
Exemplo: page=1
records_per_pageinteger

Specifies the number of records to retrieve per page. This parameter is used for controlling the size of each page in a paginated collection of records. The value must be a positive integer, determining how many records are displayed on each page (e.g., "20" for 20 records per page).

Padrão 20
Exemplo: records_per_page=20
methodstring

Filter by method used in the transaction.

Enum"transfer""mb"
typestring

Filter by type of out payment.

Enum"normal""instant"
idstring(uuid)

Filter by the unique identifier for the resource. Typically formatted as a UUID (Universally Unique Identifier).

Exemplo: id=bb3e7e60-20f3-4208-9b21-64c635a51f42
keystring

A user-defined identifier used to filter the results. This parameter allows the client to specify a key to retrieve records or transactions that match the provided key. The value is a string and may not be unique, as it is determined by the user.

Exemplo: key=01J32EESEC1Z543P7J3PKSF1Q9
valuenumber(double)

Filter records by the exact transaction amount.

Exemplo: value=10.32
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)
curl -i -X GET \
  'https://api.test.easypay.pt/2.0/out_payment?page=1&records_per_page=20&method=transfer&type=normal&id=bb3e7e60-20f3-4208-9b21-64c635a51f42&key=01J32EESEC1Z543P7J3PKSF1Q9&value=10.32&created_at=interval%282006-01-02+15%3A04%2C2006-01-02+15%3A04%29' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'

Respostas

OK

Corpoapplication/json
metaobject(metadata-page)

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.

dataArray of objects(out-payment-response)
Resposta
application/json
{
  "meta": {
    "page": { … },
    "records": { … },
    "links": { … }
  },
  "data": [
    { … },
    { … }
  ]
}

Create out payment

Pedido

Get your strong authentication RSA private key from Easypay Backoffice on menu:
Web Services->Configuration API 2.0->Keys.

Segurança
accountId and apiKey and signatureAuth
Corpoapplication/json
customerobject(customer)obrigatório

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.

customer.​idstring(uuid)

Unique identifier for the customer. When provided, it links the transaction to an existing customer record.

Exemplo: "649e88cf-0b78-4c36-8f99-33f5ebb812a1"
customer.​namestring<= 255 characters

Full name of the customer. This is typically displayed on receipts and statements.

Exemplo: "John Doe"
customer.​emailstring(email)<= 70 characters

Customer's email address. Used for sending receipts, notifications, and payment confirmations.

Exemplo: "john.doe@example.com"
customer.​phonestring<= 15 characters

The contact phone number of the customer, excluding the country code indicator (e.g., "+351"). This field is used for communication purposes. If the payment method is MBWAY, the phone_number is required and is used to send the MBWAY push notification.

Exemplo: "911234567"
customer.​phone_indicativestring<= 5 characters

The country code indicator for the customer's phone number (e.g., "351" for Portugal). This field is used in conjunction with the phone number to ensure proper international dialing and communication.

Exemplo: "+351"
customer.​fiscal_numberstring<= 20 characters

Customer's tax identification number or fiscal number. Format may vary by country.

Exemplo: "PT123456789"
customer.​keystring<= 255 characters

A customizable text field for users to input their own identifier for the customer. This can be any string that helps the user uniquely identify the customer in their own system.

Exemplo: "customer Key Example"
customer.​languagestring= 2 characters

Preferred language for customer communications. Uses ISO 639-1 language codes.

Enum"PT""EN""ES"
Exemplo: "PT"
keystring<= 50 characters

Merchant identification key

valuenumber(double)>= 0.5obrigatório

Value will be rounded to 2 decimals

typestring

Optional - only applicable to method transfer

Padrão "normal"
Enum"normal""instant"
schedule_atstring(date-time)

Schedule date to execute the payment

descriptivestring<= 140 characters^[a-zA-Z0-9 .,/+*$%]+$

Description for the out payment.

accountobject(account)
out_accountobject(out-account)obrigatório
out_account.​account_holderstring<= 100 charactersobrigatório

Bank account holder name

out_account.​ibanstring<= 34 charactersobrigatório

Only IBANS from SEPA zones are supported

out_account.​emailstring<= 50 charactersobrigatório
out_account.​phonestring<= 20 charactersobrigatório
out_account.​keystring<= 255 characters

Custom string controlled by our clients

out_account.​country_codestringObsoleto

Bank account country code

methodstringobrigatório
Padrão "transfer"
Enum"transfer""mb"
Exemplo: "transfer"
timestampstringobrigatório

Unix timestamp UTC, must be no more than 1 minute before or after real time, if not the strong authentication signature will not be valid

curl -i -X POST \
  https://api.test.easypay.pt/2.0/out_payment \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92' \
  -H 'Content-Type: application/json' \
  -H 'Signature: YOUR_API_KEY_HERE' \
  -d '{
    "customer": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "Customer Example",
      "email": "user@example.com",
      "phone": "911234567",
      "phone_indicative": "+351",
      "fiscal_number": "PT123456789",
      "key": "Example Key",
      "language": "PT"
    },
    "key": "Example Key",
    "value": 0.5,
    "type": "normal",
    "schedule_at": "2019-08-24T14:15:22Z",
    "descriptive": "Descriptive Example",
    "account": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "out_account": {
      "account_holder": "Acount Name Example",
      "iban": "PT50002700000001234567833",
      "email": "customer@example.com",
      "phone": "351911234567",
      "key": "Key Example",
      "country_code": "PT"
    },
    "method": "transfer",
    "timestamp": "1696642539"
  }'

Respostas

Created

Corpoapplication/json
statusstring
Exemplo: "ok"
messageArray of strings
Exemplo: ["Your request was successfully created"]
idstring(uuid)

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.

methodobject
customerobject

Customer associated with the out payment.

out_accountobject

Destination SEPA bank account for the out payment.

Resposta
application/json
{
  "status": "ok",
  "message": [
    "Your request was successfully created"
  ],
  "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb",
  "method": {
    "type": "transfer",
    "status": "pending"
  },
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "out_account": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Shows out payment details

Pedido

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

Resource Identification

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

Respostas

OK

Corpoapplication/json
idstring(uuid)

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.

statusstring

Status of the out payment.

Enum"success""pending""deleted""delayed"
typestring

Type of out payment.

Enum"normal""instant"
methodstring

Method used for the out payment.

Enum"transfer""mb"
customerobject

Customer associated with the out payment.

accountobject

Easypay account from which the funds are transferred.

out_accountobject

Destination SEPA bank account for the out payment.

keystring

Merchant reference key for the out payment.

valuenumber(double)

Amount to be transferred.

schedule_atstring

Scheduled date and time for the out payment (YYYY-MM-DD HH:MM:SS).

transactionsobject(out-payment-transactions)

Transaction related to the out payment.

created_atstring

Date and time when the out payment was created.

Exemplo: "2022-09-15 20:28:58"
timestampstring

Timestamp of the last update or event for this out payment.

Exemplo: "1749054192"
Resposta
application/json
{
  "id": "760d105e-950d-4b41-8017-cad840ca3baa",
  "status": "success",
  "type": "normal",
  "method": "transfer",
  "descriptive": "descriptive",
  "customer": {
    "id": "7e47c256-4bea-41a8-b578-727d60004c7a"
  },
  "account": {
    "id": "76f190b9-2b8a-4bd0-9490-411241a9dc81"
  },
  "out_account": {
    "id": "343a8a78-8deb-4d4a-aa41-0a9140c95346"
  },
  "key": "Example Key",
  "value": 1,
  "schedule_at": "2022-11-25 10:30:11",
  "transactions": [
    { … }
  ],
  "created_at": "2022-11-25 10:30:14"
}

Deletes out payment

Pedido

If the payment is not processed, it will be cancelled.
Get your strong authentication RSA private key from Easypay Backoffice on menu:
Web Services->Configuration API 2.0->Keys.

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

Resource Identification

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

Respostas

No Content

Resposta
Sem conteúdo

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