Request Data for Process Transaction

Additional data can be sent to store information along with the transaction. The following keys are NOT allowed: _accountNumber, userAgent, fingerprint, sourcePlatform, tokenizationID, trazabilyCode, transactionCycle, RequestId, PartnerAuthCode, onTest, threeDSEnrolled, threeDSAuthenticated.

Additionally, certain processing parameters can be included in this field:

Transaction Initiator Indicator

If a specific Payment Initiator Indicator value is required for processing, it can be sent as additional data.

{
  //...
  "additional": {
    "initiatorIndicator": "CARDHOLDER_COF"
  }
}

Response Data for Process Transaction

There is additional data received in response to a transaction processing request. The reception of this data depends on various factors and comes in the response as additional.

{
    "status": {
        "status": "APPROVED",
        "reason": "00",
        "message": "Approved",
        "date": "2024-07-17T15:28:35-05:00"
    },
    // ...
    "additional": {
      // Additional data
      "bin": "411076",
      "terminalNumber": "00990101",
      // ...
    }
}

Examples of Additional Data

Key	Example	Description
`credit`	{"type": "00", "groupCode": "C", "code": "0", "installments": 0}	Credit data, learn more at Credit.
`totalAmount`	63.58	Total amount.
`interestAmount`	5.78	Interest amount.
`installmentAmount`	2.65	Installment amount.
`iceAmount`	0	ICE amount.
`line`	123	Position in the closing file (Line).
`cardType`	credit	Card type.
`trazabilyCode`	999900	Traceability code.
`transactionCycle`	3	Transaction cycle.
`RequestId`	1560778247	Request ID.
`PartnerAuthCode`	5d029607e1abb	Partner authorization code.
`merchantCode`	4682312740123	Merchant code.
`terminalNumber`	00990101	Terminal number.
`bin`	411076	BIN, first digits of the card.
`bankName`	Bank Name	Bank name.
`accountNumber`	1111	Account number.
`expiration`	1222	Card expiration in the format (month)(year).
`installments`	2	Number of installments.
`pocket`	80	Pocket identification number depending on the provider.
`fiscalControlNumber`	Control: MYHFC-KEHKC	Fiscal control number.
`fiscalControlProvider`	ET	Fiscal control provider, example ET as Evertec.
`PAN`	klbrfTC1ol9BV7sFP9bw66 nLH77QMYAA3GRZrzjutci Fv/gqg9xZs8n7gPNxRRsl	Card number + initialization vector encrypted in base64, learn more at Card return
`canRetry`	true	Indicates whether a declined or failed transaction is eligible for reprocessing with an alternative payment method.

Credit

This field specifies the number of installments available to finance the total payment amount, accompanied by a description of the financing conditions. The description of the credits depends directly on their installments, code, and groupCode properties, as well as the provider through which the payment is being processed.

Structure:

type: Identifier representing the type of credit.
groupCode: Code that groups credits by category.
installments: Number of installments available for the credit.
code: Unique code associated with the specific credit.
description: Detailed description of the financing conditions.

Credits by Provider

DATAFAST - MEDIANET - AUSTRO - INTERDIN

They share the same structure and description for their credits based on groupCode and code:

groupCode	description
`C`	Current Payment	Payment in one installment
`D`	Current without interest	Payment by installments without interest
`M`	Deferred plus	Mixture with or without interest, defined by the issuing bank
`P`	Deferred with interest	Payment by installments with inter
`N`	Regular payment plan
`X`	Special payment plan	Payment Without charging interest
`L`	Preferencial deferred	Payment by installments with lower interest
`B`	Plan 0%

  [
    {
      "code" : "1",
      "type" : "00",
      "groupCode" : "C",
      "installments" : [1],
      "description" : "Current 1 month of grace",
    }
    {
      "code" : "3",
      "type" : "01",
      "groupCode" : "D",
      "installments" : [3],
      "description" : "Deferred 3 months grace without interest",
    }
    ...
  ]

FLAMINGO, REDEBAN

They share the following structure, where the only variation is the number of installments allowed for the credit under the installments property.

groupCode	description
C	Quotas

{
      "code": "0",
      "groupCode": "C",
      "type": "00",
      "installments": [1,2,3,4,5,12],
      "description": "Quotas",
}

TRANSERVER

groupCode	description
Q	PLAN 0
C	Current

  [
    {
      "code": "000000",
      "groupCode": "C",
      "type": "00",
      "description": "Current",
      "installments": [1]
    },
    {
      "code": "03BCR",
      "type": "0",
      "groupCode": "Q",
      "installments": [3],
      "description": "PLAN 0 BCR 3C BCR"
    },
  ]

PAYESTUDIO

groupCode	installments	description
Q	[1,12]	Current
Q	[1]	Without quotes
Q	[1,12]	Quotas counted price

 [
    {
      "code": "00",
      "groupCode": "Q",
      "type": "00",
      "description": "Without quotes",
      "installments": [1]
    },
    {
      "code": "00",
      "groupCode": "Q",
      "type": "00",
      "installments": [3],
      "description": "Current",
    },
    {
      "code": "00",
      "groupCode": "Q",
      "type": "00",
      "installments": [2,24],
      "description": "Quotas counted price",
    },
 ]