Como funciona<\/h2>\n
Antes de acionar um pagamento:<\/p>\n
- \n
- Voc\u00ea faz uma solicita\u00e7\u00e3o de aquisi\u00e7\u00e3o de cart\u00e3o (consulte a Etapa 1<\/a>). Voc\u00ea pode incluir o valor a pagar nesta solicita\u00e7\u00e3o.<\/li>\n
- O terminal de pagamento solicita que o cliente apresente seu cart\u00e3o.\n
\nPara uma transa\u00e7\u00e3o com chip de contato, o cliente n\u00e3o deve remover o cart\u00e3o do terminal.<\/p>\n<\/div><\/div><\/li>\n
- Voc\u00ea aplica sua l\u00f3gica de neg\u00f3cios ap\u00f3s receber a resposta de aquisi\u00e7\u00e3o do cart\u00e3o. Por exemplo:\n
- \n
- Voc\u00ea pode usar o pa\u00eds do emissor e o cart\u00e3o BIN na resposta para determinar se \u00e9 permitido fazer compras isentas de impostos.<\/li>\n
- Voc\u00ea pode verificar se esse cliente \u00e9 reconhecido. Se n\u00e3o, voc\u00ea pode fazer uma solicita\u00e7\u00e3o de entrada para solicitar que eles se inscrevam no seu programa de fidelidade. Se sim, voc\u00ea pode verificar se eles se qualificam para um desconto, presente ou oferta especial.<\/li>\n<\/ul><\/li>\n
- Voc\u00ea faz uma solicita\u00e7\u00e3o de pagamento que inclui a
TransactionID<\/code> a partir da aquisi\u00e7\u00e3o do cart\u00e3o (consulte a Etapa 2<\/a>). Dependendo da sua l\u00f3gica de neg\u00f3cios, pode ser necess\u00e1rio incluir campos espec\u00edficos nesta solicita\u00e7\u00e3o ou alterar o valor. Para o cliente, a aquisi\u00e7\u00e3o do cart\u00e3o e o pagamento subsequente parecer\u00e3o uma \u00fanica a\u00e7\u00e3o.<\/li>\n- O terminal mostra o valor a ser pago e o pagamento \u00e9 conclu\u00eddo.\n
\nSe o valor da solicita\u00e7\u00e3o de pagamento for igual ao valor da solicita\u00e7\u00e3o de aquisi\u00e7\u00e3o de cart\u00e3o, um cliente que use um cart\u00e3o que realizada transa\u00e7\u00f5es sem contato precisar\u00e1 tocar no cart\u00e3o apenas uma vez. Caso contr\u00e1rio, eles precisar\u00e3o tocar duas vezes no cart\u00e3o: uma para os detalhes do cart\u00e3o e outra para o pagamento.<\/p>\n<\/div><\/div><\/li>\n<\/ol>\n
Voc\u00ea tamb\u00e9m pode cancelar a aquisi\u00e7\u00e3o do cart\u00e3o<\/a> em vez de continuar com um pagamento. Voc\u00ea faria isso, por exemplo, se os dados recuperados do cart\u00e3o n\u00e3o se qualificarem para uma transa\u00e7\u00e3o.<\/p>\n
Antes de voc\u00ea come\u00e7ar<\/h2>\n
Antes de iniciar a aquisi\u00e7\u00e3o do cart\u00e3o:<\/p>\n
- \n
- Verifique se voc\u00ea criou uma integra\u00e7\u00e3o que pode efetuar um pagamento<\/a>.<\/li>\n
- Em sua Customer Area<\/a>, v\u00e1 para Developers<\/strong> > Additional data<\/strong>, selecione os dados necess\u00e1rios para o seu caso de uso. Por exemplo, detalhes recorrentes para reconhecimento do cliente. A API de terminais retorna esses dados no
AdditionalResponse<\/code>.<\/li>\n<\/ol>\nEtapa 1: Adquirir detalhes do cart\u00e3o<\/h2>\n
Para recuperar detalhes do cart\u00e3o e do cliente antes de efetuar um pagamento:<\/p>\n
- \n
- \n
Fa\u00e7a uma solicita\u00e7\u00e3o POST para um endpoint da API de terminais<\/a>, especificando:<\/p>\n
- \n
- \n
MessageHeader<\/code>: Segue a estrutura daMessageHeader<\/code> padr\u00e3o, explicada nos fundamentos da API de terminais<\/a>, que incluem:<\/p>\n- \n
ProtocolVersion<\/code>: 3.0<\/strong><\/li>\nMessageClass<\/code>: Service<\/strong><\/li>\nMessageCategory<\/code>: CardAcquisition<\/strong><\/li>\nMessageType<\/code>: Request<\/strong><\/li>\nSaleID<\/code>: Seu ID exclusivo para a caixa registradora..<\/li>\nServiceID<\/code>: Seu ID exclusivo para esta tentativa de transa\u00e7\u00e3o, consistindo em 1 a 10 caracteres alfanum\u00e9ricos. Esse valor precisa ser exclusivo nas \u00faltimas 48 horas.<\/li>\n- \n
POIID<\/code>: ID exclusivo do terminal. Isso indica para qual terminal o pedido ser\u00e1 roteado.<\/p>\n\n<\/li>\n<\/ul>\n<\/li>\n- \n
CardAcquisitionRequest<\/a>: O corpo da solicita\u00e7\u00e3o de aquisi\u00e7\u00e3o de cart\u00e3o, que inclui:<\/p>\n
- \n
SaleData.SaleTransactionID.TransactionID<\/code>: Sua refer\u00eancia exclusiva para esta solicita\u00e7\u00e3o.<\/li>\nSaleData.SaleTransactionID.TimeStamp<\/code>: Data e hora da solicita\u00e7\u00e3o, no formato UTC<\/a>.<\/li>\nSaleData.TokenRequestedType<\/code>\n\n Optional\n <\/tag>\n<\/div>\n: Customer<\/strong>. Isso retorna o alias do cart\u00e3o no campo TokenValue<\/code> da resposta. Se voc\u00ea n\u00e3o incluir o campoTokenRequestedType<\/code>, o alias do cart\u00e3o ser\u00e1 retornado apenas noAdditionalResponse<\/code>, e voc\u00ea precisar\u00e1 decodific\u00e1-lo para obter o alias do cart\u00e3o.<\/li>\nCardAcquisitionTransaction<\/code>: Este objeto est\u00e1 vazio ou cont\u00e9m:\n- \n
TotalAmount<\/code>: Valor da transa\u00e7\u00e3o.
\nSe o valor for o mesmo da solicita\u00e7\u00e3o de pagamento subsequente, uma transa\u00e7\u00e3o sem contato n\u00e3o exigir\u00e1 tocar novamente no cart\u00e3o para o pagamento
\nVoc\u00ea pode alterar o valor posteriormente (na solicita\u00e7\u00e3o de pagamento) com base nas informa\u00e7\u00f5es da caixa registradora, por exemplo, para dar um desconto de fidelidade. Se voc\u00ea espera que o valor mude na maioria dos casos, por exemplo, se voc\u00ea fizer uma aquisi\u00e7\u00e3o de cart\u00e3o assim que o primeiro item for digitalizado, poder\u00e1 optar por omitir o campoTotalAmount<\/code>.<\/li>\n<\/ul><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n<\/code-sample>\n<\/div>\n<\/li>\n - \n
No
CardAcquisitionResponse<\/code>, observe o seguinte:<\/p>\n- \n
POIData.POITransactionID<\/code>: OTimeStamp<\/code> eTransactionID<\/code> desta solicita\u00e7\u00e3o de aquisi\u00e7\u00e3o de cart\u00e3o. Voc\u00ea precisar\u00e1 desses dados posteriormente quando continuar com um pagamento.<\/li>\nPaymentInstrumentData.CardData<\/code>: As informa\u00e7\u00f5es do cart\u00e3o, que est\u00e3o dispon\u00edveis no pr\u00f3prio cart\u00e3o. No m\u00ednimo, incluindo o PAN mascarado e a data de validade. Se voc\u00ea especificou umTokenRequestedType<\/code> do Cliente<\/strong> no seu pedido, este tamb\u00e9m inclui:\n- \n
PaymentToken.TokenValue<\/code>: O alias do cart\u00e3o.<\/li>\n<\/ul><\/li>\nResponse.AdditionalResponse<\/code>: Uma sequ\u00eancia base64. Quando decodificado, este \u00e9 um objeto JSON com dados adicionais que voc\u00ea pode precisar em sua l\u00f3gica de neg\u00f3cios, incluindo:\n- \n
alias<\/code>: O alias do cart\u00e3o.<\/li>\ncardIssuerCountryId<\/code> ecardBin<\/code>: dados necess\u00e1rios para determinar a elegibilidade para compras isentas de impostos.<\/li>\nshopperReference<\/code> eshopperEmail<\/code>: Se inclu\u00eddo, isso significa que voc\u00ea j\u00e1 criou um perfil para esse cliente<\/a> no seu banco de dados.<\/li>\n<\/ul><\/li>\n<\/ul>\n<\/li>\n<\/ol>\nEtapa 2: continue com o pagamento<\/h2>\n
Depois de aplicar sua l\u00f3gica comercial, voc\u00ea estar\u00e1 pronto para acompanhar a aquisi\u00e7\u00e3o do cart\u00e3o com uma solicita\u00e7\u00e3o de pagamento:<\/p>\n
- \n
- \n
Fa\u00e7a uma solicita\u00e7\u00e3o POST para um endpoint da API de terminais<\/a>, especificando:<\/p>\n
- \n
- \n
MessageHeader<\/code>: Segue a estrutura daMessageHeader<\/code> padr\u00e3o, explicada nos fundamentos da API de terminais<\/a>, que incluem:<\/p>\n- \n
ProtocolVersion<\/code>: 3.0<\/strong><\/li>\nMessageClass<\/code>: Service<\/strong><\/li>\nMessageCategory<\/code>: Payment<\/strong><\/li>\nMessageType<\/code>: Request<\/strong><\/li>\nSaleID<\/code>: Seu ID exclusivo para a caixa registradora..<\/li>\nServiceID<\/code>: Seu ID exclusivo para esta tentativa de transa\u00e7\u00e3o, consistindo em 1 a 10 caracteres alfanum\u00e9ricos. Esse valor precisa ser exclusivo nas \u00faltimas 48 horas.<\/li>\n- \n
POIID<\/code>: ID exclusivo do terminal. Esse deve ser o mesmo terminal de pagamento para o qual voc\u00ea direcionou a solicita\u00e7\u00e3o de aquisi\u00e7\u00e3o do cart\u00e3o.<\/p>\n\n<\/li>\n<\/ul>\n<\/li>\n- \n
PaymentRequest<\/code>: O corpo da solicita\u00e7\u00e3o da solicita\u00e7\u00e3o de pagamento deve incluir:<\/p>\n- \n
SaleData.SaleTransactionID.TransactionID<\/code>: Sua refer\u00eancia exclusiva para esta solicita\u00e7\u00e3o de pagamento.<\/li>\nSaleData.SaleTransactionID.TimeStamp<\/code>: Data e hora da solicita\u00e7\u00e3o de pagamento, no formato UTC<\/a>.<\/li>\nSaleData.SaleToAcquirerData<\/code>: Pode ser necess\u00e1rio especificar as tender options<\/a> ou dados adicionais<\/a> aqui, dependendo da l\u00f3gica de neg\u00f3cios. Por exemplo, taxfree.indicator=true<\/strong> para compras isentas de impostos no fluxo de reembolso r\u00e1pido ou dados de reconhecimento do cliente.<\/li>\nPaymentTransaction.AmountsReq.Currency<\/code>: A moeda<\/a> da transa\u00e7\u00e3o.<\/li>\nPaymentTransaction.AmountsReq.RequestedAmount<\/code>: O valor da transa\u00e7\u00e3o.<\/li>\n- \n
PaymentData.CardAcquisitionReference<\/code>: ATimestamp<\/code> eTransactionID<\/code> da solicita\u00e7\u00e3o de aquisi\u00e7\u00e3o do cart\u00e3o. Voc\u00ea recebeu esses dados no objetoPOIData.POITransactionID<\/code> daCardAcquisitionResponse<\/code>.<\/p>\n\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n<\/code-sample>\n<\/div>\n<\/li>\n - \n
Na
PaymentResponse<\/code> note o seguinte:<\/p>\n- \n
PaymentInstrumentData.CardData<\/code>: Os mesmos detalhes do cart\u00e3o que voc\u00ea recebeu noCardAcquisitionResponse<\/code>.<\/li>\nResponse.AdditionalResponse<\/code>: Uma sequ\u00eancia base64. Quando decodificado, este \u00e9 um objeto JSON com dados adicionais, incluindo:\n- \n
alias<\/code>: O alias do cart\u00e3o.<\/li>\n<\/ul><\/li>\n<\/ul>\n<\/li>\n<\/ol>\nCancelando a aquisi\u00e7\u00e3o do cart\u00e3o<\/h2>\n
Se o
CardData<\/code> que voc\u00ea obtiver naCardAcquisitionResponse<\/code> indica que o cart\u00e3o n\u00e3o pode ser usado para o pagamento subsequente, voc\u00ea pode cancelar a aquisi\u00e7\u00e3o do cart\u00e3o comEnableServiceRequest<\/code>:<\/p>\n- \n
- \n
Fa\u00e7a uma solicita\u00e7\u00e3o POST para um endpoint da API de terminais<\/a>, especificando:<\/p>\n
- \n
- \n
MessageHeader<\/code>: Segue a estrutura daMessageHeader<\/code> padr\u00e3o, explicada nos fundamentos da API de terminais<\/a>, que incluem:<\/p>\n- \n
ProtocolVersion<\/code>: 3.0<\/strong><\/li>\nMessageClass<\/code>: Service<\/strong><\/li>\nMessageCategory<\/code>: EnableService<\/strong><\/li>\nMessageType<\/code>: Request<\/strong><\/li>\nSaleID<\/code>: Seu ID exclusivo para a caixa registradora.<\/li>\nServiceID<\/code>: Seu ID exclusivo para esta tentativa de transa\u00e7\u00e3o, consistindo em 1 a 10 caracteres alfanum\u00e9ricos. Esse valor precisa ser exclusivo nas \u00faltimas 48 horas.<\/li>\n- \n
POIID<\/code>: ID exclusivo do terminal. Isso indica para qual terminal o pedido ser\u00e1 roteado.<\/p>\n\n<\/li>\n<\/ul>\n<\/li>\n- \n
EnableServiceRequest<\/a>:<\/p>\n
- \n
TransactionAction<\/code>: AbortTransaction<\/strong>. Isso cancela a transa\u00e7\u00e3o atual.<\/li>\n- \n
DisplayOutput<\/code>: Objeto opcional para exibir uma mensagem no terminal. \u00c9 o mesmo que o objetoDisplayOutput<\/code> em uma solicita\u00e7\u00e3o de exibi\u00e7\u00e3o<\/a>.<\/p>\n\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n<\/code-sample>\n<\/div>\n Se a aquisi\u00e7\u00e3o do cart\u00e3o for cancelada com sucesso, voc\u00ea receber\u00e1 uma
EnableServiceResponse<\/code> que cont\u00e9m:<\/p>\n- \n
- \n
Response.Result<\/code>: Success<\/strong><\/p>\n\n<\/li>\n<\/ul>\n<\/li>\n- \n
Continue conforme aplic\u00e1vel, por exemplo, com uma nova solicita\u00e7\u00e3o de aquisi\u00e7\u00e3o de cart\u00e3o ou uma solicita\u00e7\u00e3o de pagamento.<\/p>\n<\/li>\n<\/ol>\n
Pr\u00f3ximos passos<\/h2>\n
- \n
- \n
- \n
- \n
- \n
- \n
- \n
- Em sua Customer Area<\/a>, v\u00e1 para Developers<\/strong> > Additional data<\/strong>, selecione os dados necess\u00e1rios para o seu caso de uso. Por exemplo, detalhes recorrentes para reconhecimento do cliente. A API de terminais retorna esses dados no
- O terminal mostra o valor a ser pago e o pagamento \u00e9 conclu\u00eddo.\n
- O terminal de pagamento solicita que o cliente apresente seu cart\u00e3o.\n
![\"\"](\"https:\/\/docs.adyen.com\/user\/pages\/docs\/03.point-of-sale\/33.card-acquisition\/2nd-tap.png\")
","card-acq-payment-response.json":"