Authorize (Autorização)

Introdução

Neste item exemplificamos o modelo esperado pela nossa API para as requisições de autorização e o mapeamento das tags para a mensagem de resposta.

Deve-se adicionar o endpoint /Authorize ao endereço de conexão.

👍

Exemplo.:

https://sandbox-auth-integration.stone.com.br/Authorize

Tags da Mensagem de Requisição

Abaixo estão descritas as tags para a mensagem de requisição de autorização:

📘

Info

Para saber mais informações, passe o mouse sobre a tag.

CampoOcorrênciaTipoTamanhoHierarquia
Acceptor Authorization Request <AccptrAuthstnReq>[1..1]Container-1
Header <Hdr>[1..1]Container-1.1
MessageFunction <MsgFctn>[1..1]CodeSetans ...61.1.1
ProtocolVersion <PrtcolVrsn>[1..1]Textans ...61.1.2
Initiating Party <InitgPty>[0..1]Container-1.1.3
Party Identification <Id>[1..1]Textans ... 351.1.3.1
Party ShortName <ShrtNm>[0..1]Textans ... 351.1.3.2
AuthorisationRequest <AuthstnReq>[1..1]Container-1.2
Environment <Envt>[1..1]Container-1.2.1
Merchant <Mrchnt>[1..1]Container-1.2.1.1
Merchant Identification <ID>[1..1]Container-1.2.1.1.1
SaleAffilitionKey Identification <ID>[1..1]Textans 321.2.1.1.1.1
Merchant ShortName <ShrtNm>[0..1]Textans ...351.2.1.1.1.2
Point of Interaction <POI>[1..1]Container-1.2.1.2
SystemName <SysNm>[1..1]Textans ...701.2.1.2.1
POI Identification <ID>[1..1]Container-1.2.1.2.2
POI Code Identification <ID>[1..1]Textans ...351.2.1.2.2.1
Card <Card>[1..1]Container-1.2.1.3
PlainCardData <PlainCardData>[0..1]Container-1.2.1.3.1
PAN <PAN>[1..1]Textn ...191.2.1.3.2
ExpiryDate <XpryDt>[1..1]Textans 71.2.1.3.3
Card Security Code <CardSctyCd>[1..1]Container-1.2.1.3.4
CSC Value <CSCVal>[0..1]Textn ...41.2.1.3.4.1
CardHolder <Crdhldr>[1..1]Container-1.2.1.4
Name <Nm>[1..1]Textan ...451.2.1.4.1
Authentication <Authntcn>[0..1]Container-1.2.1.4.2
AuthenticationMethod <AuthntcnMtd>[1..1]Textan 41.2.1.4.2.1
AuthenticationValue <AuthntcnVal>[1..1]Textans ...6251.2.1.4.2.2
AuthenticationResult <AuthntcnRslt>[1..1]Textan 41.2.1.4.2.3
3DSecure <TdScre>[1..1]Container-1.2.1.4.2.4
TransactionID <TxId>[1..1]Textans ...361.2.1.4.2.3.1
Versão 3DS <TdScreVrsn>[1..1]Textan 41.2.1.4.2.4.2
Context <Cntxt>[1..1]Container-1.2.2
PaymentContext <PmtCntxt>[1..1]Container-1.2.2.1
CardDataEntryMode <CardDataNtryMd>[1..1]CodeSetan 41.2.2.1.1
TransactionChannel <TxChanl>[1..1]CodeSetan 41.2.2.1.2
SalesContext <SaleCntxt>[0..1]Container-1.2.2.2
SponsoredMerchant <SpnsrdMrchnt>[1..1]Container-1.2.2.2.1
City <City>[1..1]Textans …351.2.2.2.2
Street Name
<StrtNm>
[1..1]Textans …351.2.2.2.3
PostalAddress <PstlAdr>[1..1]Textn …161.2.2.2.4
Country SubDivision
(Estado do sub-merchant)

