Sumário. maxipago! Smart Payments

(1)

(2)

Sumário

API Link de Pagamento ... 3

URL’s para requisições ... 3

Criação de Ordem de Pagamento – Pagamento Rápido ... 4

Tabela de parâmetros para envio da requisição sem autenticação ... 5

Criação de Ordem de Pagamento – Com Autenticação ... 6

Criação de Ordem de Pagamento Recorrente – Com Autenticação ... 9

Retorno da Requisição para Criação da Ordem de Pagamento com Sucesso ... 10

Retorno da Requisição para Criação da Ordem de Pagamento com Erro ... 11

Editando uma Ordem de Pagamento ... 12

Retorno da Requisição para Edição da Ordem de Pagamento com Sucesso ... 13

Retorno da Requisição para Edição da Ordem de Pagamento com Erro ... 13

Cancelando uma Ordem de Pagamento ... 14

Retorno da Requisição para Cancelamento da Ordem de Pagamento com Sucesso ... 14

Consultando uma Ordem de Pagamento ... 15

Retorno da Requisição para Consulta da Ordem de Pagamento ... 16

Requisição com Antifraude – Itens de carrinho ... 17

Retorno de Requisição de Antifraude com Sucesso ... 19

Tabela de parâmetros para envio da requisição ... 19

Tabela de parâmetros de retornos ... 26

Tabela de Parâmetros de Requisições de Antifraude (Link com Autenticação) ... 27

(3)

API Link de Pagamento

Com a API do Link de Pagamento integrada em seu sistema, será possível: criar, editar, cancelar e consultar uma Ordem de Pagamento.

URL’s para requisições

Sandbox: http://testapi.maxipago.net/UniversalAPI/postAPI

(4)

Criação de Ordem de Pagamento – Pagamento Rápido

Veja abaixo um exemplo de XML para a geração de uma ordem de pagamento que será paga sem a necessidade de autenticação do seu cliente.

<api-request> <verification> <merchantId>store-id</merchantId> <merchantKey>store-key</merchantKey> </verification> <command>add-payment-order</command> <request> <referenceNum>2009171040</referenceNum> <billing> <email>tecnologia@maxiPago.com</email> <firstName>Paulo Cesar</firstName> </billing> <transactionDetail>

<description>Pagamento parcela 01 de 12</description>

<emailSubject>Link para pagamento de parcela</emailSubject> <payType> <creditCard> <amount>950.00</amount> </creditCard> </payType> </transactionDetail> </request> </api-request>

(5)

Tabela de parâmetros para envio da requisição sem autenticação

Nome Obrigatório Tamanho Descrição

merchantId Sim 64 ID da loja na maxiPago!

merchantKey Sim 80 Chave da loja na maxiPago!

referenceNum Sim 128 Código interno do pedido na loja

email Sim 128 E-mail do comprador

firstName Sim 64 Nome do comprador

description Sim 50 Descrição da venda

emailSubject Sim 150 Assunto do e-mail a ser enviado para o

Comprador

amount

Sim 14.2

Ordem simples de pagamento: Valor total da compra.

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”.

processorID

Sim 2

Informe o ID da adquirente que irá processar a ordem de pagamento, segue abaixo a lista:

1 – Simulador de Teste 2 – Rede 3 – GetNet 4 – Cielo 5 – e.REDE 6 – Elavon 8 – ChasePaymentech 9 – Stone

number _Sim ₁₉ _{Número do cartão de crédito do cliente}

expMonth

Sim 2 Mês de vencimento do cartão com 2 dígitos Exemplo: Janeiro = 01

expYear _Sim ₄ _{Ano de vencimento do cartão com 4 dígitos}

cvvNumber _Sim ₁₄ _{Código de segurança do cartão}

chargeTotal _Sim _14.2 _{Valor do pedido}

customerToken Sim ID único do cadastro, retornado quando o

cliente foi adicionado à base

onFileEndDate Não DATE Data limite para manter o cartão na base

Formato MM/DD/AAAA

customerId ID único do cadastro, retornado quando o

cliente foi adicionado à base (normalmente utilizado para documento do cliente)

