Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB
Frequent Payment

Create frequent payment

Frequent payments are repeatable transactions of varying sums without the client having to enter their payment details again.

It is possible to limit the transferred sums by choosing minimum or maximum values, either to the total sum of the transactions or each individual transaction.

Supported methods for frequent payments are: <i style="color:red">Credit Card, MB WAY, Multibanco, Direct Debit</i> and <i style="color:red">Virtual IBAN</i>

Required scope: <code style="background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em">frequent:create</code>

post/frequent

Request body

expiration_timestring

Expiration date and time for the payment in YYYY-MM-DD HH:mm format

currency'EUR' | 'BRL'

Currency code for the payment

keystring

The merchant's key for identifying the payment.

min_valuenumber double

Minimum value allowed for transactions

max_valuenumber double

Maximum value allowed for transactions

unlimited_paymentsboolean

Transactions will be unlimited, max or min value will be refreshed on each payment.

method'MB' | 'CC' | 'DD' | 'MBW' | 'VI' required

Payment method type

Example request

{
  "expiration_time": "2038-12-12 16:05",
  "currency": "EUR",
  "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"
  },
  "key": "Key Example",
  "min_value": 10,
  "max_value": 25.5,
  "method": "DD",
  "sdd_mandate": {
    "iban": "PT50002700000001234567833",
    "key": "Sdd mandate Key Example",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": "911234567",
    "account_holder": "John Doe",
    "country_code": "PT",
    "max_num_debits": "12",
    "billing_entity": "PT16103627"
  },
  "multibanco": {
    "reference": "505237431"
  }
}

Response

Created

statusstring

Status of the request

messagestring[]

Array of status messages

idstring uuid

Unique identifier for the created frequent payment

Example response

{
  "status": "ok",
  "message": [
    "Your request was successfully created"
  ],
  "id": "86401037-1c8d-4cf3-9172-d0a29b17b9fd",
  "method": {
    "type": "CC",
    "status": "waiting",
    "entity": "59126",
    "reference": "810000618",
    "url": "https://cc.test.easypay.pt/start/980d4826-8574-4782-8450-18db150b7c26",
    "iban": "PT50123400007000199799996",
    "alias": "6ac1c9c50be844858afdbc74eb74acbc",
    "sdd_mandate": {
      "id": "50389142122",
      "iban": "PT50002700000001234567833",
      "key": "Sdd mandate Key Example",
      "name": "John Doe",
      "email": "john.doe@easypay.pt",
      "phone": "911345678",
      "account_holder": "John Doe",
      "country_code": "PT",
      "max_num_debits": "12",
      "billing_entity": "PT16103627",
      "reference_adc": "987654321123"
    }
  },
  "customer": {
    "id": "e7bb115b-3e59-441a-bdb4-60b0f066c2d0"
  }
}