<CtrySubDvsn>
[1..1]Textn ...21.2.2.2.5
Country Code <CtryCd>[1..1]Textn 31.2.2.2.6
TaxIdentificationType <TaxIdTp>[1..1]Textan …41.2.2.2.7
TaxIdentificationNumber <TaxIdNb>[1..1]Textn …351.2.2.2.8
RegisteredIdentifier <RegdIdr>[1..1]Textan ... 151.2.2.2.9
Transaction <Tx>[1..1]Container-1.2.3
AdditionalService <AddtlSvc>[0..1]CodeSetan 41.2.3.1
ServiceAttribute <SvcAttr>[0..1]CodeSetan 41.2.3.2
InitiatorTransactionIdentification <InitrTxId>[1..1]Textan ...321.2.3.3
MerchantCategoryCode <MrchntCtgyCd>[0..1]Textn 41.2.3.4
TransactionCapture <TxCaptr>[1..1]Booleanan 41.2.3.5
TransactionType <TxTp>[0..1]Textan 41.2.3.6
TransactionIdentification <TxId>[1..1]Container-1.2.3.7
TransactionDateTime <TxDtTm>[1..1]DateTimeans 191.2.3.7.1
TransactionReference <TxRef>[1..1]Textan ...321.2.3.7.2
TransactionDetails <TxDtls>[1..1]Container-1.2.3.8
Currency <Ccy>[1..1]CodeSetn 31.2.3.8.1
TotalAmount <TtlAmt>[1..1]Amountn ...231.2.3.8.2
AccountType <AcctTp>[0..1]Textan 41.2.3.8.3
RecurringTransaction <RcrngTx>[0..1]Container-1.2.3.8.4
InstalmentType <InstlmtTp>[1..1]Textan 41.2.3.8.4.1
TotalNumberOfPayments <TtlNbOfPmts>[1..1]Numbern ...21.2.3.8.4.2

Pedido de Autorização

<Document xmlns="urn:AcceptorAuthorisationRequestV02.1">
    <AccptrAuthstnReq>
        <Hdr>
            <MsgFctn>AUTQ</MsgFctn>
            <PrtcolVrsn>2.0</PrtcolVrsn>
        </Hdr>
        <AuthstnReq>
            <Envt>
                <Mrchnt>
                    <Id>
                        <Id>ABCDE123456789ABCDE123456789ABCD</Id>
                        <ShrtNm>Nome da fatura</ShrtNm>
                    </Id>
                </Mrchnt>               
                <POI>
                    <Id>
                        <Id>2FB4C89A</Id>
                    </Id>
                    <SysNm>Nome do Gateway</SysNm>
                </POI>
              <Card>
                    <PlainCardData>
                        <PAN>4000000000000010</PAN>
                        <XpryDt>2027-10</XpryDt>
                        <CardSctyCd>
                            <CSCVal>123</CSCVal>
                        </CardSctyCd>
                    </PlainCardData>
                </Card>
              	<Crdhldr>
                  <Nm>Bruce Banner</Nm> 
                  <Authntcn>
                    <AuthntcnMtd>TDSC</AuthntcnMtd>
                    <AuthntcnVal>T420701032124328jJJLtQa+Iws8AREAEbjsA1MAAAA=</AuthntcnVal>
                    <AuthntcnRslt>CRPT</AuthntcnRslt>
                    <TdScre>
                      <TxId>f38e6948-5388-41a6-bca4-b49723c19437</TxId> 
                      <TdScreVrsn>VRS2<TdScreVrsn> 
                    </TdScre>
                  </Authntcn>
                </Crdhldr>
            </Envt>
            <Cntxt>
              <PmtCntxt>
                <CardDataNtryMd>PHYS</CardDataNtryMd>
                <TxChanl>ECOM</TxChanl>
              </PmtCntxt>
              <SaleCntxt>
                <SpnsrdMrchnt>
                  <City>São Paulo</City>
                  <PstlAdr>04119010</PstlAdr>
                  <TaxIdTp>JRDC</TaxIdTp>
                  <TaxIdNb>123456789000012</TaxIdNb>
                  <RegdIdr>175428814</RegdIdr>
                </SpnsrdMrchnt>
              </SaleCntxt>
            </Cntxt>
            <Tx>
                <AddtlSvc>RECP</AddtlSvc>
                <SvcAttr>FREC</SvcAttr>
                <InitrTxId>123123123</InitrTxId>
                <TxCaptr>false</TxCaptr>
                <TxId>
                    <TxDtTm>2023-00-00T00:00:00</TxDtTm>
                    <TxRef>06064f516a50483da7f189243c95ccca</TxRef>
                </TxId>
                <TxDtls>
                    <Ccy>986</Ccy>
                    <TtlAmt>100</TtlAmt>
                    <AcctTp>CRDT</AcctTp>
                    <RcrngTx>
                        <InstlmtTp>NONE</InstlmtTp>
                        <TtlNbOfPmts>0</TtlNbOfPmts>
                    </RcrngTx>
                </TxDtls>
            </Tx>
        </AuthstnReq>
    </AccptrAuthstnReq>
</Document>

