Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB
Frequent Payment

Lists frequent payments

Full report with all the frequent payments from your Account Id

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

get/frequent

Query parameters

pageinteger
Example:1

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).

records_per_pageinteger
Example:20

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).

expiration_timestring
Example:interval(2006-01-02 15:04,2006-01-02 15:04)

Filter records by expiration datetime interval. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM)

method'CC' | 'VI' | 'DD' | 'MB' | 'MBW' | 'AP' | 'GP'
Example:MB

Filter by payment method used in the transaction.

customerstring
Example:01J32EDWGNX94XMWP8PWB23KBK

A user-defined identifier used to filter the customers. 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.

idstring uuid
Example:bb3e7e60-20f3-4208-9b21-64c635a51f42

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

keystring
Example:01J32EESEC1Z543P7J3PKSF1Q9

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.

created_atstring
Example:interval(2006-01-02 15:04,2006-01-02 15:04)

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).

Response

OK

Example response

{
  "meta": {
    "links": {
      "first": "?page=1",
      "next": "?page=2",
      "last": "?page=826"
    }
  },
  "data": [
    {
      "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"
    }
  ]
}