Estruturas de dados retornada¶

Estrutura de dados retornadas na consulta de transações.

Payments¶

Nome	Tipo	Descrição
`id`	`String`	Identificador da transação para a aplicação de pagamentos. Esta é a informação a ser usada para a confirmação e desfazimento.
`value`	`BigDecimal`	Valor do pagamento. Este é o valor que foi aprovado pela adquirente. Deve ser validado sempre na resposta, ainda que tenha sido passado como parâmetro, pois há adquirentes que, para algumas situações, aprovam valores diferentes dos solicitados.
`paymentType`	`PaymentType`	Tipo de pagamento (Débito, Crédito, Voucher, etc.).
`installments`	`Integer`	Quantidade de parcelas do pagamento.
`acquirerName`	`String`	Adquirente que autorizou o pagamento.
`cardBrand`	`String`	Bandeira do cartão.
`cardBin`	`String`	BIN do cartão.
`cardPanLast4Digits`	`String`	Últimos 4 dígitos do PAN do cartão.
`captureType`	`CaptureType`	Forma de captura do cartão.
`status`	`PaymentStatus`	Situação do pagamento.
`date`	`Date`	Data/hora do pagamento para a aplicação de pagamentos.
`acquirerId`	`String`	Identificador da transação para a adquirente. Este é o identificador que consta no arquivo que a adquirente fornece (EDI). Desta forma, é possível realizar a conciliação do pagamento com a transação integrada.
`acquirerResponseCode`	`String`	Código de resposta da adquirente.
`acquirerResponseDate`	`String`	Data/hora retornada pela adquirente.
`acquirerAuthorizationNumber`	`String`	Número da autorização fornecido pela adquirente (consta no comprovante do cliente Portador do Cartão).
`clientVia`	`String`	Conteúdo do comprovante - via do cliente.
`merchantVia`	`String`	Conteúdo do comprovante - via do estabelecimento.
`additionalValueType`	`AdditionalValueType`	Presente apenas quando existe um valor adicional no contexto da transação executada.
`additionalValue`	`BigDecimal`	Presente apenas quando existe um valor adicional no contexto da transação executada.
`accountTypeId`	`String`	Presente apenas quando existe um tipo de conta no contexto da transação executada.
`planId`	`String`	Presente apenas quando existe um plano no contexto da transação executada.
`productShortName`	`String`	Identificador de produto, retorna apenas transações de um produto.
`batchNumber`	`String`	Número de lote.
`nsuTerminal`	`String`	NSU gerado pelo terminal para a transação.
`cardHolderName`	`String`	Nome do cliente no cartão.
`lastTrx`	`Boolean`	Indica 'true' se é a última transação aprovada, e 'falso' caso contrário.
`terminalId`	`String`	Identificação do terminal.
`originalValue`	`BigDecimal`	Valor orginal da venda. Presente em pagamentos com QRCode, cujo beneficio foi aplicado ao valor da venda.
`appTransactionId`	`String`	Identificador de transação para o aplicativo de pagamento. Esta é a informação que será usada para confirmar e desfazer o pagamento.
`acquirerNsu`	`String`	NSU Adquirente para consulta e identificação de transações.
`ticketNumber`	`String`	ticketNumber gerado pelo terminal para a transação.
`acquirerAdditionalMessage`	`String`	Mensagem adicional enviada pela adquirente na resposta da transação.
`note`	`String`	Texto adicional que é inserido como Nota. (pode ser o número da fatura)
`dni`	`String`	Número do Documento.
`qrId`	`String`	Identificador QrCode gerado pelo terminal de captura.
`ErrorData.paymentsResponseCode`	`String`	Código de resposta para o erro que ocorreu. Vide Códigos de Resposta
`ErrorData.responseMessage`	`String`	Mensagem descritiva da causa da não autorização. Se a transação foi negada pela adquirente, conterá a mensagem retornada pela adquirente.

Reversal¶

