Comunidade de Desenvolvedores maxiPago!

Salvar um Cartão na Base

 

O nosso gateway permite ao estabelecimento salvar o cartão de crédito do cliente para futuras compras. O número de cartão e a data de vencimento ficam guardados em nossos servidores e o estabelecimento recebe um token único referente ao cartão.

Em uma futura compra, ao invés de pedir novamente o número do cartão ao cliente, o estabelecimento envia o token para a maxiPago!, agilizando o checkout.

Por medidas de segurança é preciso enviar os dados de cobrança do portador, ou seja, o endereço onde o cliente do cartão recebe a fatura.

 

URLs para salvar um cartão na base

 

Sandbox: https://testapi.maxipago.net/UniversalAPI/postAPI
Produção: https://api.maxipago.net/UniversalAPI/postAPI

 

Exemplo de requisição

 

<api-request>
    <verification>
        <merchantId>store-id</merchantId>
        <merchantKey>store-key</merchantKey>
    </verification>
    <command>add-card-onfile</command>
    <request>
        <customerId>999</customerId>
        <creditCardNumber>4111111111111111</creditCardNumber>
        <expirationMonth>12</expirationMonth>
        <expirationYear>12</expirationYear>
        <billingName>Fulano de tal</billingName>
        <billingAddress1>Av. Marcos Penteado de Ulhoa Rodrigues, 939</billingAddress1>
        <billingAddress2>11 Andar</billingAddress2>
        <billingCity>Barueri</billingCity>
        <billingState>SP</billingState>
        <billingZip>06360040</billingZip>
        <billingCountry>BR</billingCountry>
        <billingPhone>01121218536</billingPhone>
        <billingEmail>fulano@dominio.com</billingEmail>
        <onFilePermissions>ongoing</onFilePermissions>
        <onFileMaxChargeAmount>12/25/1970</onFileMaxChargeAmount>
    </request>
</api-request>

 

Os parâmetros aceitos no add-card-onfile

 

Os parâmetros aceitos no comando add-card-onfile estão abaixo. Se o campo for vazio, não enviar.

Nome

Obrigatório

Descrição

merchantId

Sim

ID da loja que identifica o Estabelecimento

merchantKey

Sim

Chave associada ao ID da Loja

command

Sim

Comando a ser executado. Para salvar um cartão na base: add-card-onfile

customerId

Sim

ID único do cadastro, retornado quando o cliente foi adicionado à base

creditCardNumber

Sim

Número do cartão de crédito a ser salvo

expirationMonth

Sim

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

expirationYear

Sim

Ano de vencimento do cartão com 4 dígitos

billingName

Sim

Nome do portador do cartão. É preciso informar o nome do portador exatamente como impresso no cartão, mesmo que o cliente já tenha cadastro pelo comando add-consumer.
O tamanho deste campo é limitado ao máximo de 26 caracteres (Não permite caracteres especiais).

billingAddress1

Sim

Endereço de cobrança para onde é enviada a fatura do cartão

billingAddress2

Sim

Complemento do endereço de cobrança

billingCity

Sim

Cidade

billingState

Sim

UF da residência do cliente. 2 letras seguindo padrão Brasileiro. ZZ = Fora do Brasil.

billingZip

Sim

CEP sem traço

billingCountry

Sim

Código do país com 2 letras (ISO 3166-2)

billingPhone

Sim

Telefone de contato do portador. Com DDD, sem traço ou espaço (Ex: 1112345678).

billingEmail

Sim

Endereço de e-mail do portador

onFileEndDate

Não

Data limite do uso do cartão salvo. Formato: MM/DD/AAAA

onFilePermissions

Não

Duração limite do uso do cartão salvo.
ongoing = indefinidamente
use_once = apenas uma vez após a 1ª cobrança
.

onFileComment

Não

Comentários adicionais sobre este cartão

onFileMaxChargeAmount

Não

Valor máximo que é permitido cobrar para este cartão.
Decimais separados por ponto (“.”). Exemplo: 100.00