Tags na Mensagem de Resposta

Abaixo estão descritas as tags para a mensagem de resposta de autorização:

CampoOcorrênciaTipoTamanhoDescrição
Header <Hdr>[1..1]ContainerCabeçalho da mensagem
MessageFunction <MsgFctn>[1..1]CodeSetn 4Identifica o tipo de processo em que a mensagem se propõe. Fixo: AUTP = AuthorisationResponse.
ProtocolVersion <PrtcolVrsn>[1..1]Textans ...6Versão do protocolo utilizado na mensagem.
CreationDateTime <CreDtTm>[1..1]Textans 19Data de criação da mensagem no formato:
yyyy-mm-ddTHH:MM:SS
AuthorisationResponse <AuthstnRspn>[1..1]ContainerInformações relacionadas à resposta da autorização.
Environment <Envt>[1..1]ContainerAmbiente da transação.
Card <Card>[1..1]ContainerDados do cartão
CardBrand <CardBrnd>[1..1]Textans ...30Nome da bandeira que foi realizada a transação
Merchant Identification <MrchntId>[1..1]ContainerDados do estabelecimento.
Identification <Id>[1..1]Textan 32Identificação do estabelecimento comercial no adquirente. Também conhecido internamente como “SaleAffiliationKey”.
POIId <POIId>[0..1]ContainerDados do ponto de interação.
Identification <Id>[1..1]Textan 32Identificação do POI.
Transaction <Tx>[1..1]ContainerInformações da transação.
TransactionIdentification <TxId>[1..1]ContainerDados de identificação da transação atribuída pelo POI (Ponto de interação).
TransactionDateTime <TxDtTm>[1..1]DateTimeans 19Data local e hora da transação atribuído pelo POI (ponto de interação). Este campo será ecoado pelo adquirente.
TransactionReference <TxRef>[1..1]Textan …32Identificação da transação atribuída pelo POI (Ponto de interação). Este campo será ecoado pelo adquirente.
RecipientTransactionIdentification <RcptTxId>[1..1]Textan ...35Identificação da transação definida pela Stone.

Este campo é conhecido internamente na Stone como ATK
RecipientOperationIdentification <RcptOprId>[1..1]Textan ...35Identificação da operação nos sistemas da Stone.
IssuerTransactionIdentification <IssrTxId>[0..1]Textan ...35Identificação da transação definida pela bandeira.
TransactionDetails <TxDtls>[1..1]ContainerDetalhes da transação.
Currency <Ccy>[1..1]CodeSetn 3Moeda utilizada na transação em conformidade com a ISO 4217 - 986 = Real Brasileiro.
TotalAmount <TtlAmt>[1..1]Amountn ...23Valor total autorizado em centavos.
AccountFundingSource <AcctFndSrc>[1..1]Textn ...7Tipo de conta que será utilizada pelo emissor caso a transação seja aprovada.
AccountType <AcctTp>[0..1]CodeSetan 4Modalidade do cartão utilizado na transação.
CRDT = Crédito;
TransactionResponse <TxRspn>[1..1]ContainerDados de resposta da transação.
AuthorisationResult <AuthstnRslt>[1..1]ContainerResultado da autorização.
ResponseToAuthorisation<RspnToAuthstn>[1..1]ContainerDados da resposta da autorização.
Response <Rspn>[1..1]CodeSetan 4Resposta da transação:
DECL: Declined,
APPR: Aproved,
PART: PartialApproved,
e TECH: TechinicalError.
ResponseReason <RspnRsn>[1..1]Textn 4Código de resposta da autorização (equivalente ao campo 39 da ISO 8583 de 2003).
SchemeResponse <SchmRspn>[0..1]Textan …3Código de resposta da bandeira.
AuthorisationCode <AuthstnCd>[0..1]Textn 40Código de autorização retornado pelo emissor.
CompletionRequired <CmpltnReqrd>[0..1]Booleanan 4Indica se a mensagem precisa ser capturada posteriormente.
Action <Actn>[0..*]ContainerMensagem a ser demonstrada no display
ActionType <ActnTp>[1..1]CodeSetn 4Fixo: DISP
MessageToPresent <MsgToPres>[1..1]ContainerMensagem a ser demonstrada no display
MessageDestination <MsgDstn>[1..1]CodeSetn 4A quem se destina a mensagem no contexto:

“MDSP” = Mensagem para ser apresentada no display

“CDSP“ – Mensagem para ser exibida no display do cliente
MessageContent <MsgCntt>[1..1]Textans 20000Texto para ser exibido em display