Additional fields

The fields property is used to store structured data that can be displayed in the Checkout interface based on specified conditions..

For example, it is possible to store your system's own information, such as the order ID cmsOrderId or the ID of the user who is performing the payment process cmsUserId.

The fields property is made up of a set of objects of the type NameValuePair where the data to be stored is defined.

The data to be saved can be sent in structures like:

  • redirectRequest.fields
  • redirectRequest.payment.fields
  • redirectRequest.subscription.fields

Conditions

  • Up to 50 additional fields can be added. Fields in redirectRequest.fields will be validated first, and the remainder will be assigned to redirectRequest.payment.fields or redirectRequest.subscription.fields.
  • A maximum of 255 characters is allowed in the value property.
  • A maximum of 50 characters is allowed in the keyword property.
  • When you send multiple fields with the same keyword, our API chooses the first one to store and display in the frontend.

Data with property display: both, receipt, payment, approved, will be displayed in some interface flow.

Customer Account Number

If you are performing the integration for Puerto Rico and have enabled the services of:

  • Online Response: It is a service offered by EVERTEC GROUP LLC. that allows the merchant to receive the result of a processed and authorized transaction.

  • Get Balance: It is a service offered by EVERTEC GROUP LLC. that controls and manages the current balance of the users of a merchant.

You can send your customers' account identifier in the transaction using the keyword CustomerAccountNumber.

If you need to send your customers' account identifier (whether for payment of services or to suppliers) in the transaction so that it is linked to the payment information, use the keyword CustomerAccountNumber.

{
    "keyword": "CustomerAccountNumber",
    "value": "ABCD1234567890",
    "displayOn": "both"
}

If another keyword is used, the value will be sent as additional data, but it will not deliver the information to the integrations (Online Response and Get Balance).

NameValuePair

Structure to allow relevant information to be related and control when it will be displayed in the collection process.

  • Name
    keyword
    Type
    string
    is Required
    REQUIRED
    Description

    Identifier or index of the data to be attached.
    e.g.: cmsInvoiceId

  • Name
    value
    Type
    string|object|array|boolean|number
    is optional
    Description

    Value of the data to be attached.
    e.g.: ID_2233

  • Name
    displayOn
    Type
    string
    is optional
    Description

    Indicates under what conditions the attached data is displayed.
    You can use this to decide if you want certain data to be seen during data capture, in the output of the process, in both stages, or never..
    One of: none, payment, receipt, both, approved.

NameValuePair

{
    "keyword": "cmsInvoiceId",
    "value": "string",
    "displayOn": "both"
}

value property

If no value is specified for the value property, its default value will be null

The value property allows you to store different types of data. However, to improve the user experience in the interface, only the values that can be presented in an understandable way will be displayed.

Examples

Value
Displayed as
true
true
0
0
1234
1234
string
string
"''"
''
""
{"key1":"value1"}
It is not displayed on the interface
{"key1":{"key1":"value1"}}
It is not displayed on the interface
["string1"]
string1
["string1","string2"]
string1, string2
[{"key1":"value1"},{"key2":"value2"}]
It is not displayed on the interface
[{"key1":"value1"},"string1",["key1","value1"]]
string1

displayOn property

If no value is specified for the displayOn property, its default value will be none

Value
Description
none
It is not shown in any view of the collection process. This option is ideal if you want to keep this data hidden throughout the process.
both
It is shown in all views of the collection process.
payment
It is displayed only in the information capture view. If you want users to see this data while entering data, choose this option.
receipt
It is shown only in the collection result view. This option is perfect for displaying information specifically at the final stage of the collection process.
approved
It is shown in the collection result view only if the collection was successful.