Manual do Checkout 2.0

Transcrição

1 Manual do Checkout 2.0

2 SUMÁRIO API CHECKOUT URL s para requisições... 3 Criação de Ordem de Pagamento... 4 Retorno da Requisição para Criação da Ordem de Pagamento com sucesso... 7 Retorno da Requisição para Criação da Ordem de Pagamento com erro... 7 Editando uma Ordem de Pagamento... 8 Retorno da Requisição para Edição da Ordem de Pagamento com sucesso... 9 Retorno da Requisição para Edição da Ordem de Pagamento com erro... 9 Cancelando uma Ordem de Pagamento Retorno da Requisição para Cancelamento da Ordem de Pagamento com sucesso Retorno da Requisição para Cancelamento da Ordem de Pagamento com erro Consultando uma Ordem de Pagamento Retorno da Requisição para consulta da Ordem de Pagamento Tabela de parâmetros para envio da requisição Tabela de parâmetros de retornos Suporte maxipago! Smart Payments

3 API CHECKOUT 2.0 Com a API Checkout 2.0 integrada em seu sistema, será possível: criar, editar, cancelar e consultar uma Ordem de Pagamento. URL s para requisições Sandbox: Produção: maxipago! Smart Payments

4 Criação de Ordem de Pagamento Veja abaixo um exemplo de XML para a geração de uma ordem de pagamento. <?xml version="1.0" encoding="utf-8"?> <api-request> <verification> <merchantid>store-id</merchantid> <merchantkey>store-key</merchantkey> </verification> <command>add-payment-order</command> <request> <referencenum> </referencenum> <fraudcheck>y</fraudcheck> <billing> <address>avenida Paulista 123</address> <address2>1 Andar</address2> <city>sao Paulo</city> <state>sp</state> <postalcode> </postalcode> <country>br</country> < >teste.maxipay@mailinator.com</ > <customeridext> </customeridext> <firstname>teste</firstname> <lastname>maxipay</lastname> <dob>01/30/1984</dob> <sex>m</sex> <phone> </phone> </billing> <transactiondetail> <description>pagamento Parcela Do Carro</description> <comments>pagar ate dia 30</comments> < subject>favor efetuar o pagamento</ subject> <expirationdate>30/10/2017</expirationdate> <paytype> <creditcard> <processorid>1</processorid> <operation>sale</operation> <numberofinstallments>2</numberofinstallments> <currencycode>brl</currencycode> <amount>950.00</amount> </creditcard> </paytype> </transactiondetail> </request> </api-request> maxipago! Smart Payments

5 Criação de Ordem de Pagamento Recorrente: <?xml version="1.0" encoding="utf-8"?> <api-request> <verification> <merchantid>store-id</merchantid> <merchantkey>store-key</merchantkey> </verification> <command>add-payment-order</command> <request> <referencenum> </referencenum> <fraudcheck>y</fraudcheck> <billing> <address>avenida Paulista 123</address> <address2>1 Andar</address2> <city>sao Paulo</city> <state>sp</state> <postalcode> </postalcode> <country>br</country> <customeridext> </customeridext> <firstname>teste</firstname> <lastname>maxipay</lastname> <dob>01/30/1984</dob> <sex>m</sex> <phone> </phone> </billing> maxipago! Smart Payments

6 <transactiondetail> <description>pagamento Parcela Do Carro</description> <comments>pagar ate dia 30</comments> < subject>favor efetuar o pagamento</ subject> <expirationdate>30/10/2017</expirationdate> <paytype> <creditcard> <processorid>1</processorid> <operation>sale</operation> <numberofinstallments>2</numberofinstallments> <currencycode>brl</currencycode> <amount>950.00</amount> </creditcard> </paytype> </transactiondetail> <recurring> <startdate>31/10/2017</startdate> <period>monthly</period> <numberofinstallments>12</numberofinstallments> <failurethreshold>3</failurethreshold> <amount>950.00</amount> </recurring> </request> </api-request> Observação: o retorno de uma requisição de transação convencional e recorrência será o mesmo. maxipago! Smart Payments

7 Retorno da Requisição para Criação da Ordem de Pagamento com sucesso <?xml version="1.0" encoding="utf-8"?> <api-response> <errorcode>0</errorcode> <errormessage></errormessage> <command>add-payment-order</command> <time> </time> <result> <pay_order_id>fiaoeh3moe8=</pay_order_id> <message>inserted Successfully</message> </result> </api-response> Retorno da Requisição para Criação da Ordem de Pagamento com erro <?xml version="1.0" encoding="utf-8"?> <api-response> <errorcode>1</errorcode> <errormessage> <![CDATA[Unable to authenticate merchant]]> </errormessage> <time> </time> </api-response> maxipago! Smart Payments

