TransactionStatusReport (Consultas)

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:

CampoOcorrênciaTipoTamanhoDescrição
AcceptorTransactionStatusReportRequest <AccptrTxStsRptRq>[1..1]ContainerRaiz da requisição de consulta de transação
Header <Hdr>[1..1]ContainerCabeçalho da mensagem
MessageFunction <MsgFctn>[1..1]CodeSetan 4O valor deve ser TSRR para a mensagem de AcceptorTransactionStatusReportRequestV02.1
ProtocolVersion <PrtcolVrsn>[1..1]Textans …6O valor deve ser 2.0 para a esta mensagem
InitialParty <InitgPty>[1..1]ContainerIdentificação unica da parte que iniciou a requisição (cliente)
Identification <Id>[1..1]Textan 32Id do terminal ou id do lojista, mais conhecido como SAK
TransactionStatusReport <TxStsRpt>[1..1]ContainerRaiz das informações sobre a transação consultada
Transaction <Tx>[1..*]ContainerColeção de transações para pesquisa.
TransactionReport <TxRpt>[1..*]ContainerDefine 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]ContainerDados da transação original.
RecipientTransactionIdentification <RcptTxId>[0..1]Textan ...35Identificador da transação fornecido pelo adquirente na resposta da autorização. (ATK)
InitiatorTransactionIdentification <InitrTxId>[0..1]Textan ...32Identificaçã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:

CampoOcorrênciaTipoTamanhoDescrição
TransactionStatusReportResponse <TxStsRptRspn>[1..1]ContainerConteúdo da resposta da pesquisa
Transaction <Tx>[1..*]ContainerColeção de resultados de transações
Summary <Summry>[1..1]ContainerParte detalhada de informações sobre a transação
RecipientTransactionIdentification <RcptTxId>[1..1]Textan ...35Identificador do adquirente para a transação. É o ATK da transação original.
InitiatorTransactionIdentification <InitrTxId>[1..1]Textan ...32Identificador único da transação para o cliente (lojista)
AcquirerDateTime <AcqrrDtTm>[1..1]DateTimeans 19Data da transação no adquirente.
Formato: yyyy-MM-ddTHH:mm:ss
LocalDateTime <LclDtTm>[1..1]DateTimeans 19Data do local da transação.
Formato: yyyy-MM-ddTHH:mm:ss.
FirstCaptureDateTime <FrstCaptrDtTm>[1..1]DateTimeans 19Data da primeira captura.
Formato: yyyy-MM-ddTHH:mm:ss
FirstCancellationDateTime <FrstCxlDtTm>[1..1]DateTimeans 19Data do primeiro cancelamento
Formato: yyyy-MM-ddTHH:mm:ss
TotalOriginalAmount <TtlOrgnlAmt>[1..1]Amountn ...23Valor original da transação
Fomato: {0.00}
TotalAuthorisedAmount <TtlAuthrsdAmt>[1..1]Amountn ...23Valor autorizado da transação
Fomato: {0.00}
TotalCapturedAmount <TtlCaptrdAmt>[1..1]Amountn ...23Valor capturado da transação
Fomato: {0.00}
TotalCancelledAmount <TtlCancAmt>[1..1]Amountn ...23Valor cancelado da transação
Fomato: {0.00}
AuthorisedStatus <AuthrsdSts>[1..1]CodeSetn 4Status 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]CodeSetn 4Status 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]CodeSetn 4Status 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]CodeSetn 3Moeda utilizada na transação em conformidade com a ISO 4217 - 986 = Real Brasileiro.
AccountType <AcctTp>[1..1]CodeSetn 4Tipo de conta da transação original

CRDT : Crédito

CHCK : Debito
MerchantShortName <MrchntShrtNm>[1..1]Textan ...25Nome 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]Textn 4Sera 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]CodeSetn 4Serviç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]ContainerInformações da parcela
TotalNumberOfPayments <TtlNbOfPmts>[1..1]Quantityn ..2Número de parcelas da transação
Operations <Oprs>[1..1]ContainerOperações da transação
Authorisation <Authstn>[1..1]ContainerInformações sobre a autorização
ReceptorOperationIdentification <RcptOprId>[1..1]Textan …32Número da operação no adquirente.
AcquirerDateTime <AcqrrDtTm>[1..1]DateTimeans 19Data da transação no adquirente
Formato: yyyy-MM-ddTHH:mm:ss
LocalDateTime <LclDtTm>[1..1]DateTimeans 19Data do local da transação
Formato: yyyy-MM-ddTHH:mm:ss
OriginalAmount <OrgnlAmt>[1..1]Amountn ...23Valor original da transação
Formato: {0.00}
AuthorisedAmount <AuthrsdAmt>[1..1]Amountn ...23Valor autorizado da transação
Formato: {0.00}
Response <Rspn>[1..1]CodeSetn 4Resposta 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]Textn 4Codigo de resposta para a transação
AuthorisationCode <AuthstnCd>[1..1]Textn 6Codigo de autorização fornecido pelo banco
Capture <Cptr>[1..1]ContainerInformações sobre as capturas
Cancellation <Cxl>[1..1]ContainerInformações sobre os cancelamentos