(6)

Criação de Ordem de Pagamento – Com Autenticação

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>2009171040</referenceNum> <fraudCheck>Y</fraudCheck> <billing>

<address>Avenida Paulista 123</address> <address2>1 Andar</address2>

<city>Sao Paulo</city> <state>SP</state>

<email>teste.linkdepagamento@mailinator.com</email> <customerIdExt>37568256634</customerIdExt> <firstName>Teste</firstName> <lastName>Link</lastName> <dob>01/30/1984</dob> <sex>M</sex> <phone>11922334455</phone> </billing> <transactionDetail>

<description>Sushi Familia Combo 10</description>

<comments>Pagar até às 17h para entrega às 20h</comments> <emailSubject>Pagamento Sushi Família – Combo 10</emailSubject> <expirationDate>30/06/2020</expirationDate> <payType> <creditCard> <processorID>1</processorID> <operation>sale</operation> <numberOfInstallments>1</numberOfInstallments> <currencyCode>BRL</currencyCode> <amount>180.00</amount> </creditCard> </payType> </transactionDetail> </request> </api-request>

(7)

Criação de Ordem de Pagamento Recorrente – Com Autenticação

<?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>2009171040</referenceNum> <fraudCheck>Y</fraudCheck> <billing>

<email>teste.linkdepagamento@mailinator.com</email> <customerIdExt>37568256634</customerIdExt> <firstName>Teste</firstName> <lastName>Link</lastName> <dob>01/30/1984</dob> <sex>M</sex> <phone>11922334455</phone> </billing> <transactionDetail>

<description>Assinatura de Vinho Pacote 2</description> <comments>Assinatura de Vinho Tinto – Pacote 2 (3 vinhos por mês)</comments>

<emailSubject>Pagamento – assinatura de vinho</emailSubject> <expirationDate>30/06/2020</expirationDate>

(8)

Observação: O retorno de uma requisição de transação convencional e recorrência será o mesmo.

Retorno da Requisição para Criação da Ordem de Pagamento com Sucesso

• Retorno em lojas que não possuem skin personalizada

<creditCard> <processorID>1</processorID> <operation>sale</operation> <numberOfInstallments>1</numberOfInstallments> <currencyCode>BRL</currencyCode> <amount>150,00</amount> </creditCard> </payType> </transactionDetail> <recurring> <startDate>30/07/2020</startDate> <period>monthly</period> <numberOfInstallments>12</numberOfInstallments> <failureThreshold>5</failureThreshold> <amount>150.00</amount> </recurring> </request> </api-request> <?xml version="1.0" encoding="UTF-8" ?> <api-response> <errorCode>0</errorCode> <errorMessage></errorMessage> <command>add-payment-order</command> <time>1505919057637</time> <result> <pay_order_id>FiaoEH3mOE8=</pay_order_id> <message>Inserted Successfully</message> <url>https://secure.maxipago.net/maxipay</url> </result> </api-response>

(9)

•

Retorno em lojas que possuem skin personalizada

Observação: As URLs do response de um link de pagamento com autenticação, sempre serão fixas.

No caso de personalização de skin, será fixa com o nome já pré-definido.

Retorno da Requisição para Criação da Ordem de Pagamento com Erro

<?xml version="1.0" encoding="UTF-8" ?> <api-response> <errorCode>0</errorCode> <errorMessage></errorMessage> <command>add-payment-order</command> <time>1505919057637</time> <result> <pay_order_id>FiaoEH3mOE8=</pay_order_id> <message>Inserted Successfully</message> <url>https://testsecure.maxipago.net/maxipay/lulishouse</url> </result> </api-response> <?xml version="1.0" encoding="UTF-8" ?> <api-response> <errorCode>1</errorCode> <errorMessage>

<![CDATA[Unable to authenticate merchant]]> </errorMessage>

(10)

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>2009171040</referenceNum> <fraudCheck>Y</fraudCheck> <billing>

<email>teste.linkdepagamento@mailinator.com</email> </billing>

<description>Sushi Familia Combo 10</</description>

