Introdução
Neste item exemplificamos o modelo esperado pela nossa API para as requisições de consulta de transação e o mapeamento das tags para a mensagem de resposta para a mesma operação (consulta de transação).
Deve-se adicionar o endpoint /TransactionStatusReport ao endereço de conexão.
Novas Mudanças em Consultas
Por conta de uma nova regra de negócio no Autorizador, sondas realizadas utilizando o ITK
como identificador, retornarão sempre a última transação do SAK/ITK.Se houver repetição do número do ITK em suas transações, deve se atentar que ao sondar as mesmas, a transação retornada será a mais recente feita com o ITK.
Para realizar sondagem de transações específicas, o ATK deverá ser utilizado.
Exemplo.:
https://sandbox-auth-integration.stone.com.br/TransactionStatusReport
Tags de Mensagem de Requisição
Abaixo estão descritas as tags para a mensagem de requisição de consulta de transação:
Campo | Ocorrência | Tipo | Tamanho | Descrição |
---|---|---|---|---|
AcceptorTransactionStatusReportRequest <AccptrTxStsRptRq> | [1..1] | Container | Raiz da requisição de consulta de transação | |
Header <Hdr> | [1..1] | Container | Cabeçalho da mensagem | |
MessageFunction <MsgFctn> | [1..1] | CodeSet | an 4 | O valor deve ser TSRR para a mensagem de AcceptorTransactionStatusReportRequestV02.1 |
ProtocolVersion <PrtcolVrsn> | [1..1] | Text | ans …6 | O valor deve ser 2.0 para a esta mensagem |
InitialParty <InitgPty> | [1..1] | Container | Identificação unica da parte que iniciou a requisição (cliente) | |
Identification <Id> | [1..1] | Text | an 32 | Id do terminal ou id do lojista, mais conhecido como SAK |
TransactionStatusReport <TxStsRpt> | [1..1] | Container | Raiz das informações sobre a transação consultada | |
Transaction <Tx> | [1..*] | Container | Coleção de transações para pesquisa. | |
TransactionReport <TxRpt> | [1..*] | Container | Define o tipo de Resposta OPRS = Retorna os dados de todas as operações da transação. SUMM = Retorna um relatorio detalhado sobre a transação. | |
OriginalTransaction <OrgnlTx> | [1..1] | Container | Dados da transação original. | |
RecipientTransactionIdentification <RcptTxId> | [0..1] | Text | an ...35 | Identificador da transação fornecido pelo adquirente na resposta da autorização. (ATK) |
InitiatorTransactionIdentification <InitrTxId> | [0..1] | Text | an ...32 | Identificação da transação definida pelo sistema que se comunica com o Host Stone. (ITK) |
Pedido de Consulta de Transação
<Document xmlns="urn:AcceptorTransactionStatusReportRequestV02.1">
<AccptrTxStsRptRq>
<Hdr>
<MsgFctn>TSRR</MsgFctn>
<PrtcolVrsn>2.0</PrtcolVrsn>
<InitgPty>
<Id>ABCDE123456789ABCDE123456789ABCD</Id>
</InitgPty>
</Hdr>
<TxStsRpt>
<Tx>
<TxRpt>OPRS</TxRpt>
<TxRpt>SUMM</TxRpt>
<OrgnlTx>
<InitrTxId>2a42327648f644f4</InitrTxId>
<RcptTxId>11350002663228</RcptTxId>
</OrgnlTx>
</Tx>
</TxStsRpt>
</AccptrTxStsRptRq>
</Document>
Tags da Mensagem de Resposta
Abaixo estão descritas as tags para a mensagem de resposta de consulta de transação:
Campo | Ocorrência | Tipo | Tamanho | Descrição |
---|---|---|---|---|
TransactionStatusReportResponse <TxStsRptRspn> | [1..1] | Container | Conteúdo da resposta da pesquisa | |
Transaction <Tx> | [1..*] | Container | Coleção de resultados de transações | |
Summary <Summry> | [1..1] | Container | Parte detalhada de informações sobre a transação | |
RecipientTransactionIdentification <RcptTxId> | [1..1] | Text | an ...35 | Identificador do adquirente para a transação. É o ATK da transação original. |
InitiatorTransactionIdentification <InitrTxId> | [1..1] | Text | an ...32 | Identificador único da transação para o cliente (lojista) |
AcquirerDateTime <AcqrrDtTm> | [1..1] | DateTime | ans 19 | Data da transação no adquirente. Formato: yyyy-MM-ddTHH:mm:ss |
LocalDateTime <LclDtTm> | [1..1] | DateTime | ans 19 | Data do local da transação. Formato: yyyy-MM-ddTHH:mm:ss. |
FirstCaptureDateTime <FrstCaptrDtTm> | [1..1] | DateTime | ans 19 | Data da primeira captura. Formato: yyyy-MM-ddTHH:mm:ss |
FirstCancellationDateTime <FrstCxlDtTm> | [1..1] | DateTime | ans 19 | Data do primeiro cancelamento Formato: yyyy-MM-ddTHH:mm:ss |
TotalOriginalAmount <TtlOrgnlAmt> | [1..1] | Amount | n ...23 | Valor original da transação Fomato: {0.00} |
TotalAuthorisedAmount <TtlAuthrsdAmt> | [1..1] | Amount | n ...23 | Valor autorizado da transação Fomato: {0.00} |
TotalCapturedAmount <TtlCaptrdAmt> | [1..1] | Amount | n ...23 | Valor capturado da transação Fomato: {0.00} |
TotalCancelledAmount <TtlCancAmt> | [1..1] | Amount | n ...23 | Valor cancelado da transação Fomato: {0.00} |
AuthorisedStatus <AuthrsdSts> | [1..1] | CodeSet | n 4 | Status da transação FULL : Indica que o valor integral da transação foi autorizado. PART : Indica que o valor original foi autorizado parcialmente NONE : Indica que a transação não foi autorizada |
CapturedStatus <CaptrdSts> | [1..1] | CodeSet | n 4 | Status da captura FULL : Indica que o valor total da transação foi capturado. PART : Indica que somente parte do valor autorizado foi capturado. NONE: Indica que a transação não foi capturada. |
CanceledStatus <CancSts> | [1..1] | CodeSet | n 4 | Status do cancelamento FULL : Indica que o valor total da transação foi cancelado. PART : Indica que somente parte do valor capturado foi cancelado. NONE: Indica que a transação não foi cancelada. |
Currency <Ccy> | [1..1] | CodeSet | n 3 | Moeda utilizada na transação em conformidade com a ISO 4217 - 986 = Real Brasileiro. |
AccountType <AcctTp> | [1..1] | CodeSet | n 4 | Tipo de conta da transação original CRDT : Crédito CHCK : Debito |
MerchantShortName <MrchntShrtNm> | [1..1] | Text | an ...25 | Nome do lojista usado na transação Será exibido o soft descriptor quando este for enviado, se não o nome padrão do lojista será retornado. |
MerchantCategoryCode <MrchntCtgyCd> | [1..1] | Text | n 4 | Sera retornado o Mcc usado na hora da transação, caso não tenha sido informado sera retornado o mcc padrão do lojista. |
AdditionalService <AddtlSvc> | [1..1] | CodeSet | n 4 | Serviços adicionais: INSA:Indica que foi solicitado parcelamento tipo lojista “sem juros”. INSI : Indica que foi solicitado parcelamento tipo emissor “com juros” |
Installment <Instlmt> | [1..1] | Container | Informações da parcela | |
TotalNumberOfPayments <TtlNbOfPmts> | [1..1] | Quantity | n ..2 | Número de parcelas da transação |
Operations <Oprs> | [1..1] | Container | Operações da transação | |
Authorisation <Authstn> | [1..1] | Container | Informações sobre a autorização | |
ReceptorOperationIdentification <RcptOprId> | [1..1] | Text | an …32 | Número da operação no adquirente. |
AcquirerDateTime <AcqrrDtTm> | [1..1] | DateTime | ans 19 | Data da transação no adquirente Formato: yyyy-MM-ddTHH:mm:ss |
LocalDateTime <LclDtTm> | [1..1] | DateTime | ans 19 | Data do local da transação Formato: yyyy-MM-ddTHH:mm:ss |
OriginalAmount <OrgnlAmt> | [1..1] | Amount | n ...23 | Valor original da transação Formato: {0.00} |
AuthorisedAmount <AuthrsdAmt> | [1..1] | Amount | n ...23 | Valor autorizado da transação Formato: {0.00} |
Response <Rspn> | [1..1] | CodeSet | n 4 | Resposta para a transação: DECL : A operação não foi autorizada APPR : A Operação foi autorizada TECH : Ocorreu um erro na operação |
ResponseReason <RspnRsn> | [1..1] | Text | n 4 | Codigo de resposta para a transação |
AuthorisationCode <AuthstnCd> | [1..1] | Text | n 6 | Codigo de autorização fornecido pelo banco |
Capture <Cptr> | [1..1] | Container | Informações sobre as capturas | |
Cancellation <Cxl> | [1..1] | Container | Informações sobre os cancelamentos |