link de pagamento...email sim 128 e-mail do comprador firstname sim 64 nome do comprador description...

Link de Pagamento

maxiPago! Smart Payments © 2020 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

Suporte .............................................................................................................................. 31


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

Produção: http://api.maxipago.net/UniversalAPI/postAPI

http://testapi.maxipago.net/UniversalAPI/postAPIhttp://api.maxipago.net/UniversalAPI/postAPI


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.

store-id

store-key

add-payment-order

2009171040

[email protected]

Paulo Cesar

Pagamento parcela 01 de 12

Link para pagamento de parcela

950.00


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

, 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 19 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 4 Ano de vencimento do cartão com 4 dígitos

cvvNumber Sim 14 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)

token Token único associado ao cartão


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

Veja abaixo um exemplo de XML para a geração de uma ordem de pagamento.

store-id

store-key

add-payment-order

2009171040

Y

Avenida Paulista 123

1 Andar

Sao Paulo

SP

01311000

BR

[email protected]

37568256634

Teste

Link

01/30/1984

M

11922334455

Sushi Familia Combo 10

Pagar até às 17h para entrega às 20h

Pagamento Sushi Família – Combo 10

30/06/2020

1

sale

1

BRL

180.00

mailto:[email protected]


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

store-id

store-key

add-payment-order

2009171040

Y


1 Andar

Sao Paulo

SP

01311000

BR

[email protected]

37568256634

Teste

Link

01/30/1984

M

11922334455

Assinatura de Vinho Pacote 2

Assinatura de Vinho Tinto – Pacote 2 (3 vinhos por mês)

Pagamento – assinatura de vinho

30/06/2020



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

1

sale

1

BRL

150,00

30/07/2020

monthly

12

5

150.00

0

add-payment-order

1505919057637

FiaoEH3mOE8=

Inserted Successfully

https://secure.maxipago.net/maxipay

https://secure.maxipago.net/maxipay?p=FiaoEH3mOE8=


• 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

0

add-payment-order

1505919057637

FiaoEH3mOE8=


https://testsecure.maxipago.net/maxipay/lulishouse

1

1506001138215

https://testsecure.maxipago.net/


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 e na tag passar o comando update-payment-order.

Veja abaixo a estrutura do XML que precisa ser enviado para a edição da ordem de pagamento.

store-id

store-key

update-payment-order

FiaoEH3mOE8=

2009171040

Y

[email protected]



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

0 update-payment-order 1505919370269

FiaoEH3mOE8= Updated Successfully

1

1506001384164


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 e na tag 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

store-id store-key

cancel-payment-order

FiaoEH3mOE8=

0 update-payment-order 1505920288323

FiaoEH3mOE8= Canceled Successfully


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 e na tag passar o comando get-payment-order.

Veja abaixo a estrutura do XML que precisa ser enviado para a edição da ordem de pagamento.

1

1506001554433

store-id store-key

get-payment-order

FiaoEH3mOE8=


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

0

get-payment-order

1505920374458

FiaoEH3mOE8=

Get Successfully

2009171040

Y

CANCELED


1 Andar

Sao Paulo

SP

01311000

BR

[email protected]

37568256634

Teste

Maxipay

1/30/1984

M

11922334455


Pagar até às 17h para entrega às 20h

Pagamento Sushi Família – Combo 10

30/06/2020

1

auth

1

BRL

180.00



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

23859

fyagh4eoab1nxd3gt4681x8a

add-payment-order

0912219

Y

1

Produto de Teste Um

Produto de Teste Item do Carrinho 1

1

10.00

10.00

15.00

11

y

012

2

teste info 1

120

teste info 2

130

teste

123123

2

Produto de Teste Dois


2

20.00

10.00

3

Produto de Teste tres


5

50.00

10.00


1 Andar

Sao Paulo

SP


Produto de Teste Dois Produto de Teste Item do Carrinho 2

2

20.00

10.00

3

Produto de Teste tres


5

50.00

10.00


1 Andar

Sao Paulo

SP

01311000

BR

[email protected]

28187718897

Lulis

Gomes

04/01/1980

F

1199414789

CPF

28187718897

RG

288417367

Teste do Carrinho Clearsale

Pagar valor total da fatura

Realizar pagamento total da fatura

03/05/2021


1 Andar

Sao Paulo

SP

01311000

BR

[email protected]

28187718897

Lulis


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

1

sale

2

BRL

80.00

0

add-payment-order

1584938313578

037P2ezuBr4=




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

Pagamento


Dentro da tag

processorID

Sim

2

Informe o ID da adquirente que irá

processar a ordem de pagamento, segue

abaixo a lista:


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

, esse parâmetro será

considerado como uma ordem de

pagamento diferente da recorrência

definida na tag “recurring”.

Dentro da tag

startDate Não DATE Data de início da cobrança.

Formato AAAA-MM-DD


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

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

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

postalcode CEP do endereço do comprador


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.


processorID Sim 2

Informe o ID da adquirente que irá

processar a ordem de pagamento,

segue abaixo a lista:


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 “@” shipping/email


billing/type 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/fraudProcessorID

Não 32 Envio do ProcessorID quando houver mais de um antifraude configurado na maxiPago!

fraudDetails/captureOnLowRisk

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

fraudDetails/voidOnHighRisk

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

number Sim 19 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 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.


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


country Sim 64 País de origem da reserva



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 [email protected] 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: [email protected]

Telefone: (11) 3003-0603 – Capitais e Regiões Metropolitanas

0800 723 0603 – Demais Localidades
mailto:[email protected]:[email protected]

link de pagamento...email sim 128 e-mail do comprador firstname sim 64 nome do comprador description...

Documents