# Lists frequent payments

Full report with all the frequent payments from your Account Id

Endpoint: GET /frequent
Version: 2.0
Security: accountId, apiKey

## Query parameters:

  - `page` (integer)
    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).
    Example: 1

  - `records_per_page` (integer)
    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).
    Example: 20

  - `expiration_time` (string)
    Filter records by expiration datetime interval. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM)
    Example: "interval(2006-01-02 15:04,2006-01-02 15:04)"

  - `method` (string)
    Filter by payment method used in the transaction.
    Enum: "cc", "vi", "dd", "mb", "mbw", "ap", "gp", "sc", "uf"

  - `customer` (string)
    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.
    Example: "01J32EDWGNX94XMWP8PWB23KBK"

  - `id` (string)
    Filter by the unique identifier for the resource. Typically formatted as a UUID (Universally Unique Identifier).
    Example: "bb3e7e60-20f3-4208-9b21-64c635a51f42"

  - `key` (string)
    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.
    Example: "01J32EESEC1Z543P7J3PKSF1Q9"

  - `created_at` (string)
    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).
    Example: "interval(2006-01-02 15:04,2006-01-02 15:04)"

## Response 200 fields (application/json):

  - `meta` (object, required)
    Metadata object containing pagination and result information for list responses.

  - `meta.page` (object)
    Pagination details
    Example: 1

  - `meta.page.current` (integer)
    Current page number

  - `meta.page.total` (integer)
    Total number of pages

  - `meta.records` (object)
    Record details
    Example: 20

  - `meta.records.per_page` (integer)
    Number of records per page

  - `meta.records.total` (integer)
    Total number of records

  - `meta.links` (object)
    Navigation links for pagination

  - `meta.links.first` (string)
    Link to the first page
    Example: "?page=1"

  - `meta.links.prev` (string)
    Link to the previous page

  - `meta.links.next` (string)
    Link to the next page
    Example: "?page=2"

  - `meta.links.last` (string)
    Link to the last page
    Example: "?page=826"

  - `data` (array, required)

  - `data.id` (string, 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.
    Example: "c6056234-a3f9-42de-b944-3ed793fcb6bb"

  - `data.key` (string)
    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.
    Example: "Default Key"

  - `data.expiration_time` (string)
    Expiration date and time for the frequent payment in ISO 8601 format
    Example: "2024-07-01T15:15:00Z"

  - `data.customer` (object)
    The Customer object contains the necessary details about the customer involved in the transaction. This includes identification information, contact details, and preferences. All fields are optional unless specified otherwise.

  - `data.customer.id` (string)
    Unique identifier for the customer. When provided, it links the transaction to an existing customer record.
    Example: "649e88cf-0b78-4c36-8f99-33f5ebb812a1"

  - `data.customer.name` (string)
    Full name of the customer. This is typically displayed on receipts and statements.
    Example: "John Doe"

  - `data.customer.email` (string)
    Customer's email address. Used for sending receipts, notifications, and payment confirmations.
    Example: "john.doe@example.com"

  - `data.customer.phone` (string)
    The contact phone number of the customer, excluding the country code indicator (e.g., "+351"). This field is used for communication purposes. If the payment method is MBWAY, the phone_number is required and is used to send the MBWAY push notification.
    Example: "911234567"

  - `data.customer.phone_indicative` (string)
    The country code indicator for the customer's phone number (e.g., "351" for Portugal). This field is used in conjunction with the phone number to ensure proper international dialing and communication.
    Example: "+351"

  - `data.customer.fiscal_number` (string)
    Customer's tax identification number or fiscal number. Format may vary by country.
    Example: "PT123456789"

  - `data.customer.key` (string)
    A customizable text field for users to input their own identifier for the customer. This can be any string that helps the user uniquely identify the customer in their own system.
    Example: "customer Key Example"

  - `data.customer.language` (string)
    Preferred language for customer communications. Uses ISO 639-1 language codes.
    Enum: "PT", "EN", "ES"

  - `data.method` (object)
    Method details for frequent payment responses

  - `data.method.type` (string)
    Payment method type
    Enum: "CC", "DD", "MBW", "MB", "VI"

  - `data.method.status` (string)
    Current status of the payment method
    Enum: "active", "inactive", "waiting", "pending", "deleted", "success"

  - `data.method.sdd_mandate` (object)
    The SDD Mandate object contains the necessary fields to create a SEPA Direct Debit mandate. This object ensures that all required information is provided to authorize and process SEPA Direct Debit transactions. Object required when method is Direct Debit.

  - `data.method.sdd_mandate.iban` (string, required)
    The International Bank Account Number (IBAN) of the debtor's account. This field is used to uniquely identify the debtor's bank account across international borders, ensuring accurate and efficient processing of SEPA Direct Debit transactions. The IBAN is a standardized format that includes the country code, check digits, bank code, and account number.
    Example: "PT50002700000001234567833"

  - `data.method.sdd_mandate.key` (string)
    A customizable text field for users to input their own identifier for the SDD mandate.
    Example: "Sdd mandate Key Example"

  - `data.method.sdd_mandate.name` (string, required)
    Full name of the account holder as it appears on the bank account.
    Example: "John Doe"

  - `data.method.sdd_mandate.email` (string, required)
    Email address of the account holder for mandate-related communications.
    Example: "john.doe@example.com"

  - `data.method.sdd_mandate.phone` (string, required)
    Phone number of the account holder without country code.
    Example: "911234567"

  - `data.method.sdd_mandate.account_holder` (string, required)
    The name of the person or entity that holds the bank account. This field is used to identify the owner of the bank account involved in the transaction, ensuring that the correct account is credited or debited.
    Example: "John Doe"

  - `data.method.sdd_mandate.country_code` (string)
    ISO 3166-1 alpha-2 country code of the customer's country.
    Example: "PT"

  - `data.method.sdd_mandate.max_num_debits` (string)
    Maximum number of debits allowed under this mandate.
    Example: "12"

  - `data.method.sdd_mandate.billing_entity` (string)
    The entity responsible for billing in the context of the SEPA Direct Debit (SDD) mandate.
    Example: "PT16103627"

  - `data.method.card_type` (string)
    Indicates the type of credit card used for the payment (e.g., "Visa", "MasterCard"). This field is only applicable for credit card transactions.
    Enum: "VISA", "MasterCard"

  - `data.method.last_four` (string)
    The last four digits of the credit card number used for the payment. This field is only applicable for credit card transactions.
    Example: "0000"

  - `data.method.expiration_date` (string)
    Credit card expiration date in MM/YY format
    Example: "04/25"

  - `data.method.url` (string)
    The URL where the merchant should redirect the user to complete Credit Card Payments. This field is only applicable and available for credit card payment transactions.
    Example: "https://cc.test.easypay.pt/start/ac1913a3-fd78-4822-8394-0a14f4169247"

  - `data.method.entity` (string)
    The identifier for the Multibanco entity to which the payment should be routed. This field specifies the entity code required for processing the payment through the Multibanco network, ensuring that the payment is directed to the correct recipient.
    Example: "11683"

  - `data.method.reference` (string)
    The unique payment reference number issued for the specific Multibanco entity. This field is used by the end user to make a payment at an ATM or through home banking. It ensures that the payment is correctly attributed to the intended transaction and recipient.
    Example: "665876931"

  - `data.method.iban` (string)
    International Bank Account Number (IBAN) in standard format
    Example: "PT50002700000001234567833"

  - `data.method.alias` (string)
    A unique identifier for the user within the MBWay system, used to identify the user in the MBWay SDK. This field is only applicable and available for MBWay transactions.
    Example: "79cb81f626924c71926cdb36a03a0590"

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

  - `data.max_value` (number, required)
    Maximum value allowed for transactions
    Example: 20.55

  - `data.min_value` (number, required)
    Minimum value allowed for transactions
    Example: 2.55

  - `data.unlimited_payments` (boolean)
    Whether transactions are unlimited, max or min value will be refreshed on each payment

  - `data.created_at` (string, required)
    Date when payment was created.
    Example: "2017-12-12 16:05:02"

## Response 403 fields (application/json):

  - `status` (string, required)

  - `message` (array, required)
    An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.

## Response 429 fields (application/json):

  - `status` (string, required)

  - `message` (array, required)
    An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.

## Response 500 fields (application/json):

  - `status` (string, required)

  - `message` (array, required)
    An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.