Shows frequent payment details

Request

Retrieve a Frequent Payment details

Required scope: frequent:read

Security

accountId and apiKey

Path

idstring, (uuid)required

Resource Identification

curl -i -X GET \
  'https://api.test.easypay.pt/2.0/frequent/{id}' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'

Responses

Bodyapplication/json

idstring, (uuid)(Identifier)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"

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.

Example:"Default Key"

expiration_timestring

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

Example:"2024-07-01T15:15:00Z"

customerobject(Customer)

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.

methodobject(Frequent Payment Method Response)

Method details for frequent payment responses

currencystring

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

Value:"EUR"

Example:"EUR"

max_valuenumberrequired

Maximum value allowed for transactions

Example:20.55

min_valuenumberrequired

Minimum value allowed for transactions

Example:2.55

unlimited_paymentsboolean

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

Example:false

created_atstringrequired

Date when payment was created.

Example:"2017-12-12 16:05:02"

transactionsArray of objects

Array of payment transactions associated with this frequent payment

Response

{
  "id": "ac1913a3-fd78-4822-8394-0a14f4169247",
  "key": "Default Key",
  "expiration_time": "2022-12-12T16:05:00Z",
  "customer": {
    "id": "fdc4bc82-8e45-4597-b46d-51d3285cf935",
    "name": "Robert Stuart",
    "email": "email@example.com",
    "phone": "911234567",
    "key": "Customer key",
    "language": "PT"
  },
  "method": {
    "type": "CC",
    "status": "active",
    "url": "https://cc.test.easypay.pt/start/ac1913a3-fd78-4822-8394-0a14f4169247",
    "last_four": "0000",
    "card_type": "VISA",
    "expiration_date": "04/25"
  },
  "currency": "EUR",
  "max_value": 20,
  "min_value": 2,
  "unlimited_payments": false,
  "created_at": "2022-11-23 13:16:58"
}