Ir para o conteúdo

Estruturas de dados retornada

Data structure returned in the transaction query.

Payments

Name Type Description
id String Transaction identifier for the payment application. This is the information to use for commit and undo.
value BigDecimal Payment amount. This is the value that was approved by the acquirer. It must always be validated in the response, even if it has been passed as a parameter, as there are acquirers that, for some situations, approve values ​​different from those requested.
paymentType PaymentType Type of payment (Debit, Credit, Voucher, etc.).
installments Integer Number of payment installments.
acquirerName String Purchaser who authorized the payment.
cardBrand String Card banner.
cardBin String card BIN.
cardPanLast4Digits String Last 4 digits of the card's PAN.
captureType CaptureType Card capture method.
status PaymentStatus Payment status.
date Date Payment date/time for the payment application.
acquirerId String Transaction identifier for the acquirer. This is the identifier that appears in the file that the acquirer provides (EDI). In this way, it is possible to reconcile the payment with the integrated transaction.
acquirerResponseCode String Acquirer response code.
acquirerResponseDate String Date/time returned by the acquirer.
acquirerAuthorizationNumber String Authorization number provided by the acquirer (it appears on the Cardholder's customer receipt).
clientVia String Voucher content - customer's copy.
merchantVia String Content of the voucher - copy of the establishment.
additionalValueType AdditionalValueType Present only when there is an additional value in the context of the executed transaction.
additionalValue BigDecimal Present only when there is an additional value in the context of the executed transaction.
accountTypeId String Only present when an account type exists in the context of the executed transaction.
planId String Present only when a plan exists in the context of the executed transaction.
productShortName String Product identifier, returns only transactions for a product.
batchNumber String Lot number.
nsuTerminal String NSU generated by the terminal for the transaction.
cardHolderName String Customer name on card.
lastTrx Boolean Indicates 'true' if it is the last approved transaction, and 'false' otherwise.
terminalId String Terminal ID.
originalValue BigDecimal Original sale price. Present in payments with QRCode, whose benefit was applied to the sale value.
appTransactionId String Transaction identifier for the payment application. This is the information that will be used to confirm and undo the payment.
acquirerNsu String NSU Acquirer for consultation and identification of transactions.
ticketNumber String ticketNumber generated by the terminal for the transaction.
acquirerAdditionalMessage String Additional message sent by the acquirer in the transaction response.
note String Additional text that is entered as Note. (can be invoice number)
dni String Document number.
qrId String QrCode identifier generated by the capture terminal.
ErrorData.paymentsResponseCode String Response code for the error that occurred. See Response Codes
ErrorData.responseMessage String Descriptive message of the reason for the non-authorization. If the transaction was denied by the acquirer, it will contain the message returned by the acquirer.

Reversal

Name Type Description
paymentId String Transaction identifier for the payment application. This is the information to be used for commit and undo.
cancelable Boolean Indicates 'true' if this transaction can be undone and 'false' otherwise.
acquirerResponseCode String Acquirer response code.
acquirerAuthorizationNumber String Authorization number provided by the acquirer (it appears on the Card Holder customer receipt).
Receipt.clientVia String Receipt content - customer copy.
Receipt.merchantVia String Receipt content - merchant copy.
acquirerAdditionalMessage String Additional message sent by the acquirer in the transaction response.
ticketNumber String ticketNumber generated by the terminal for the transaction.
batchNumber String Lot number.
nsuTerminal String NSU generated by the terminal for the transaction.
cardholderName String Customer name on card.
cardBin String Card BIN.
panLast4Digits String Last 4 digits of the card's PAN.
terminalId String Terminal identification.
value BigDecimal Transaction value. This is the value that was approved by the acquirer. It must always be validated in the response, even if it has been passed as a parameter, as there are buyers who, for some situations, approve values ​​different from those requested.
captureType CaptureType Card capture form.
status PaymentStatus Payment status.
date Date Payment date/time for the payments application.
additionalValueType AdditionalValueType Only present when there is an additional value in the context of the executed transaction.
additionalValue BigDecimal Only present when there is an additional value in the context of the executed transaction.
lastTrx Boolean Indicates 'true' if it is the last approved transaction, and 'false' otherwise.
appTransactionId String Transaction identifier for the payment application. This is the information that will be used to confirm and undo the payment.
acquirerNsu String NSU Acquirer for consultation and identification of transactions.
ErrorData.paymentsResponseCode String Response code for the error that occurred. See Response Codes
ErrorData.responseMessage String Descriptive message of the reason for the non-authorization. If the transaction was denied by the acquirer, it will contain the message returned by the acquirer.

Refund

Name Type Description
id String Transaction identifier for the payment application.
value BigDecimal Transaction value. This is the value that was approved by the acquirer. It must always be validated in the response, even if it has been passed as a parameter, as there are buyers who, for some situations, approve values different from those requested.
paymentType PaymentType Payment type (Debit, Credit, Voucher, etc.).
acquirerName String Purchaser who authorized the payment.
cardBrand String Card brand.
cardBin String Card BIN.
cardPanLast4Digits String Last 4 digits of the card's PAN.
captureType CaptureType Card capture form.
status PaymentStatus Payment status.
date Date Payment date/time for the payments application.
acquirerId String Transaction identifier for the acquirer. This is the identifier that appears in the file that the acquirer provides (EDI). In this way, it is possible to reconcile the payment with the integrated transaction.
acquirerResponseCode String Acquirer response code.
acquirerResponseDate String Date/time returned by acquirer.
acquirerAuthorizationNumber String Authorization number provided by the acquirer (it appears on the Card Holder customer receipt).
clientVia String Receipt content - customer copy.
merchantVia String Receipt content - merchant copy.
accountTypeId String Only present when an account type exists in the context of the executed transaction.
productShortName String Product identifier, returns only transactions for a product.
batchNumber String Lot number.
nsuTerminal String NSU generated by the terminal for the transaction.
cardholderName String Customer name on card.
lastTrx Boolean Indicates 'true' if it is the last approved transaction, and 'false' otherwise.
terminalId String Terminal identification.
appTransactionId String Transaction identifier for the payment application. This is the information that will be used to confirm and undo the payment.
acquirerNsu String NSU Acquirer for consultation and identification of transactions.
ErrorData.paymentsResponseCode String Response code for the error that occurred. See Response Codes
ErrorData.responseMessage String Descriptive message of the reason for the non-authorization. If the transaction was denied by the acquirer, it will contain the message returned by the acquirer.