<comments>Pagar até às 17h para entrega às 20h</comments> <emailSubject> Pagamento Sushi Família – Combo 10<emailSubject> <expirationDate>30/06/2020</expirationDate> <payType> <creditCard> <processorID>1</processorID> <operation>sale</operation> <numberOfInstallments>1</numberOfInstallments> <currencyCode>BRL</currencyCode> <amount>180.00</amount> </creditCard> </payType> </transactionDetail> </request> </api-request>

(11)

Retorno da Requisição para Edição da Ordem de Pagamento com Sucesso

Retorno da Requisição para Edição da Ordem de Pagamento com Erro

<?xml version="1.0" encoding="UTF-8" ?> <api-response> <errorCode>0</errorCode> <errorMessage></errorMessage> <command>update-payment-order</command> <time>1505919370269</time> <result> <pay_order_id>FiaoEH3mOE8=</pay_order_id> <message>Updated Successfully</message> </result> </api-response> <?xml version="1.0" encoding="UTF-8" ?> <api-response> <errorCode>1</errorCode> <errorMessage>

<![CDATA[Pay order id not located: /GKUFSd9WdI not located.]]> </errorMessage>

(12)

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.

Retorno da Requisição para Cancelamento da Ordem de Pagamento com

Sucesso

<?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> <?xml version="1.0" encoding="UTF-8" ?> <api-response> <errorCode>0</errorCode> <errorMessage></errorMessage> <command>update-payment-order</command> <time>1505920288323</time> <result> <pay_order_id>FiaoEH3mOE8=</pay_order_id> <message>Canceled Successfully</message> </result> </api-response>

(13)

Retorno da Requisição para Cancelamento da Ordem de Pagamento com Erro

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-response>

<![CDATA[Pay order id not located: FiaoEH3OE8= not located.]]> </errorMessage> <time>1506001554433</time> </api-response> <?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>

(14)

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>1505920374458</time> <result> <pay_order_id>FiaoEH3mOE8=</pay_order_id> <message>Get Successfully</message> <referenceNum>2009171040</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>01311000</postalcode> <country>BR</country> <email>teste.linkdepagamento@mailinator.com</email> <customerIdExt>37568256634</customerIdExt> <firstName>Teste</firstName> <lastName>Maxipay</lastName> <dob>1/30/1984</dob> <sex>M</sex> <phone>11922334455</phone> </billing> <transactionDetail>

<description>Sushi Familia Combo 10</description>

<comments>Pagar até às 17h para entrega às 20h</comments> <emailSubject>Pagamento Sushi Família – Combo 10</emailSubject> <expirationDate>30/06/2020</expirationDate> <payType> <creditCard> <processorID>1</processorID> <operation>auth</operation> <numberOfInstallments>1</numberOfInstallments> <currencyCode>BRL</currencyCode> <amount>180.00</amount> </creditCard> </payType> </transactionDetail> </result> </api-response>

(15)

Requisição com Antifraude – Itens de carrinho

Request com itens de carrinho é válido apenas para link com autenticação

<api-request> <verification> <merchantId>23859</merchantId> <merchantKey>fyagh4eoab1nxd3gt4681x8a</merchantKey> </verification> <command>add-payment-order</command> <request> <referenceNum>0912219</referenceNum> <fraudCheck>Y</fraudCheck> <itemList itemCount="3"> <item> <itemIndex>1</itemIndex>

<itemProductCode>Produto de Teste Um</itemProductCode>

<itemDescription>Produto de Teste Item do Carrinho 1</itemDescription> <itemQuantity>1</itemQuantity> <itemTotalAmount>10.00</itemTotalAmount> <itemUnitCost>10.00</itemUnitCost> <itemTaxAmount>15.00</itemTaxAmount> <itemDiscountAmount>11</itemDiscountAmount> <itemTaxIncluded>y</itemTaxIncluded> <itemTaxType>012</itemTaxType> <itemReference>2</itemReference> <itemInfo1>teste info 1</itemInfo1> <itemValue1>120</itemValue1> <itemInfo2>teste info 2</itemInfo2> <itemValue2>130</itemValue2> <itemStatus>teste</itemStatus> <itemCategory>123123</itemCategory> </item> <item> <itemIndex>2</itemIndex>

