Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB
Frequent Payment

Updates frequent payment details

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

patch/frequent/{id}

Path parameters

idstring uuid required

Resource Identification

Request body

status'active' | 'deleted'

Status of the frequent payment

expiration_timestring Y-m-d H:i

Expiration date and time for the payment

currency'EUR'

ISO 4217 currency code. If not specified, the default currency is set to EUR.

keystring

The merchant's key for identifying the payment.

max_valuenumber double

Maximum value allowed for transactions

min_valuenumber double

Minimum value allowed for transactions

unlimited_paymentsboolean

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

Example request

{
  "status": "active",
  "expiration_time": "2017-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",
  "max_value": 25.5,
  "min_value": 10,
  "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"
  }
}

Response

OK

statusstring

Status of the request

messagestring[]

Array of status messages

idstring uuid

Unique identifier for the frequent payment

Example response

{
  "status": "ok",
  "message": [
    "Your request was successfully created"
  ],
  "id": "86401037-1c8d-4cf3-9172-d0a29b17b9fd",
  "method": {
    "type": "CC",
    "status": "waiting",
    "url": "https://cc.test.easypay.pt/start/86401037-1c8d-4cf3-9172-d0a29b17b9fd",
    "entity": "59126",
    "reference": "810000618",
    "sdd_mandate": {
      "id": "12345678901",
      "iban": "PT50002700000001234567833",
      "key": "Key Example",
      "name": "Name Example",
      "email": "customer@example.com",
      "phone": "911234567",
      "account_holder": "Acount Name Example",
      "country_code": "PT",
      "max_num_debits": "12",
      "reference_adc": "987654321123"
    }
  },
  "customer": {
    "id": "e7bb115b-3e59-441a-bdb4-60b0f066c2d0"
  }
}