Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB
Frequent Payment

Shows frequent payment details

Retrieve a Frequent Payment details

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

get/frequent/{id}

Path parameters

idstring uuid required

Resource Identification

Response

OK

idstring uuid required

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.

keystring

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

expiration_timestring

Expiration date and time for the frequent payment in ISO 8601 format

currency'EUR'

The currency code in ISO 4217 format (e.g., "EUR" for Euro). This field specifies the type of currency used in financial operation.

max_valuenumber required

Maximum value allowed for transactions

min_valuenumber required

Minimum value allowed for transactions

unlimited_paymentsboolean

Whether transactions are unlimited, max or min value will be refreshed on each payment

created_atstring required

Date when payment was created.

Example response

{
  "id": "ef66f227-2318-4079-8793-ce0fbf651d5c",
  "key": "Default Key",
  "expiration_time": "2024-07-01T15:15:00Z",
  "customer": {
    "id": "df0eac33-a487-4338-96cb-5dea17bdb469",
    "name": "Cus*** Exa***",
    "email": "cus***@example.com",
    "phone": "911***567",
    "phone_indicative": "351",
    "fiscal_number": "PT123***89",
    "key": "Key Example",
    "language": "PT"
  },
  "method": {
    "type": "MBW",
    "status": "active",
    "alias": "79cb81f626924c71926cdb36a03a0590"
  },
  "currency": "EUR",
  "max_value": 20,
  "min_value": 2,
  "unlimited_payments": false,
  "created_at": "2024-06-30 15:15:05"
}