<itemProductCode>Produto de Teste Dois</itemProductCode>

<itemDescription>Produto de Teste Item do Carrinho 2</itemDescription> <itemQuantity>2</itemQuantity> <itemTotalAmount>20.00</itemTotalAmount> <itemUnitCost>10.00</itemUnitCost> </item> <item> <itemIndex>3</itemIndex>

<itemProductCode>Produto de Teste tres</itemProductCode>

<itemDescription>Produto de Teste Item do Carrinho 3</itemDescription> <itemQuantity>5</itemQuantity> <itemTotalAmount>50.00</itemTotalAmount> <itemUnitCost>10.00</itemUnitCost> </item> </itemList> <billing>

(16)

<itemProductCode>Produto de Teste Dois</itemProductCode>

<itemDescription>Produto de Teste Item do Carrinho 2</itemDescription> <itemQuantity>2</itemQuantity> <itemTotalAmount>20.00</itemTotalAmount> <itemUnitCost>10.00</itemUnitCost> </item> <item> <itemIndex>3</itemIndex>

<itemProductCode>Produto de Teste tres</itemProductCode>

<itemDescription>Produto de Teste Item do Carrinho 3</itemDescription> <itemQuantity>5</itemQuantity> <itemTotalAmount>50.00</itemTotalAmount> <itemUnitCost>10.00</itemUnitCost> </item> </itemList> <billing>

<address>Avenida Paulista 123</address> <address2>1 Andar</address2> <city>Sao Paulo</city> <state>SP</state> <postalcode>01311000</postalcode> <country>BR</country> <email>luciana.gomes@maxipago.com</email> <customerIdExt>28187718897</customerIdExt> <firstName>Lulis</firstName> <lastName>Gomes</lastName> <dob>04/01/1980</dob> <sex>F</sex> <phone>1199414789</phone> <documents> <document> <documentType>CPF</documentType> <documentValue>28187718897</documentValue> </document> <document> <documentType>RG</documentType> <documentValue>288417367</documentValue> </document> </documents> </billing> <transactionDetail>

<description>Teste do Carrinho Clearsale</description> <comments>Pagar valor total da fatura</comments>

<emailSubject>Realizar pagamento total da fatura</emailSubject> <expirationDate>03/05/2021</expirationDate>

<address>Avenida Paulista 123</address> <address2>1 Andar</address2> <city>Sao Paulo</city> <state>SP</state> <postalcode>01311000</postalcode> <country>BR</country> <email>luciana.gomes@maxipago.com</email> <customerIdExt>28187718897</customerIdExt> <firstName>Lulis</firstName>

(17)

Retorno de Requisição de Antifraude com Sucesso

Tabela de parâmetros para envio da requisição

merchantId Sim 64 ID da loja na maxiPago!

merchantKey Sim 80 Chave da loja na maxiPago!

command Sim - - -

Ação a ser realizada na ordem de pagamento, valores aceitos:

- add-payment-order - cancel-payment-order - update-payment-order - get-payment-order <payType> <creditCard> <processorID>1</processorID> <operation>sale</operation> <numberOfInstallments>2</numberOfInstallments> <currencyCode>BRL</currencyCode> <amount>80.00</amount> </creditCard> </payType> </transactionDetail> </request> </api-request> <?xml version="1.0" encoding="UTF-8"?> <api-response> <errorCode>0</errorCode> <errorMessage></errorMessage> <command>add-payment-order</command> <time>1584938313578</time> <result> <pay_order_id>037P2ezuBr4=</pay_order_id> <message>Inserted Successfully</message> </result> </api-response>

(18)

referenceNum Sim 128 Código interno do pedido na loja

fraudCheck Sim 1

Enviar o pedido para o antifraude, valores aceitos:

- 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

email Sim 128 E-mail do comprador

customerIdExt Sim

Documento do comprador, informe o 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: 01122334455

description Sim 50 Descrição da venda

comments Sim 255 Comentário para a venda