8 Editando uma Ordem de Pagamento Para a editar uma ordem de pagamento será necessário informar o número da ordem retornada pela maxipago! no response de sua criação. O número da ordem de pagamento no response é retornado na tag <pay_order_id> e na tag <command> passar o comando update-payment-order. Veja abaixo a estrutura do XML que precisa ser enviado para a edição da ordem de pagamento. <?xml version="1.0" encoding="utf-8"?> <api-request> <verification> <merchantid>store-id</merchantid> <merchantkey>store-key</merchantkey> </verification> <command>update-payment-order</command> <request> <payorderid>fiaoeh3moe8=</payorderid> <referencenum> </referencenum> <fraudcheck>y</fraudcheck> <billing> < >teste.maxipay.1@mailinator.com</ > </billing> <transactiondetail> <description>pagamento Parcela Do Carro</description> <comments>pagar ate dia 30</comments> < subject>favor efetuar o pagamento</ subject> <expirationdate>30/10/2017</expirationdate> <paytype> <creditcard> <processorid>1</processorid> <operation>sale</operation> <numberofinstallments>2</numberofinstallments> <currencycode>brl</currencycode> <amount> </amount> </creditcard> </paytype> </transactiondetail> </request> </api-request> maxipago! Smart Payments

9 Retorno da Requisição para Edição da Ordem de Pagamento com sucesso <?xml version="1.0" encoding="utf-8"?> <api-response> <errorcode>0</errorcode> <errormessage></errormessage> <command>update-payment-order</command> <time> </time> <result> <pay_order_id>fiaoeh3moe8=</pay_order_id> <message>updated Successfully</message> </result> </api-response> Retorno da Requisição para Edição da Ordem de Pagamento com erro <?xml version="1.0" encoding="utf-8"?> <api-response> <errorcode>1</errorcode> <errormessage> <![CDATA[Pay order id not located: /GKUFSd9WdI not located.]]> </errormessage> <time> </time> </api-response> maxipago! Smart Payments

10 Cancelando uma Ordem de Pagamento Para o cancelamento da ordem de pagamento será necessário informar o número da ordem retornada pela maxipago! no response de sua criação. O número da ordem de pagamento no response é retornado na tag <pay_order_id> e na tag <command> passar o comando cancel-payment-order. Veja abaixo a estrutura do XML que precisa ser enviado para cancelar uma ordem de pagamento. <?xml version="1.0" encoding="utf-8"?> <api-request> <verification> <merchantid>store-id</merchantid> <merchantkey>store-key</merchantkey> </verification> <command>cancel-payment-order</command> <request> <payorderid>fiaoeh3moe8=</payorderid> </request> </api-request> Retorno da Requisição para Cancelamento da Ordem de Pagamento com sucesso <?xml version="1.0" encoding="utf-8"?> <api-response> <errorcode>0</errorcode> <errormessage></errormessage> <command>update-payment-order</command> <time> </time> <result> <pay_order_id>fiaoeh3moe8=</pay_order_id> <message>canceled Successfully</message> </result> </api-response> maxipago! Smart Payments

11 Retorno da Requisição para Cancelamento da Ordem de Pagamento com erro <?xml version="1.0" encoding="utf-8"?> <api-response> <errorcode>1</errorcode> <errormessage> <![CDATA[Pay order id not located: FiaoEH3OE8= not located.]]> </errormessage> <time> </time> </api-response> Consultando uma Ordem de Pagamento Para consultar a ordem de pagamento será necessário informar o número da ordem retornada pela maxipago! no response de sua criação. O número da ordem de pagamento no response é retornado na tag <pay_order_id> e na tag <command> passar o comando get-payment-order. Veja abaixo a estrutura do XML que precisa ser enviado para a edição da ordem de pagamento. <?xml version="1.0" encoding="utf-8"?> <api-request> <verification> <merchantid>store-id</merchantid> <merchantkey>store-key</merchantkey> </verification> <command>get-payment-order</command> <request> <payorderid>fiaoeh3moe8=</payorderid> </request> </api-request> maxipago! Smart Payments

12 Retorno da Requisição para consulta da Ordem de Pagamento <?xml version="1.0" encoding="utf-8"?> <api-response> <errorcode>0</errorcode> <errormessage></errormessage> <command>get-payment-order</command> <time> </time> <result> <pay_order_id>fiaoeh3moe8=</pay_order_id> <message>get Successfully</message> <referencenum> </referencenum> <fraudcheck>y</fraudcheck> <status>canceled</status> <billing> <address>avenida Paulista 123</address> <address2>1 Andar</address2> <city>sao Paulo</city> <state>sp</state> <postalcode> </postalcode> <country>br</country> <customeridext> </customeridext> <firstname>teste</firstname> <lastname>maxipay</lastname> <dob>1/30/1984</dob> <sex>m</sex> <phone> </phone> </billing> <transactiondetail> <description>pagamento Parcela Do Carro</description> <comments>pagar ate dia 30</comments> < subject>favor efetuar o pagamento</ subject> <expirationdate>6/10/2019</expirationdate> <paytype> <creditcard> <processorid>1</processorid> <operation>auth</operation> <numberofinstallments>2</numberofinstallments> <currencycode>brl</currencycode> <amount>1000</amount> </creditcard> </paytype> </transactiondetail> </result> </api-response> maxipago! Smart Payments

