Lists frequent payments

Pedido

Full report with all the frequent payments from your Account Id

Required scope: frequent:read

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

expiration_timestring

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

Exemplo:expiration_time=interval(2006-01-02 15:04,2006-01-02 15:04)

methodstring

Filter by payment method used in the transaction.

Enum:"CC""VI""DD""MB""MBW""AP""GP"

Exemplo:method=MB

customerstring

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.

Exemplo:customer=01J32EDWGNX94XMWP8PWB23KBK

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

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/frequent?page=1&records_per_page=20&expiration_time=interval(2006-01-02%2015%3A04%2C2006-01-02%2015%3A04)&method=MB&customer=01J32EDWGNX94XMWP8PWB23KBK&id=bb3e7e60-20f3-4208-9b21-64c635a51f42&key=01J32EESEC1Z543P7J3PKSF1Q9&created_at=interval(2006-01-02%2015%3A04%2C2006-01-02%2015%3A04)' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'

Respostas

Corpoapplication/json

metaobject(Meta)obrigatório

Metadata object containing pagination and result information for list responses.

dataArray of objects(Frequent)obrigatório

Response

{
  "meta": {
    "page": { … },
    "records": { … },
    "links": { … }
  },
  "data": [
    { … },
    { … }
  ]
}