# Shows frequent payment details

Retrieve a Frequent Payment details

Endpoint: GET /frequent/{id}
Version: 2.0
Security: accountId, apiKey

## Path parameters:

  - `id` (string, required)
    Resource Identification

## Response 200 fields (application/json):

  - `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"

  - `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"

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

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

  - `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"

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

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

  - `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"

  - `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"

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

  - `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"

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

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

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

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

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

  - `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"

  - `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"

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

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

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

  - `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"

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

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

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

  - `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"

  - `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"

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

  - `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"

  - `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"

  - `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"

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

  - `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"

  - `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"

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

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

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

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

  - `transactions` (array)
    Array of payment transactions associated with this frequent payment

  - `transactions.id` (string)
    Unique identifier for the transaction
    Example: "4fb3ac57-c7fe-4157-aeb7-4362ae24deec"

  - `transactions.key` (string)
    Merchant identification key
    Example: "Merchant identification key"

  - `transactions.created_at` (string)
    When the transaction was created
    Example: "2025-05-30T17:21:46Z"

  - `transactions.date` (string)
    Transaction date
    Example: "2025-05-30T17:21:47Z"

  - `transactions.values` (object)
    Transaction value breakdown

  - `transactions.values.requested` (number)
    Requested amount
    Example: 12.55

  - `transactions.values.paid` (number)
    Amount actually paid
    Example: 12.55

  - `transactions.values.fixed_fee` (number)
    Fixed fee charged
    Example: 0.07

  - `transactions.values.variable_fee` (number)
    Variable fee charged
    Example: 0.09

  - `transactions.values.tax` (number)
    Tax amount
    Example: 0.04

  - `transactions.values.transfer` (number)
    Amount transferred to merchant
    Example: 12.35

  - `transactions.transfer_date` (string)
    When the transfer occurred
    Example: "2025-06-02T00:00:00Z"

  - `transactions.transfer_batch` (string)
    Transfer batch identifier

  - `transactions.document_number` (string)
    Document number for the transaction
    Example: "MARCEL0208220628294020250530172147"

  - `transactions.descriptive` (string)
    Transaction description
    Example: "Descriptive Josefa"

  - `transactions.method` (string)
    The payment method used to identify the payment in legacy.
    Example: "mbw"

## Response 401 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 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 404 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.