emailSubject Sim 150 Assunto do e-mail a ser enviado para o

Comprador

expirationDate Sim DATE Data de vencimento da ordem de

(19)

processorID Sim 2

Informe o ID da adquirente que irá processar a ordem de pagamento, segue abaixo a lista: 1 – Simulador de Teste 2 – Rede 3 – GetNet 4 – Cielo 5 – e.REDE 6 – Elavon 8 – ChasePaymentech 9 – Stone operation Sim - - -

Tipo de processamento, veja os valores aceitos:

- auth (Somente Autorizar) - sale (Autoriza/Captura)

numberOfInstallments Não 4

Número de parcelas da venda.

Não enviar para as transações à vista

currencyCode Sim 3 Código da moeda da transação no formato

ISO 4217

amount Sim 14.2

Ordem simples de pagamento: Valor total da compra.

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.

(20)

period Não - - -

Intervalo de tempo entre cobranças: daily = dia(s) weekly = semana(s) monthly = mês(es) bimonthly = bimestral quarterly = trimestral semiannual = semestral annual = anual numberOfInstallments Sim 4

Quantidade de cobranças a serem

realizadas na recorrência de acordo com a informação fornecida na tag <period>

failureThreshold Não 11

Número de tentativas negadas antes do cancelamento da recorrência.

Mínimo = 1

amount Sim 14.2

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 Descrição

errorCode

Código de erro.

0 = requisição processada com sucesso

1 = requisição com erro, verifique o erro descrito na tag errorMessage errorMessage Mensagem referente ao código do erro

command Comando executado na ordem de pagamento

time Data/hora da transação no formato epoch

pay_order_id Código da ordem de pagamento

message Mensagem da ação realizada

referenceNum Código interno do pedido na loja

fraudCheck Análise de fraude

status Status da ordem (CREATED, PAID e CANCELED)

address Endereço do comprador

address2 Complemento do endereço do comprador

city Cidade do comprador

state Estado (UF) do comprador

(21)

country País do comprador

email E-mail do comprador

customerIdExt Número do documento do comprador

firstName Nome do comprador

lastName Sobrenome do comprador

dob Data de nascimento do comprador

sex Sexo do comprador

phone Telefone de contato com o comprador description Descrição inserida na ordem de pagamento comments Comentário inserido na ordem de pagamento emailSubject Assunto do e-mail enviado ao comprador expirationDate Data de vencimento da ordem de pagamento

processorID ID da adquirente que deverá processar a ordem de pagamento

operation Tipo de operação de venda a ser realizada Autorização ou Venda Direta numberOfInstallments Número de parcela ou quantidade de cobranças

currencyCode Moeda da ordem de pagamento

amount Valor a ser pago na ordem de pagamento startDate Data de início da cobrança recorrente period Intervalo de tempo entre cobranças

failureThreshold Número de tentativas negadas antes de cancelar a recorrência URL Retorno da URL para acesso à tela do checkout

Tabela de Parâmetros de Requisições de Antifraude (Link com Autenticação)

version Sim 11 Versão da API

merchantId Sim 20 Id de Loja que identifica o

estabelecimento

merchantKey Sim 80 Chave associada ao ID da loja

referenceNum Sim 128

Identificador do pedido no estabelecimento

Este campo aceita apenas valores alfanuméricos e deve ser único.

(22)

processorID Sim 2

Informe o ID da adquirente que irá processar a ordem de pagamento, segue abaixo a lista:

1 – Simulador de Teste 7 – Rede 8 – GetNet 9 – Cielo 10 – e.REDE 11 – Elavon 8 – ChasePaymentech 9 – Stone fraudCheck Não 1

Flag para enviar transação para verificação de fraude. Se deixado em branco a transação será verificada Y ou vazio/nulo = Checar

N = Não Checar

Este campo só funciona para clientes que possuem o serviço de antifraude contratado.

ipAddress Não 16 Endereço de IP do comprador

billing/id

Sim 50 ID do consumidor na base do lojista

shipping/id billing/name

Sim 64 Nome do cliente (somente alfabético)

