Manual do Desenvolvedor Interface Padrão e Interface Personalizada Maio de 2013 Versão 1.5
ÍNDICE PÁGINA 1. Captura de Cartões pela Interface Personalizada... 1 1.1. Elementos da Solicitação de Configuração de Sessão... 1 1.2. Elementos da Resposta de Configuração de Sessão... 5 1.3. Elementos da Solicitação de Consulta... 6 1.4. Elementos da Resposta de Consulta... 7 1.5. Elementos das Autorizações de Cartão de Banco utilizando dados da Interface Personalizada... 11 2. Captura de Cartões pela Interface Padrão... 14 2.1 Elementos de uma Solicitação de Configuração de Sessão... 14 2.2 Elementos de uma Resposta de Configuração de Sessão... 17 2.3 Elementos da Solicitação de Consulta... 19 2.4 Elementos da Resposta de Consulta... 21 3 Suporte a Múltiplos Métodos de Pagamentos... 24 4 Códigos de Resposta das Transações de Pagamentos Hospedados... 25
1. Captura de Cartões pela Interface Personalizada A Interface Personalizada permite que o e-commerce Redecard capture dados sensíveis do titular do cartão em nome dos estabelecimentos comerciais e processe transações utilizando esses dados. Já que os estabelecimentos comerciais não capturam e armazenam os dados dos titulares de cartão diretamente, esse serviço simplifica seus requisitos de conformidade com os Padrões de Segurança de Segurança de Dados da Indústria de Cartões de Pagamento (PCI DSS). 1.1. Elementos da Solicitação de Configuração de Sessão Nesta seção, são apresentados os campos obrigatórios para o tipo de transação de configuração de sessão, bem como um exemplo de XML desses campos. Aqui, também são exibidas as principais seções das mensagens de configuração. Request o Authentication - Consulte o Guia de Referência dos Desenvolvedores do e- Commerce Redecard, Seção 2.1.1.1.1 o Transaction TxnDetails Consulte o Guia de Referência dos Desenvolvedores do e- Commerce Redecard, Seção 2.2.1.3. Contém as informações de pagamento que serão exibidas ao cliente. HpsTxn Esta seção contém todos os detalhes específicos à solicitação de configuração de sessão da Intrerface Personalizada. 1.1.1. HpsTxn HpsTxn Request.Transaction Elementos de HPS Txn Elemento Descrição Valores / Limitações Obrigatório method A ação que está sendo solicitada. Deve ter o valor "setup" S page_set_id Um número de ID que significa o page set que deve ser utilizado ao apresentar a tela de captura de dados ao titular do cartão. O valor inteiro de um page set que já tenha sido configurado. S return_url Uma URL do website do estabelecimento comercial. Se esse valor for fornecido, quando o processo de captura de dados for concluído, o titular do cartão será redirecionado a essa URL, em vez da URL padrão configurada na Interface Personalizada. Tamanho máximo 2083. Deve ser totalmente qualificado. O
expiry_url Uma URL do website do estabelecimento comercial. Se esse valor for fornecido, ao tentar visitar uma sessão expirada, o titular do cartão será redirecionado a essa URL, em vez da URL padrão expirada configurada na Interface Personalizada. Tamanho máximo 2083. Deve ser totalmente qualificado. O 1.1.2. Exemplo de Solicitações de XML de Configuração de Sessão Exemplo de solicitação XML para configurar uma sessão, incluindo elementos XML opcionais <Request version= 2 > <Authentication> <password>********</password> <AcquirerCode> <rdcd_pv>123456789</rdcd_pv> </AcquirerCode> </Authentication> <Transaction> <TxnDetails> <merchantreference>mref-123456</merchantreference> <amount currency="brl">100.00</amount> </TxnDetails> <HpsTxn> <method>setup</method> <page_set_id>1</page_set_id> <return_url>https://shop.example.com/process</return_url> <expiry_url>https://shop.example.com/expired</expiry_url> </HpsTxn> </Transaction> </Request> 1.1.3. DynamicData DynamicData Request.Transaction.HpsTxn Este elemento opcional contém valores que podem ser utilizados para substituir os valores marcadores de posição da página de captura de cartão. Elementos de DynamicData Elemento Descrição Valores / Limitações Obrigatório dyn_data_1 O valor destinado a substituir o Comprimento máximo: 2.048 O
marcador de posição DYNAMIC_DATA_FIELD_1 na página de captura de cartão. caracteres. O valor deve ser inserido entre tags CDATA se contiver HTML. dyn_data_2 O valor destinado a substituir o marcador de posição DYNAMIC_DATA_FIELD_2 na página de captura de cartão. Comprimento máximo: 2.048 caracteres. O valor deve ser inserido entre tags CDATA se contiver HTML. O dyn_data_3 O valor destinado a substituir o marcador de posição DYNAMIC_DATA_FIELD_3 na página de captura de cartão. Comprimento máximo: 2.048 caracteres. O valor deve ser inserido entre tags CDATA se contiver HTML. O dyn_data_4 O valor destinado a substituir o marcador de posição DYNAMIC_DATA_FIELD_4 na página de captura de cartão. Comprimento máximo: 2.048 caracteres. O valor deve ser inserido entre tags CDATA se contiver HTML. O dyn_data_5 O valor destinado a substituir o marcador de posição DYNAMIC_DATA_FIELD_5 na página de captura de cartão. Comprimento máximo: 2.048 caracteres. O valor deve ser inserido entre tags CDATA se contiver HTML. O dyn_data_6 O valor destinado a substituir o marcador de posição DYNAMIC_DATA_FIELD_6 na página de captura de cartão. Comprimento máximo: 2.048 caracteres. O valor deve ser inserido entre tags CDATA se contiver HTML. O dyn_data_7 O valor destinado a substituir o marcador de posição DYNAMIC_DATA_FIELD_7 na página de captura de cartão. Comprimento máximo: 2.048 caracteres. O valor deve ser inserido entre tags CDATA se contiver HTML. O dyn_data_8 O valor destinado a substituir o marcador de posição DYNAMIC_DATA_FIELD_8 na página de captura de cartão. Comprimento máximo: 2.048 caracteres. O valor deve ser inserido entre tags CDATA se contiver HTML. O dyn_data_9 O valor destinado a substituir o marcador de posição DYNAMIC_DATA_FIELD_9 na página de captura de cartão. Comprimento máximo: 2.048 caracteres. O valor deve ser inserido entre tags CDATA se contiver HTML. O É permitido inserir até nove valores. Se um valor de marcador de posição estiver vazio ou ausente, o marcador de posição será removido da página de captura de cartão visualizada pelo titular do cartão. Para que o HTML possa ser utilizado nos valores marcadores de posição, o conteúdo do elemento dyn_data deve ser inserido entre tags CDATA. Exemplo de HTML inserido entre tags CDATA <![CDATA[some <b>html</b> data]]>
1.1.4. Exemplo de Solicitação de Configuração de Sessão com Dados Dinâmicos Exemplo de solicitação XML para configurar uma sessão, incluindo DynamicData <Request version= 2 > <Authentication> <password>********</password> <AcquirerCode> <rdcd_pv>123456789</rdcd_pv> </AcquirerCode> </Authentication> <Transaction> <TxnDetails> <merchantreference>mref-123456</merchantreference> <amount currency="brl">100.00</amount> </TxnDetails> <HpsTxn> <method>setup</method> <page_set_id>1</page_set_id> <return_url>https://shop.example.com/process</rreturn_url> <expiry_url>https://shop.example.com/expired</expiry_url> <DynamicData> <dyn_data_1> <![CDATA[some <b>dynamic</b> data]]> </dyn_data_1> <dyn_data_2> <![CDATA[more dynamic data]]> </dyn_data_2> </DynamicData> </HpsTxn> </Transaction> </Request>
1.2. Elementos da Resposta de Configuração de Sessão Os elementos de resposta XML padrão sempre são exibidos. Consulte o Guia de Referência dos Desenvolvedores do e-commerceredecard, Seção 2.2.3. Além disso, os elementos a seguir específicos a Interface Personalizada serão exibidos como resposta a uma solicitação bem-sucedida de configuração de sessão. Uma configuração bem-sucedida é indicada pela exibição de um código de status 1. Qualquer outro código indica uma solicitação rejeitada ou um erro. HpsTxn Response Elementos de HPSTxn Elemento hps_url session_id Descrição A URL do HPS. Deve ser inclusa pelo estabelecimento comercial. Um valor único que corresponde à sessão que foi configurada na Interface Personalizada. Os elementos hps_url e session_id devem ser utilizados pelo estabelecimento comercial para redirecionar o titular do cartão à página hospedada. 1.2.1. Exemplo de Respostas XML de Configuração de Sessão O exemplo de mensagem XML a seguir será exibido como resposta a uma solicitação bem-sucedida de configuração de sessão. Exemplo de resposta XML a uma configuração de sessão bem-sucedida <Response version= 2 > <HpsTxn> <hps_url>https://dpg.example.com/hps/</hps_url> <session_id>1172</session_id> </HpsTxn> <gateway_reference>4000900012345671</gateway_reference> <merchantreference>mref-123456</merchantreference> <mode>test</mode> <reason>accepted</reason> <status>1</status> <time>1258553216</time> </Response> O XML a seguir demonstra uma resposta a uma solicitação de configuração não realizada com êxito. Exemplo de resposta XML a uma configuração de sessão não realizada com êxito <Response version= 2 > <gateway_reference>4000900012345671</gateway_reference> <information>new_session is not a valid HPS method</information>
<merchantreference>mref-123456</merchantreference> <mode>test</mode> <reason>invalid transaction type</reason> <status>15</status> <time>1256046381</time> </Response> 1.3. Elementos da Solicitação de Consulta Depois que um titular de cartão for redirecionado ao seu website após o processo de captura de dados, é possível enviar uma transação de consulta de modo opcional. Isso permitirá determinar se a captura de dados foi bem-sucedida, sem o envio de uma autorização. Além disso, essa operação permitirá a obtenção de informações sobre os detalhes do cartão que foram fornecidos. 1.3.1. Elementos da Solicitação de Consulta Request o Authentication Consultar a Seção 2.1.1.1.1 do Guia de Referência dos Desenvolvedores do e-commerce Redecard o Transaction HistoricTxn Consulte a Seção 1.3.2 1.3.2. HistoricTxn HistoricTxn Request.Transaction Elemento Descrição Elementos de HistoricTxn Valores / Limitações method O tipo de transação. query S reference O elemento gateway_reference da solicitação de configuração de sessão da Interface Personalizada. S Exemplo de Fragmento de Solicitação XML dos elementos complexos de HistoricTxn <HistoricTxn> <reference>3900900100010001</reference> <method>query</method> </HistoricTxn>
1.3.3. Exemplo de Consulta de Configuração de Sessão XML da Interface Personalizada Exemplo de Consulta de Configuração de Sessão XML <Request version= 2 > <Authentication> <password>********</password> <AcquirerCode> <rdcd_pv>123456789</rdcd_pv> </AcquirerCode> </Authentication> <Transaction> <HistoricTxn> <method>query</method> <reference>3900900100010001</reference> </HistoricTxn> </Transaction> </Request> 1.4. Elementos da Resposta de Consulta Os elementos de resposta XML padrão sempre são exibidos. Consulte o Guia de Referência dos Desenvolvedores do e-commerce Redecard, Seção 2.2.3. Observe que, para as transações de consulta, se o status exibido for 1, isso indica que a consulta foi realizada com êxito. Isso não indica que a transação consultada foi bemsucedida. Ao consultar uma solicitação de configuração de sessão da Ingterface Padrão, o conteúdo do elemento "information" da resposta indica o status da transação consultada. Ela pode ter um dos valores literais a seguir: Mensagem de Resposta You have queried an HPS transaction, which has stored data that has not yet been used You have queried an HPS transaction, whose processing failed You have queried an HPS transaction, whose data capture is pending You have queried an HPS transaction, whose data was not used and has been deleted You have queried an HPS transaction, whose data has been used and subsequently deleted Significado O pagamento pode ser efetuado utilizando os dados armazenados. Prossiga à próxima etapa do processo de transações. Não foi possível capturar os dados. Neste caso, o elemento de status da resposta de consulta conterá o status de código da falha. O titular do cartão ainda não concluiu o processo de captura. Os dados capturados nesta sessão não foram utilizados em um pagamento antes de seu vencimento e foram excluídos. Para recapturar as informações de pagamento, envie uma nova solicitação de configuração. Os dados capturados nesta sessão já foram utilizados em um pagamento. A autorização foi realizada e os dados sensíveis do cartão foram excluídos.
Quando o primeiro valor desta lista é exibido, o código de status será o mesmo que o código de falha original. O terceiro valor desta lista indica que a captura de dados foi realizada com êxito e que é possível prosseguir à transação de autorização. Neste caso, a resposta da consulta também conterá os dados a seguir. 1.4.1. HpsTxn HpsTxn Response Elementos de HpsTxn Elemento card_scheme country expirydate issuer pan cv2_captured capture_status Descrição A Bandeira do cartão, por exemplo, "MasterCard" O país do cartão de emissão, por exemplo, BRL" A data de vencimento do cartão em formato MMAA O emissor do cartão, por exemplo, "Mybank PL" Uma versão mascarada do número do cartão que exibe somente os seis primeiros e últimos quatro dígitos. O restante dos dígitos é substituído por asteriscos. Determina se um valor de CV2 foi capturado durante o processo da transação do HCC. O status atual da transação do HCC no momento da consulta, por exemplo, "pending (pendente), "populated (inserida) Valores / Limitações Yes/No Pending; Populated; Purged_used; Purged_unused 1.4.2. Exemplo da Resposta de Consulta XML Exemplo da Resposta de Consulta XML de uma Captura de Dados realizada com êxito <Response version= 2 > <HpsTxn> <card_scheme>mastercard</card_scheme> <country>brl</country> <expirydate>1214</expirydate> <issuer>mybank PL</issuer> <pan>544433******1111</pan> <capture_status>populated</capture_status> <cv2_captured>no</cv2_captured> </HpsTxn> <gateway_reference>4000900012345671</gateway_reference> <information>you have queried an HPS transaction, which has stored data that has not yet been used</information> <merchantreference>mref123401</merchantreference> <mode>test</mode> <reason>accepted</reason>
<status>1</status> <time>1256046399</time> </Response> Exemplo da Resposta de Consulta XML de uma Captura de Dados Pendente <Response version= 2 > <HpsTxn> <capture_status>pending</capture_status> </HpsTxn> <gateway_reference>4000900012345671</gateway_reference> <information>you have queried an HPS transaction, whose data capture is pending</information> <merchantreference>mref123401</merchantreference> <mode>test</mode> <reason>accepted</reason> <status>1</status> <time>1256046399</time> </Response> 1.4.3. DynamicCapture Observe também que este elemento somente é exibido em uma resposta de consulta se houve captura de dados. DynamicCapture Response.HpsTxn Elemento Descrição Elementos de DynamicCapture Valores / Limitações capf1 Campo 1 dinamicamente capturado, se inserido. 32 caracteres (máx.) URL codificada (exceto espaços) capf2 Campo 2 dinamicamente capturado, se inserido. 32 caracteres (máx.) URL codificada (exceto espaços) capf3 Campo 3 dinamicamente capturado, se inserido. 32 caracteres (máx.) URL codificada (exceto espaços) capf4 Campo 4 dinamicamente capturado, se inserido. 32 caracteres (máx.) URL codificada (exceto espaços) capf5 Campo 5 dinamicamente capturado, se inserido. 32 caracteres (máx.) URL codificada (exceto espaços)
capf6 Campo 6 dinamicamente capturado, se inserido. 32 caracteres (máx.) URL codificada (exceto espaços) capf7 Campo 7 dinamicamente capturado, se inserido. 32 caracteres (máx.) URL codificada (exceto espaços) capf8 Campo 8 dinamicamente capturado, se inserido. 32 caracteres (máx.) URL codificada (exceto espaços) capf9 Campo 9 dinamicamente capturado, se inserido. 32 caracteres (máx.) URL codificada (exceto espaços) 1.4.4. Exemplo de Resposta de Consulta XML com Captura de Dados Dinâmicos Exemplo da Resposta de Consulta XML de uma Captura de Dados realizada com êxito <Response version= 2 > <HpsTxn> <card_scheme>mastercard</card_scheme> <country>brl</country> <expirydate>1214</expirydate> <issuer>mybank PL</issuer> <pan>544433******1111</pan> <DynamicCapture> <capf1>a. N. Other</capf1> <capf3>%3cid%3ecat%3c%2fid%3e</capf3> <capf6>cat</capf6> <capf9>87</capf9> </DynamicCapture> </HpsTxn> <gateway_reference>4000900012345671</gateway_reference> <information>you have queried an HPS transaction, which has stored data that has not yet been used</information> <merchantreference>mref123401</merchantreference> <mode>test</mode> <reason>accepted</reason> <status>1</status> <time>1256046399</time> </Response>
1.5. Elementos das Autorizações de Cartão de Banco utilizando dados da Interface Personalizada Assim que os dados de um titular de cartão forem capturados com a Interface Personalizada, uma transação de cartão pode ser enviada. Esta transação faz referência à configuração de sessão da Interface Personalizada, em vez de fornecer dados do cartão. Para obter informações sobre como realizar uma solicitação desse tipo, consulte o Guia de Referência dos Desenvolvedores do e-commerce Redecard, Seção 2.2. Neste caso, em vez de fornecer o elemento complexo do Cartão, devem ser fornecidos os elementos e atributos a seguir. Nenhum deles pode ser omitido. cardtxn Request.Transaction.CardTxn Elemento Descrição Elementos de CardTxn Valores / Limitações card_details Especifica o elemento gateway_reference de uma configuração de sessão bem-sucedida da Interface Personalizada. O elemento gateway_reference fornecido durante a resposta de configuração deve ter 16 dígitos. Atributo type Atributo do Elemento card_details Atributos dos Elementos de CardTxn Valores / Limitações Especifica a natureza do elemento gateway_reference fornecido. Para uma transação da Interface Personalizada, ele deve ter o valor "from_hps". Observe também que o elemento a seguir é opcional para uma transação que utiliza dados capturados por meio da Interface Personalizada. Se ele for omitido, o valor da solicitação de configuração de sessão é utilizado em seu lugar. Consulte o Guia de Referência dos Desenvolvedores do e-commerce Redecard, Seção 2.2.1.3. merchant_reference Request.TxnDetails
1.5.1. Transação de Cartão com Dados da Interface Personalizada - Exemplos XML Exemplo de Transação de Cartão XML com Utilização de Dados Capturados <Request version= 2 > <Authentication> <password>********</password> <AcquirerCode> <rdcd_pv>123456789</rdcd_pv> </AcquirerCode> </Authentication> <Transaction> <TxnDetails> <merchantreference>mref123501</merchantreference> <amount currency= BRL >1000.00</amount> <capturemethod>ecomm</capturemethod> </TxnDetails> <CardTxn> <Card> <card_account_type>credit</card_account_type> </Card> <method>auth</method> <card_details type="from_hps">4000900012345671</card_details> </CardTxn> </Transaction> </Request> 1.5.2. Exemplo de uma Resposta XML a uma Transação de Cartão que utiliza Dados da Interface Personalizada Exemplo de uma Resposta XML a uma Transação de Cartão que utiliza Dados da Interface Personalizada <Response version='2'> <CardTxn> <Cv2Avs> <cv2avs_status>security CODE MATCH ONLY</cv2avs_status> <policy>0</policy> </Cv2Avs> <authcode>794408</authcode> <card_scheme>mastercard</card_scheme> <country>brazil</country> <issuer>credicard, S.A.</issuer> <token>cfa8dea66bd78daf4345b50557c226b2b2ed2ac9</token> </CardTxn> <acquirer>redecard</acquirer> <auth_host_reference>2000569</auth_host_reference> <gateway_reference>3100900010001096</gateway_reference> <merchantreference>mref123563</merchantreference> <mid>012341088</mid> <mode>live</mode>
<reason>accepted</reason> <status>1</status> <time>1363615231</time> </Response>
2. Captura de Cartões pela Interface Padrão A Interface Padrão permite que o e-commerceredecard capture dados sensíveis do titular do cartão e autorize pagamentos em nome dos estabelecimentos comerciais. Ao contrário da Interface Personalizada, o estabelecimento comercial não precisa enviar solicitações subsequentes para autorizar o pagamento. Esta configuração de sessão contém os valores modelo utilizados pela Interface Padrão para processar a escolha de pagamento feita pelo titular do cartão na página de captura de cartão da Interface Padrão. 2.1 Elementos de uma Solicitação de Configuração de Sessão Nesta seção, são apresentados os campos obrigatórios para o tipo de transação de configuração de sessão, bem como um exemplo de XML desses campos. Aqui, também são exibidas as principais seções das mensagens de configuração. Request o Authentication Consulte a Seção 2.1.1.1.1 do Guia de Referência dos Desenvolvedores do e-commerce Redecard o Transaction TxnDetails Consulte o Guia de Referência dos Desenvolvedores do e- Commerce Redecard, Seção 2.2.1.3. Contém as informações de pagamento que serão exibidas ao cliente. ThreeDSecure Consulte o Anexo 1-3-D Secure, Seção 1.1.1. do Guia de Referência dos Desenvolvedores do e-commerce Redecard. Ele contém os detalhes necessários para iniciar a verificação do 3-D Secure. CardTxn Consulte a Seção 2.2.1.2 do Guia de Referência dos Desenvolvedores do e-commerce Redecard. Ela contém o tipo de transação de cartão e outras informações que serão usadas se o cliente tentar efetuar o pagamento com cartão. Card Consulte a Seção 2.2.1.1. do Guia de Referência dos Desenvolvedores do e-commerce Redecard. Nesta Configuração de Sessão da Interface Padrão, este elemento é utilizado somente para o elemento Cv2Avs. o Cv2Avs Consulte a Seção 2.3.1.1. do Guia de Referência dos Desenvolvedores do e-commerce Redecard. Ela contém detalhes sobre cv2 e endereços. HpsTxn Esta seção contém todos os detalhes específicos à solicitação de configuração de sessão do HPS. 2.1.1 TxnDetails Todos os elementos e atributos a seguir são obrigatórios em uma solicitação de configuração de sessão do HPS. TxnDetails Request.Transaction
Elementos de TxnDetails Elemento Descrição Valores / Limitações capturemethod merchantreference amount Meio de captura da transação Um número de referência único para cada transação. O valor da transação. ecomm Mínimo de 6 e máximo de 30 caracteres alfanuméricos. Deve ser único. Atributos dos Elementos de TxnDetails Atributo currency Atributo do Elemento amount Valores / Limitações A moeda é transmitida em formato alfabético ISO 4217 de três caracteres (o padrão é GBP) por exemplo, BRL. 2.1.2 ThreeDSecure ThreeDSecure Request.Transaction.TxnDetails Este elemento é especificado no Guia de Referência dos Desenvolvedores do e- Commerce Redecard, Anexo 1: 3-D Secure, Seção 1.1.1. Não há restrições adicionais. 2.1.3 CardTxn CardTxn Request.Transaction Elementos de CardTxn Elemento Descrição Valores / Limitações Obrigatório method O tipo de transação Só pode ter os valores "auth" ou "pre" S Este elemento é obrigatório. 2.1.4 Card Card Request.Transaction.CardTxn Em uma Configuração de Sessão Completa da Interface Padrão, este elemento pode conter somente o elemento Cv2Avs. Não é permitido inserir outros elementos.
2.1.5 Cv2Avs Cv2Avs Request.Transaction.CardTxn.Card.Cv2Avs Este elemento é especificado no Guia de Referência dos Desenvolvedores do e- Commerce Redecard, Seção 2.3.1.1. Não há restrições adicionais. 2.1.6 HpsTxn HpsTxn Request.Transaction Elementos de HpsTxn Elemento Descrição Valores / Limitações Obrigatório method A ação que está sendo solicitada. Deve ter o valor setup_full S page_set_id Um número de ID que significa o page set que deve ser utilizado ao apresentar a tela de captura de dados ao titular do cartão. O valor inteiro de um page set que já tenha sido configurado. S return_url Uma URL do website do estabelecimento comercial. Se esse valor for fornecido, quando o processo de captura de dados for concluído, o titular do cartão será redirecionado a essa URL, em vez da URL padrão configurada na Interface Padrão. Tamanho máximo 2083. Deve ser totalmente qualificado. O expiry_url Uma URL do website do estabelecimento comercial. Se esse valor for fornecido, ao tentar visitar uma sessão expirada, o titular do cartão será redirecionado a essa URL, em vez da URL padrão expirada configurada na Interface Padrão. Tamanho máximo 2083. Deve ser totalmente qualificado. O 2.1.7 Exemplo de Solicitações de XML de Configuração de Sessão Exemplo de solicitação XML para configurar uma sessão, incluindo elementos XML opcionais <Request version= 2 > <Authentication> <password>********</password> <AcquirerCode> <rdcd_pv>123456789</rdcd_pv>
</AcquirerCode> </Authentication> <Transaction> <TxnDetails> <merchantreference>mref-123456</merchantreference> <amount currency="brl">100.00</amount> <capturemethod>ecomm</capturemethod> <ThreeDSecure> <verify> yes </verify> <merchant_url> https://www.example-merchant.com.au </merchant_url> <purchase_datetime> 20120121 09:31:40 </purchase_datetime> <purchase_desc> goods </purchase_desc> <Browser> <device_category> 0 </device_category> <accept_headers> *.* </accept_headers> <user_agent> Mozilla </user_agent> </Browser> </ThreeDSecure> </TxnDetails> <CardTxn> <method>pre</method> <Card> <Cv2Avs> <cpf> </cpf> <postcode>...</postcode> <street_address1>...</street_address1> <street_address2>...</street_address2> <street_address3>...</street_address3> <street_address4>...</street_address4> <policy>3</policy> </Cv2Avs> </Card> </CardTxn> <HpsTxn> <method>setup_full</method> <page_set_id>1</page_set_id> <return_url>https://shop.example.com/process</return_url> </HpsTxn> </Transaction> </Request> 2.2 Elementos de uma Resposta de Configuração de Sessão Os elementos de resposta XML padrão sempre são exibidos. Consulte o Guia de Referência dos Desenvolvedores do e-commerce Redecard, Seção 2.2.3. Além disso, os elementos a seguir específicos a Interface Padrão serão exibidos como resposta a uma solicitação bem-sucedida de configuração de sessão. Uma configuração bem-sucedida é indicada pela exibição de um código de status 1. Qualquer outro código indica uma solicitação rejeitada ou um erro.
HpsTxn Response Elementos de HpsTxn Elemento hps_url session_id Descrição A URL da Interface Padrão. Um valor único que corresponde à sessão que foi configurada no HPS. Os elementos hps_url e session_id devem ser utilizados pelo estabelecimento comercial para redirecionar o titular do cartão à página hospedada. 2.2.1 Exemplo de Respostas XML de Configuração de Sessão O exemplo de mensagem XML a seguir será exibido como resposta a uma solicitação bem-sucedida de configuração de sessão. Exemplo de resposta XML a uma configuração de sessão bem-sucedida <Response version= 2 > <HpsTxn> <hps_url>https://dev.example.com/hps/</hps_url> <session_id>1172</session_id> </HpsTxn> <gateway_reference>4000900012345671</gateway_reference> <merchantreference>mref-123456</merchantreference> <mode>test</mode> <reason>accepted</reason> <status>1</status> <time>1258553216</time> </Response> O XML a seguir demonstra uma resposta a uma solicitação de configuração não realizada com êxito. Exemplo de resposta XML a uma configuração de sessão não realizada com êxito <Response version= 2 > <gateway_reference>4000900012345671</gateway_reference> <information>new_session is not a valid HPS method</information> <merchantreference>mref-123456</merchantreference> <mode>test</mode> <reason>invalid transaction type</reason> <status>15</status> <time>1256046381</time> </Response>
2.3 Elementos da Solicitação de Consulta A qualquer momento após uma configuração de sessão bem-sucedida, uma consulta pode ser enviada para determinar o estado atual da transação. Essa consulta pode ser utilizada para determinar qual etapa do processo de pagamento foi atingida pelo titular do cartão e se uma tentativa de pagamento foi realizada com êxito. 2.3.1 Elementos esquemáticos da Solicitação de Consulta Request o Authentication Consulte a Seção 2.1.1.1.1 do Guia de Referência dos Desenvolvedores do e-commercde Redecard o Transaction HistoricTxn Consulte a Seção 2.2.1.4 do Guia de Referência dos Desenvolvedores do e-commerce Redecard 2.3.2 HistoricTxn HistoricTxn Request.Transaction Elementos de HistoricTxn Elemento Descrição Valores / Limitações method O tipo de transação. query S reference O elemento gateway_reference da solicitação de configuração de sessão da Interface Padrão. S Exemplo de Fragmento de Solicitação XML dos elementos complexos de HistoricTxn <HistoricTxn> <reference>3900900100010001</reference> <method>query</method> </HistoricTxn> 2.3.3 Exemplo de Consulta de Configuração de Sessão XML da Interface Padrão Exemplo de Consulta de Configuração de Sessão XML <Request version= 2 > <Authentication> <password>********</password> <AcquirerCode> <rdcd_pv>123456789</rdcd_pv> </AcquirerCode> </Authentication>
<Transaction> <HistoricTxn> <method>query</method> <reference>3900900100010001</reference> </HistoricTxn> </Transaction> </Request>
2.4 Elementos da Resposta de Consulta Os elementos de resposta XML padrão sempre são exibidos. Consulte o Guia de Referência dos Desenvolvedores do e-commerce Redecard, Seção 2.2.3. Observe que, para as transações de consulta, se o status exibido for 1, isso indica que a consulta foi realizada com êxito. Isso não indica que a transação consultada foi bem-sucedida. Ao consultar uma solicitação de configuração de sessão da Interface Padrão, o conteúdo do elemento "information" da resposta indica o status da transação consultada. Consulte a seção 4 para obter uma lista de possíveis códigos de resposta específicos da Interface Padrão. 2.4.1 AuthAttempts Este elemento contém uma lista das tentativas de pagamento realizadas durante a sessão. Ele somente será exibido se o cliente realizou, no mínimo, uma tentativa de pagamento. AuthAttempts Response.HpsTxn 2.4.2 Attempt Este elemento fornece detalhes sobre uma tentativa de pagamento realizada durante a sessão. Attempt Response.HpsTxn.AuthAttempts Elementos de Attempt Elemento Descrição Valores / Limitações gateway_reference reason dc_response O elemento gateway_reference da tentativa de autorização do pagamento. O motivo do resultado da tentativa. O código de status da tentativa de autenticação. 2.4.3 Exemplo da Resposta de Consulta XML Exemplo da Resposta de Consulta XML de um pagamento efetuado após 2 tentativas de pagamento não realizadas com êxito: <Response version= 2 > <HpsTxn> <session_id>1172</session_id> <gateway_reference>4000900012345674</gateway_reference> <AuthAttempts>
<Attempt> <gateway_reference>4000900012345672</gateway_reference> <reason>declined</reason> <status>7</status> </Attempt> <Attempt> <gateway_reference>4000900012345673</gateway_reference> <reason>declined</reason> <status>7</status> </Attempt> <Attempt> <gateway_reference>4000900012345674</gateway_reference> <reason>accepted</reason> <status>1</status> </Attempt> </AuthAttempts> </HpsTxn> <gateway_reference>4000900012345671</gateway_reference> <merchantreference>mref-123456</merchantreference> <mode>test</mode> <reason>accepted</reason> <status>1</status> <time>_unix_time_</time> </Response>
2.4.4 Exemplo da Resposta de Consulta XML Exemplo da Resposta de Consulta XML após falha de todas as tentativas de pagamento: <Response version= 2 > <HpsTxn> <session_id>1172</session_id> <AuthAttempts> <Attempt> <gateway_reference>4000900012345672</gateway_reference> <reason>declined</reason> <status>7</status> </Attempt> <Attempt> <gateway_reference>4000900012345673</gateway_reference> <reason>declined</reason> <status>7</status> </Attempt> <Attempt> <gateway_reference>4000900012345674</gateway_reference> <reason>declined</reason> <status>7</status> </Attempt> </AuthAttempts> </HpsTxn> <gateway_reference>4000900012345671</gateway_reference> <information>you have queried an HPS transaction, where the all retry attempts were exhausted.</information> <merchantreference>mref-123456</merchantreference> <mode>test</mode> <reason>hps: The maximum number of retry transaction was breached</reason> <status>822</status> <time>_unix_time_</time> </Response> 2.4.5 Consulta de uma Tentativa de Pagamento Os detalhes de uma tentativa de pagamento podem ser obtidos consultando o elemento gateway_reference que é exibido como um elemento secundário do elemento Attempt. Para as consultas de tentativas de pagamento dos cartões de banco, as respostas são exibidas conforme a Seção 2.4 do Guia de Referência dos Desenvolvedores do e- Commerce Redecard.
3 Suporte a Múltiplos Métodos de Pagamentos Ao usar as interfaces Padrão e Personalizada, múltiplas páginas de captura/pagamentos podem ser configuradas para sua conta. Várias páginas de captura/pagamentos podem ser necessárias para suportar múltiplos métodos de pagamento (cartões bancários vs. métodos alternativos de pagamento). Se você deseja alterar uma página existente ou adicionar novas páginas, por favor contate o time de suporte do e-commerce Redecard. O time de suporte poderá informá-los sobre o ID da página a suportar a configuração de cada método de pagamento para sua conta.
4 Códigos de Resposta das Transações de Pagamentos Hospedados A seguir, é apresentada uma tabela com os códigos de resposta específicos às transações de Pagamentos Hospedados. Para obter uma lista dos Códigos de Resposta gerais, consulte o Guia de Referência dos Desenvolvedores do e-commerce Redecard. Caso seja recebido um código de resposta que não esteja detalhado na tabela a seguir, entre em contato com sua Equipe de Suporte do Portal para obter mais detalhes. Código Código de Retorno Geral Descrição 810 HPS: Inappropriate data supplied Foram encontradas informações que não se aplicam a esse tipo de solicitação 811 HPS: Missing data A solicitação enviada não contém dados obrigatórios 812 HPS: Invalid reference A referência ornecida não é válida 813 HPS: Communications error Houve um problema ao enviar uma solicitação ou ao receber uma resposta 814 HPS: Invalid HPS response Resposta válida 815 HPS: Invalid payment reference A referência fornecida não pode ser utilizada para efetuar um pagamento 816 HPS: Merchant not configured Estabelecimento não configurado 817 HPS: Capture field data too long Os dados especificados no campo de captura dinâmica são muito longos 818 HPS: Dynamic Data Field too long 820 HPS: Awaiting customer card details. 821 HPS: At least one auth attempted. Aguardando detalhes do pagamento 822 HPS: The maximum number of retry transaction was breached. 823 HPS: The merchants customer did not complete within the session timeout. 824 HPS: Payment in flight. Awaiting customer ACS submission. 825 HPS: Merchant not configured for full-hps 826 HPS: The transaction has already been marked as final. 827 HPS: Invalid capturemethod. 828 HPS: Awaiting authorization. O valor do campo Dynamic Data é muito longo Aguardando detalhes do pagamento
829 HPS: Invalid payment method for Full HPS txns.