13 Tabela de parâmetros para envio da requisição Nome Obrigatório Tamanho Descrição merchantid Sim 64 ID da loja na maxipago! merchantkey Sim 80 Chave da loja na maxipago! Ação a ser realizada na ordem de pagamento, valores aceitos: command Sim add-payment-order - cancel-payment-order - update-payment-order - get-payment-order referencenum Sim 128 Código interno do pedido na loja Enviar o pedido para o antifraude, valores aceitos: fraudcheck Sim 1 - Y = Sim - N = Não firstname Sim 64 Nome do comprador lastname Sim 64 Sobrenome do comprador address Sim 128 Endereço e número do comprador address2 Sim 128 Complemento do endereço city Sim 64 Cidade do comprador state Sim 32 Estado do comprador (UF - 2 Dígitos) postalcode Sim 16 CEP do endereço do comprador country Sim 64 País do comprador Sim 128 do comprador Documento do comprador, informe o customeridext Sim apenas o número do CPF ou CNPJ do comprador dob Sim DATE Data de nascimento do comprador sex Sim 1 Sexo do comprador (M F) phone Sim 16 Telefone com o DDD do comprador. Exemplo: description Sim 50 Descrição da venda comments Sim 255 Comentário para a venda subject Sim 150 Assunto do a ser enviado para o comprador maxipago! Smart Payments

14 expirationdate Sim DATE Data de vencimento da ordem de pagamento Dentro da tag <creditcard> Informe o ID da adquirente que irá processar a ordem de pagamento, segue abaixo a lista: processorid Sim 2 operation Sim numberofinstallments Não 4 currencycode Sim 3 1 Simulador de Teste 2 Rede 3 GetNet 4 Cielo 5 e.rede 6 Elavon 8 ChasePaymentech 9 Stone Tipo de processamento, veja os valores aceitos: - auth (Somente Autorizar) - sale (Autoriza/Captura) Número de parcelas da venda. Não enviar para as transações à vista Código da moeda da transação no formato ISO 4217 Ordem simples de pagamento: Valor total da compra. amount Sim 14.2 Observação: ao enviar a tag <recurring>, esse parâmetro será considerado como uma ordem de pagamento diferente da recorrência definida na tag recurring. Dentro da tag <recurring> startdate Não DATE Data de início da cobrança. Formato AAAA-MM-DD maxipago! Smart Payments

15 period Não numberofinstallments Sim 4 failurethreshold Não 11 amount Sim 14.2 Intervalo de tempo entre cobranças: daily = dia(s) weekly = semana(s) monthly = mês(es) bimonthly = bimestral quarterly = trimestral semiannual = semestral annual = anual Quantidade de cobranças a serem realizadas na recorrência de acordo com a informação fornecida na tag <period> Número de tentativas negadas necessárias para ativar notificação por . Mínimo = 1 Valor de cada cobrança a ser realizada de acordo com o período fornecido na tag <period> Tabela de parâmetros de retornos Nome errorcode errormessage command time pay_order_id message referencenum fraudcheck status address address2 city state postalcode Descrição Código de erro. 0 = requisição processada com sucesso 1 = requisição com erro, verifique o erro descrito na tag errormessage Mensagem referente ao código do erro Comando executado na ordem de pagamento Data/hora da transação no formato epoch Código da ordem de pagamento Mensagem da ação realizada Código interno do pedido na loja Análise de fraude Status da ordem (CREATED, PAID e CANCELED) Endereço do comprador Complemento do endereço do comprador Cidade do comprador Estado (UF) do comprador CEP do endereço do comprador maxipago! Smart Payments

16 country customeridext firstname lastname dob sex phone description comments subject expirationdate processorid operation numberofinstallments currencycode amount startdate period failurethreshold País do comprador do comprador Número do documento do comprador Nome do comprador Sobrenome do comprador Data de nascimento do comprador Sexo do comprador Telefone de contato com o comprador Descrição inserida na ordem de pagamento Comentário inserido na ordem de pagamento Assunto do enviado ao comprador Data de vencimento da ordem de pagamento ID da adquirente que deverá processar a ordem de pagamento Tipo de operação de venda a ser realizada Autorização ou Venda Direta Número de parcela ou quantidade de cobranças da recorrência Moeda da ordem de pagamento Valor a ser pago na ordem de pagamento Data de início da cobrança recorrente Intervalo de tempo entre cobranças Número de tentativas negadas necessárias para ativar notificação por e- mail. Suporte O suporte aos desenvolvedores é feito exclusivamente através do nosso Portal de Suporte. Os dados de acesso são enviados para os nossos clientes a partir do suporte@maxipago.com com o assunto "maxipago! de boas-vindas" para o usado no credenciamento. A equipe de suporte da maxipago! pode lhe ajudar com a integração do seu sistema. Atualmente temos bibliotecas de integração em PHP, Java e.net. Suporte ao Cliente maxipago! suporte@maxipago.com Telefone: (11) maxipago! Smart Payments