shipping/name billing/address

Sim 128 Logradouro de cobrança da transação

(sem acentos e caracteres especiais) shipping/address

billing/address2

Não 128

Complemento do Logradouro de cobrança da transação (sem acentos e caracteres especiais)

shipping/address2 billing/district/county

Sim 64 Bairro (sem acentos e caracteres

especiais) shipping/district/county

billing/city

Sim 64 Cidade (sem acentos e caracteres

especiais) shipping/city

billing/state

Sim 32 Estado (enviado com 2 dígitos)

shipping/state billing/postalcode

Sim 16 CEP de Cobrança

shipping/postalcode billing/country

Sim 64 País (Abreviação de 2 dígitos)

shipping/country billing/email

Sim 128 Utilização obrigatória de “@”

(23)

Sim 50 Use “Individual” para CPF e “Legal _{entity” para CNPJ} shipping/type

billing/gender

Sim 1 Sexo (“M” ou “F)

shipping/gender billing/birthDate

Sim 12 Data de nascimento (AAAA-MM-DD)

shipping/birthDate

phone/phoneType Sim 50

Utilize um dos dados abaixo: – Residential – Commercial – Mobile – Fax – Undefined – Message – Billing document/documentType Sim 50

Tipo de Documento. Utilize a lista abaixo:

CPF RG CNPJ

StateRegistration (não aplicado ao BR) MunicipalRegistration (não aplicado ao BR)

Passport

CTPS (Carteira de Trabalho – número PIS)

VoterDocument (Título de Eleitor)

document/documentValue Sim 50 Número do documento

fraudDetails/fraudProcess

orID Não 32

Envio do ProcessorID quando houver mais de um antifraude configurado na maxiPago!

fraudDetails/captureOnLo

wRisk Não 1

Permite realizar a captura de uma transação após aprovação (“Y” ou “N”) fraudDetails/voidOnHighRi

sk Não 1

Permite cancelar (void) uma transação quando houver uma reprovação do antifraude via maxiPago!

fraudDetails/fraudToken Sim 150

Envio do SessionId da transação enviado no DeviceFingerprint na Kount ou ClearSale

(24)

expMonth Sim 2

Mês de vencimento do cartão com 2 dígitos

Exemplo: Janeiro = 01

expYear Sim 4 Ano de vencimento do cartão com 4

dígitos

cvvNumber Sim 14 Código de segurança do cartão

currencyCode Não 3

Código da moeda da transação no formato ISO 4217

Válido somente para transações Chase Paymentech.

chargeTotal Sim 14.2

Valor do pedido

Os decimais devem ser separados por ponto (“.”)

shippingTotal Não 14.2

Valor do frete que será cobrado. Os decimais devem ser separados por ponto (“.”)

numberOfInstallments Não 2

Número de parcelas da transação Para transações à vista não enviar/enviar nulo.

chargeInterest Não 1

Define se o parcelamento é do tipo Loja ou Cartão

Para transações à vista não enviar/enviar nulo.

N = Sem juros (PADRÃO – parcelamento Loja)

Y = Com juros (parcelamento Cartão)

itemIndex Sim 1 Itens: Enumerador do item de 1 a n

itemProductCode Não 50

Itens: Categoria do produto; Alfanumérico

Ex: Acessórios de cozinha

itemDescription Sim 100 Itens: Descrição do Item; Alfanumérico

Ex: Facas Ginsu

itemQuantity Sim 10 Itens: Quantidade deste item

itemTotalAmount Sim 19

Valor do Item.

itemUnitCost Sim 1

Valor do Item.

city Sim 64

Cidade da reserva realizada obrigatório caso a Tag seja enviada

state Sim 32

Estado (UF) da reserva realizada obrigatório caso a Tag seja enviada

country Sim 64

País de origem da reserva

(25)

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 e-mail suporte@maxipago.com com o assunto "maxiPago! e-mail de boas-vindas" para o e-mail 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! E-mail: suporte@maxipago.com

Telefone: (11) 3003-0603 – Capitais e Regiões Metropolitanas 0800 723 0603 – Demais Localidades