Nome	Tipo	Descrição
`paymentId`	`String`	Identificador da transação para a aplicação de pagamentos. Esta é a informação a ser usada para a confirmação e desfazimento.
`cancelable`	`Boolean`	Indica 'true', caso esta transação possa ser desfeita e 'false' caso contrário.
`acquirerResponseCode`	`String`	Código de resposta da adquirente.
`acquirerAuthorizationNumber`	`String`	Número da autorização fornecido pela adquirente (consta no comprovante do cliente Portador do Cartão).
`Receipt.clientVia`	`String`	Conteúdo do comprovante - via do cliente.
`Receipt.merchantVia`	`String`	Conteúdo do comprovante - via do estabelecimento.
`acquirerAdditionalMessage`	`String`	Mensagem adicional enviada pela adquirente na resposta da transação.
`ticketNumber`	`String`	ticketNumber gerado pelo terminal para a transação.
`batchNumber`	`String`	Número de lote.
`nsuTerminal`	`String`	NSU gerado pelo terminal para a transação.
`cardholderName`	`String`	Nome do cliente no cartão.
`cardBin`	`String`	BIN do cartão.
`panLast4Digits`	`String`	Últimos 4 dígitos do PAN do cartão.
`terminalId`	`String`	Identificação do terminal.
`value`	`BigDecimal`	Valor da transação. Este é o valor que foi aprovado pela adquirente. Deve ser validado sempre na resposta, ainda que tenha sido passado como parâmetro, pois há adquirentes que, para algumas situações, aprovam valores diferentes dos solicitados.
`captureType`	`CaptureType`	Forma de captura do cartão.
`status`	`PaymentStatus`	Situação do pagamento.
`date`	`Date`	Data/hora do pagamento para a aplicação de pagamentos.
`additionalValueType`	`AdditionalValueType`	Presente apenas quando existe um valor adicional no contexto da transação executada.
`additionalValue`	`BigDecimal`	Presente apenas quando existe um valor adicional no contexto da transação executada.
`lastTrx`	`Boolean`	Indica 'true' se é a última transação aprovada, e 'false' caso contrário.
`appTransactionId`	`String`	Identificador de transação para o aplicativo de pagamento. Esta é a informação que será usada para confirmar e desfazer o pagamento.
`acquirerNsu`	`String`	NSU Adquirente para consulta e identificação de transações.
`ErrorData.paymentsResponseCode`	`String`	Código de resposta para o erro que ocorreu. Vide Códigos de Resposta
`ErrorData.responseMessage`	`String`	Mensagem descritiva da causa da não autorização. Se a transação foi negada pela adquirente, conterá a mensagem retornada pela adquirente.

Refund¶

Nome	Tipo	Descrição
`id`	`String`	Identificador da transação para a aplicação de pagamentos.
`value`	`BigDecimal`	Valor da transação. Este é o valor que foi aprovado pela adquirente. Deve ser validado sempre na resposta, ainda que tenha sido passado como parâmetro, pois há adquirentes que, para algumas situações, aprovam valores diferentes dos solicitados.
`paymentType`	`PaymentType`	Tipo de pagamento (Débito, Crédito, Voucher, etc.).
`acquirerName`	`String`	Adquirente que autorizou o pagamento.
`cardBrand`	`String`	Bandeira do cartão.
`cardBin`	`String`	BIN do cartão.
`cardPanLast4Digits`	`String`	Últimos 4 dígitos do PAN do cartão.
`captureType`	`CaptureType`	Forma de captura do cartão.
`status`	`PaymentStatus`	Situação do pagamento.
`date`	`Date`	Data/hora do pagamento para a aplicação de pagamentos.
`acquirerId`	`String`	Identificador da transação para a adquirente. Este é o identificador que consta no arquivo que a adquirente fornece (EDI). Desta forma, é possível realizar a conciliação do pagamento com a transação integrada.
`acquirerResponseCode`	`String`	Código de resposta da adquirente.
`acquirerResponseDate`	`String`	Data/hora retornada pela adquirente.
`acquirerAuthorizationNumber`	`String`	Número da autorização fornecido pela adquirente (consta no comprovante do cliente Portador do Cartão).
`clientVia`	`String`	Conteúdo do comprovante - via do cliente.
`merchantVia`	`String`	Conteúdo do comprovante - via do estabelecimento.
`accountTypeId`	`String`	Presente apenas quando existe um tipo de conta no contexto da transação executada.
`productShortName`	`String`	Identificador de produto, retorna apenas transações de um produto.
`batchNumber`	`String`	Número de lote.
`nsuTerminal`	`String`	NSU gerado pelo terminal para a transação.
`cardholderName`	`String`	Nome do cliente no cartão.
`lastTrx`	`Boolean`	Indica 'true' se é a última transação aprovada, e 'false' caso contrário.
`terminalId`	`String`	Identificação do terminal.
`appTransactionId`	`String`	Identificador de transação para o aplicativo de pagamento. Esta é a informação que será usada para confirmar e desfazer o pagamento.
`acquirerNsu`	`String`	NSU Adquirente para consulta e identificação de transações.
`ErrorData.paymentsResponseCode`	`String`	Código de resposta para o erro que ocorreu. Vide Códigos de Resposta
`ErrorData.responseMessage`	`String`	Mensagem descritiva da causa da não autorização. Se a transação foi negada pela adquirente, conterá a mensagem retornada pela adquirente.