Introdução
Bem-vindo(a) à API de pagamentos da AixMobil!
Disponibilizamos nossa API para que você possa ter acesso a todas as operações para integrar o seu negócio com a nossa plataforma de pagamento.
Nossa plataforma adota rigorosos padrões de segurança e possui a certificação PCI-DSS (o que é), certificação esta que abrange uma extensa lista de requisitos de segurança que precisam ser cumpridas por empresas que processam dados de cartões de pagamento.
Como nossa API é baseada nas mais modernas tecnologias e está sempre atualizada com as melhores práticas de mercado, proporcionamos uma integração mais simples, com menor custo e prazo para implementação da solução.
Segurança
nossa API é disponibilizada somente através de ambiente seguro utilizando o protocolo HTTPS, que garante que todos os dados trafegados pela rede até chegarem a nossa infra-estrutura são encriptados.
não armazenamos nenhum dado sensível relacionado ao pagamento, como número do cartão de crédito ou débido, CVV ou data de expiração do cartão. Estes dados são repassados diretamente para as adquirentes responsáveis por aprovar e processar os pagamentos.
da mesma forma que aplicamos as melhores formas de proteger os dados do pagamento e do pagador dentro da nossa infra-estrutura, procuramos estabelecer critérios e boas práticas do lado da entidade que está realizando a integração com a nossa API. A segurança da informação precisa acontecer de ponta a ponta! (Veja nossa documentação de como encriptar dados sensíveis do formulário de pagamento em client-side encryption).
Pré-requisitos
para utilizar nossa API de integração, é necessário fornecer a lista com os endereços IP de origem que farão as requisições para a nossa API, para que sejam liberadas no Firewall, ou seja, nossa API não deve ser chamada diretamente do FrontEnd, como uma tela de checkout de e-commerce.
o endereço web onde a captura dos dados de cartão de crédito ou debito for realizada deve necessariamente possuir um certificado HTTPS.
Configurações
Todos os desenvolvimentos de integração devem ser feitos utilizando os endpoints do ambiente de Testes da AixMobil e apenas direcionados para Produção quando as integrações estiverem finalizadas.
Host de testes: https://api-dev.aixmobil.com/api
Host de produção: https://api.aixmobil.com/api
Autenticação
Login
Toda e qualquer interação com os serviços da API deve se feita de forma autenticada, utilizando as credenciais da conta AixMobil cadastrada na plataforma.
Este endpoint autentica as credenciais fornecidas e retorna um token de sessão que deve ser informado nas requisições subsequentes.
curl -X POST https://api.aixmobil.com/api/login \
-H "Content-Type: application/json" \
-d '{
"usuario": "[EMAIL_DE_ACESSO]",
"senha": "[SENHA_DE_ACESSO]"
}'
Requisição HTTP
POST https://api.aixmobil.com/api/login
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
Payload da requisição
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
usuario | String(80) | Sim | E-mail ou username (se o usuário foi criado pela API) do usuário da conta cadastrada na plataforma |
senha | String(40) | Sim | Senha da conta cadastrada |
Status de retorno
Retorno da requisição:
200 OK
{
"token": "[B@459fecb0",
"sucesso": true,
"codigoStatus": 1001,
"mensagem": "Acesso autorizado"
}
Response Status: HTTP_OK (200)
Objeto de retorno
Atributo | Tipo | Descrição |
---|---|---|
token | String(40) | Token de sessão para utilização nas requisições |
sucesso | Boolean | Sucesso da requisição |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
Autorização
Além de utilizar o token de autenticação para chamar os endpoints restritos da API, é possível se autenticar e executar um enpoint em uma única chamada.
Para isto, basta informar a credencial utilizada para autenticar na API no header da requisição do endpoint desejado.
curl -X POST https://payment.aixmobil.com/rest/cartoes \
-H "Content-Type: application/json" \
-H "UserId: user@domain.com" \
-H "UserKey: password" \
-d '{
"cartao": "4444000011112222",
"portador": "Fulano de Tal",
"cvv": 111,
"validade": "11/2021",
"cpfCnpjPortador": "11111111111"
}'
Requisição HTTP
POST https://payment.aixmobil.com/rest/cartoes
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
UserId | [Login do usuário específico para chamar esse endpoint] |
UserKey | [Senha do usuário específico para chamar esse endpoint] |
Transações - Pagamentos
Cartão de crédito
Cria uma transação com cartão de crédito.
Os dados sensíveis do pagamento (número do cartão, data de validade e CVV) devem ser encriptados seguindo as instruções do manual de client-side encryption (CSE).
curl -X POST https://api.aixmobil.com/api/transacoes/encryptCredito \
-H "Content-Type: application/json" \
-H "SessionId: [B@459fecb0" \
-d '{
"idCliente": "998877",
"cartao": "[NUMERO_CARTAO_ENCRIPTADO]",
"portador": "Carlos Aragão",
"cvv": "[CVV_ENCRIPTADO]",
"validade": "[VALIDADE_ENCRIPTADO]",
"valor": 123.45,
"parcelas": 1,
"seuNumero": "123456",
"cpfCnpjPortador": "11111111111",
"dataNascimento": "1978-03-07",
"telefone": 5199998877,
"email": "carlos.aragao@dominio.com.br",
"dadosAdicionais": "Promoção de Natal",
"splitConfig": "CFG_0001",
"endereco": {
"logradouro": "Rua dos Atores",
"numero": "123",
"complemento": "Ap. 201 / BL A",
"bairro": "Higienópolis",
"cidade": "Paraíso do Sul",
"estado": "RS",
"cep": "90000000"
},
"checkoutSessionToken": "[TOKEN_SESSAO_RECEBIDO_PELA_LIB_CSE]"
}'
Requisição HTTP
POST https://api.aixmobil.com/api/transacoes/encryptCredito
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Payload da requisição
Objeto endereco
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
logradouro | String(120) | Sim | |
numero | String(10) | Não | |
complemento | String(30) | Não | |
cep | String(8) | Sim | CEP contendo apenas números |
bairro | String(40) | Sim | |
cidade | String(60) | Sim | |
estado | String(2) | Sim | Sigla do estado |
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idCliente | String(40) | Não | Identificação do cliente (sub-conta) na plataforma AixMobil. Se não for informado, assume-se que a transação está relacionada ao cliente logado na sessão. É obrigatório se o usuário logado for uma conta master. |
cartao | String(512) | Sim | Número do cartão (apenas números) |
portador | String(60) | Sim | Nome do portador do cartão |
cvv | String(512) | Sim | CVV do cartão |
validade | String(512) | Sim | Validade do cartão no formato MM/AAAA |
valor | Number(15,2) | Sim | Valor da transação no formato ######.## (usar "." Como separador decimal) |
parcelas | Number(2) | Sim | Número de parcelas (valor entre 1 e 12) |
seuNumero | String(30) | Não | Campo livre para identificação interna do cliente |
cpfCnpjPortador | String(14) | Sim | CPF/CNPJ do pagador (apenas números) |
telefone | Number(11) | Não | Número de telefone do pagador (apenas números) |
String(120) | Não | E-mail do pagador. Utilizado para o envio do recibo da transação, caso o cliente esteja configurado para receber recibos por e-mail quando a transação é aprovada. | |
dadosAdicionais | String(120) | Não | Campo livre para inclusão de dados adicionais da transação. Conteúdo é exibido no recibo da transação. |
dataNascimento | Date | Não | Data de nascimento do pagador no formato AAAA-MM-DD. É obrigatório apenas se o cliente estiver configurado para ter os CPFs das transações validados na Receita Federal. |
tipoRecorrencia | String(1) | Não | Tipo de recorrência: "D" (diária) "M" (mensal) "A" (anual) "H" (Ad-hoc) Ao selecionar a opção "H" é retornado no response o token do cartão |
periodoRecorrencia | Number(2) | Não | Número de dias / meses / anos para recorrência |
qtdeLimite | Number(2) | Não | Máximo de transações recorrentes a serem geradas (incluindo a primeira) |
dataLimite | Date | Não | Data limite para gerar transações recorrentes no formato AAAA-MM-DD |
splitConfig | String(20) | Não | Código da configuração do split cadastrado pelo cliente que indica como será o split da transação entre outros clientes |
endereco | Objeto endereço | Não | Endereço do pagador |
nomeFantasia | String(11) | Não | Nome que aparecerá na fatura do cartão, após o nome "AIXMOBIL*". Exemplo: AIXMOBIL*LOJAS123. |
Status de retorno
Retorno da requisição:
201 CREATED
{
"sucesso": true,
"codigoStatus": 50201,
"mensagem": "Pagamento realizado com sucesso!",
"idTransacao": 100,
"valor": 123.45,
"valorLiquido": 117.28,
"tarifa": 6.17,
"endereco": {
"logradouro": "Rua dos Atores",
"numero": "123",
"complemento": "Ap. 201 / BL A",
"bairro": "Higienópolis",
"cidade": "Paraíso do Sul",
"estado": "RS",
"cep": "90000000"
},
"cartao": "1234 **56** **** 7890",
"autorizacao": "12345678",
"modalidade": "CRE",
"qtdeParcelas": 1,
"dataHora": 1541595588912,
"bandeira": 1
}
Response Status: HTTP_CREATED (201)
Objeto de retorno
Atributo | Tipo | Descrição |
---|---|---|
sucesso | Boolean | Sucesso da requisição |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
idTransacao | Number(32) | Identificação da transação na plataforma |
tokenCartao | String(80) | Token gerado para o cartão (somente quando houver recorrência) |
sequencial | Number(10) | Número sequencial da transação (somente quando houver recorrência) |
valor | Number(15,2) | Valor bruto da transação |
valorLiquido | Number(15,2) | Valor da transação descontadas as tarifas incidentes sobre a mesma |
tarifa | Number(15,2) | Valor a ser descontado sobre o valor bruto da transação, de acordo com o plano do cliente |
endereco | Objeto Endereço | Endereço do pagador |
cartao | String(16) | Número do cartão truncado, seguro para exibição |
autorizacao | String(20) | Código de autorização retornado pela processadora de cartão |
modalidade | String(3) | Modalidade de pagamento (CRE) |
qtdeParcelas | Number(2) | Número de parcelas (valor entre 1 e 12) |
dataHora | String ??? | Timestamp representando a data e hora da geração da transação |
bandeira | Number(3) | Identificação da bandeira do cartão (ver códigos na tabela de valores) |
Cartão de crédito com token
Cria uma transação com cartão de crédito baseado em um cartão de crédito previamente salvo em uma wallet, utilizando um token de pagamento ao invés dos dados do cartão de crédito. O token do cartão de crédito é obtido através do endpoint descrito na seção [wallet].
curl -X POST https://api.aixmobil.com/api/transacoes/token \
-H "Content-Type: application/json" \
-H "SessionId: [B@459fecb0" \
-d '{
"tokenCartao": "348ec502-3cc7-4d48-8873-2b64e3b7bbd9",
"valor": 123.45,
"parcelas": 1,
"seuNumero": 123456,
"cpfCnpjPortador": "11111111111",
"dataNascimento": "1978-03-07",
"telefone": 5199998877,
"email": "carlos.aragao@dominio.com.br",
"splitConfig": "CFG_0001",
"endereço": {
"logradouro": "Rua dos Atores",
"numero": "123",
"complemento": "Ap. 201 / BL A",
"bairro": "Higienópolis",
"cidade": "Paraíso do Sul",
"estado": "RS",
"cep": "90000000"
}
}'
Requisição HTTP
POST https://api.aixmobil.com/api/transacoes/token
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Payload da requisição
Objeto Endereço
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
logradouro | String(120) | Sim | |
numero | String(10) | Não | |
complemento | String(30) | Não | |
cep | String(8) | Sim | CEP contendo apenas números |
bairro | String(40) | Sim | |
cidade | String(60) | Sim | |
estado | String(2) | Sim | Sigla do estado |
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idCliente | String(40) | Não | Identificação do cliente (subconta) na plataforma AixMobil. Se não for informado, assume-se que a transação está relacionada ao cliente logado na sessão. É obrigatório se o usuário logado for uma conta master. |
tokenCartao | String(80) | Sim | Token do cartão na wallet que substitui os dados do cartão. |
valor | Number(15,2) | Sim | Valor da transação no formato ######.## (usar "." Como separador decimal) |
parcelas | Number(2) | Sim | Número de parcelas (valor entre 1 e 12) |
seuNumero | String(30) | Não | Campo livre para identificação interna do cliente |
cpfCnpjPortador | String(14) | Sim | CPF/CNPJ do pagador (apenas números) |
telefone | Number(11) | Não | Número de telefone do pagador (apenas números) |
String(120) | Não | E-mail do pagador. Utilizado para o envio do recibo da transação, caso o cliente esteja configurado para receber recibos por e-mail quando a transação é aprovada. | |
dadosAdicionais | String(120) | Não | Campo livre para inclusão de dados adicionais da transação. Conteúdo é exibido no recibo da transação. |
dataNascimento | Date | Não | Data de nascimento do pagador no formato AAAA-MM-DD. É obrigatório apenas se o cliente estiver configurado para ter os CPFs das transações validados na Receita Federal. |
urlCallback | String(240) | Não | A plataforma faz uma requisição GET para a URL informada retornando as propriedades idTransacao , tokenCartao e seuNumero na querystring. Esta URL só é chamada se a cobrança for realizada de forma agendada, como uma cobrança no crédito utilizando o token do cartão ou nos pagamentos de débito ou boleto. |
splitConfig | String(20) | Não | Código da configuração do split cadastrado pelo cliente que indica como será o split da transação entre outros clientes |
endereco | Objeto endereço | Não | Endereço do pagador |
nomeFantasia | String(11) | Não | Nome que aparecerá na fatura do cartão, após o nome "AIXMOBIL*". Exemplo: AIXMOBIL*LOJAS123. |
Status de retorno
Retorno da requisição:
201 CREATED
{
"sucesso": true,
"codigoStatus": 50203,
"mensagem": "Transação criada com sucesso!",
"idTransacao": 100,
"valorLiquido": 117.28,
"tarifa": 6.17,
"endereço": {
"logradouro": "Rua dos Atores",
"numero": "123",
"complemento": "Ap. 201 / BL A",
"bairro": "Higienópolis",
"cidade": "Paraíso do Sul",
"estado": "RS",
"cep": "90000000"
}
}
Response Status: HTTP_CREATED (201)
Objeto de retorno
Atributo | Tipo | Descrição |
---|---|---|
sucesso | Boolean | Sucesso da requisição |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
tokenCartao | String(80) | Token gerado para o cartão (somente quando houver recorrência) |
sequencial | Number(10) | Número sequencial da transação (somente quando houver recorrência) |
tarifa | Number(15,2) | Valor a ser descontado sobre o valor bruto da transação, de acordo com o plano do cliente |
valorLiquido | Number(15,2) | Valor da transação descontadas as tarifas incidentes sobre a mesma |
endereco | Objeto Endereço | Endereço do pagador |
Cartão de débito
Diferente das transações de crédito, nas operações de débito a criação da transação e autorização ocorrem em momentos distintos.
Esta operação realiza a criação da transação de débito e, ao término desta operação, devolve um link no atributo urlAutenticacao
que precisa ser aberto para o pagador poder confirmar o pagamento através da digitação do código do cartão de débito.
Após a confirmação da senha, a página do banco emissor redireciona o pagador para a página informada no campo urlCallback
da requisição e é a partir deste momento que a consulta da transação pode ser realizada para saber se a autorização ocorreu com sucesso.
Os dados sensíveis do pagamento (número do cartão e data de validade) devem ser encriptados seguindo as instruções do manual de client-side encryption (CSE).
curl -X POST https://api.aixmobil.com/api/transacoes/encryptDebito \
-H "Content-Type: application/json" \
-H "SessionId: [B@459fecb0" \
-d '{
"idCliente": "998877",
"cartao": "[NUMERO_CARTAO_ENCRIPTADO]",
"bandeira": 1,
"portador": "Carlos Aragão",
"validade": "[VALIDADE_ENCRIPTADO]",
"valor": 123.45,
"parcelas": 1,
"seuNumero": "123456",
"cpfCnpjPortador": "11111111111",
"dataNascimento": "1978-03-07",
"telefone": 5199998877,
"email": "carlos.aragao@dominio.com.br",
"dadosAdicionais": "Promoção de Natal",
"urlCallback": "http://www.meusite.com.br/recibo",
"splitConfig": "CFG_0001",
"endereço": {
"logradouro": "Rua dos Atores",
"numero": "123",
"complemento": "Ap. 201 / BL A",
"bairro": "Higienópolis",
"cidade": "Paraíso do Sul",
"estado": "RS",
"cep": "90000000"
},
"checkoutSessionToken": "[TOKEN_SESSAO_RECEBIDO_PELA_LIB_CSE]"
}'
Requisição HTTP
POST https://api.aixmobil.com/api/transacoes/encryptDebito
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Payload da requisição
Objeto Endereço
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
logradouro | String(120) | Sim | |
numero | String(10) | Não | |
complemento | String(30) | Não | |
cep | String(8) | Sim | CEP contendo apenas números |
bairro | String(40) | Sim | |
cidade | String(60) | Sim | |
estado | String(2) | Sim | Sigla do estado |
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idCliente | String(40) | Não | Identificação do cliente (sub-conta) na plataforma AixMobil. Se não for informado, assume-se que a transação está relacionada ao cliente logado na sessão. É obrigatório se o usuário logado for uma conta master. |
cartao | String(512) | Sim | Número do cartão (apenas números) |
bandeira | Number(3) | Sim | Identificação da bandeira do cartão (ver códigos no anexo) |
portador | String(60) | Sim | Nome do portador do cartão |
validade | String(512) | Sim | Validade do cartão no formato MM/AAAA |
valor | Number(15,2) | Sim | Valor da transação no formato ######.## (usar "." Como separador decimal) |
parcelas | Number(2) | Sim | Número de parcelas (valor entre 1 e 12) |
seuNumero | String(30) | Não | Campo livre para identificação interna do cliente |
cpfCnpjPortador | String(14) | Sim | CPF/CNPJ do pagador (apenas números) |
telefone | Number(11) | Não | Número de telefone do pagador (apenas números) |
String(120) | Não | E-mail do pagador. Utilizado para o envio do recibo da transação, caso o cliente esteja configurado para receber recibos por e-mail quando a transação é aprovada. | |
dadosAdicionais | String(120) | Não | Campo livre para inclusão de dados adicionais da transação. Conteúdo é exibido no recibo da transação. |
dataNascimento | Date | Não | Data de nascimento do pagador no formato AAAA-MM-DD. É obrigatório apenas se o cliente estiver configurado para ter os CPFs das transações validados na Receita Federal. |
urlCallback | String(240) | Não | Endereço para onde o pagador será redirecionado ao final da transação. Neste momento já é possível consultar o status da transação e emissão de recibo. Na URL de callback são retornados também os valores dos seguintes atributos: idTransacao , tokenCartao e seuNumero . |
splitConfig | String(20) | Não | Código da configuração do split cadastrado pelo cliente que indica como será o split da transação entre outros clientes |
endereco | Objeto endereço | Não | Endereço do pagador |
nomeFantasia | String(11) | Não | Nome que aparecerá na fatura do cartão, após o nome "AIXMOBIL*". Exemplo: AIXMOBIL*LOJAS123. |
Status de retorno
Retorno da requisição:
201 CREATED
{
"sucesso": true,
"codigoStatus": 50203,
"mensagem": "Transação criada com sucesso!",
"idTransacao": 100,
"urlAutenticacao": "https://ecommerce.cielo.com.br/web/index.cbmp?id=XXX…",
"endereço": {
"logradouro": "Rua dos Atores",
"numero": "123",
"complemento": "Ap. 201 / BL A",
"bairro": "Higienópolis",
"cidade": "Paraíso do Sul",
"estado": "RS",
"cep": "90000000"
}
}
Response Status: HTTP_CREATED (201)
Objeto de retorno
Atributo | Tipo | Descrição |
---|---|---|
sucesso | Boolean | Sucesso da requisição |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
idTransacao | Number(32) | Identificação da transação na plataforma |
urlAutenticacao | String(240) | Endereço para onde o pagador deve ser redirecionado para realizar a autorização da transação. A autorização é feita no ambiente do banco emissor do cartão conforme bandeira selecionada. |
endereco | Objeto Endereço | Endereço do pagador |
Boleto
Cria uma transação cuja forma de pagamento será o Boleto Bancário.
Este serviço realiza o registro do boleto bancário e disponibiliza a imagem do mesmo para ser visualizada/salva através do link retornado no parâmetro urlAutenticacao
.
O acesso ao link de exibição do boleto retornará como não encontrado após seu vencimento ou caso já tenha sido pago.
Consultas de status desta transação retornarão com status Pendente até que seja pago e compensado pela plataforma AixMobil. Após sua compensação, a consulta retornará com o status Aprovado. Caso o boleto não seja pago até o vencimento, o título será baixado e sua consulta retornará com o status Cancelado.
curl -X POST https://api.aixmobil.com/api/transacoes/boleto \
-H "Content-Type: application/json" \
-H "SessionId: [B@459fecb0" \
-d '{
"idCliente": "998877",
"portador": "Carlos Aragão",
"valor": 123.45,
"seuNumero": "123456",
"cpfCnpjPortador": "11111111111",
"dataNascimento": "1978-03-07",
"telefone": 5199998877,
"email": "carlos.aragao@dominio.com.br",
"dataLimite": "2018-02-20",
"tipoTitulo": "DS",
"dadosAdicionais": "NÃO RECEBER APÓS O VENCIMENTO.",
"splitConfig": "CFG_0001",
"endereço": {
"logradouro": "Rua dos Atores",
"numero": "123",
"complemento": "Ap. 201 / BL A",
"bairro": "Higienópolis",
"cidade": "Paraíso do Sul",
"estado": "RS",
"cep": "90000000"
}
}'
Requisição HTTP
POST https://api.aixmobil.com/api/transacoes/boleto
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Payload da requisição
Objeto Endereço
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
logradouro | String(120) | Sim | |
numero | String(10) | Não | |
complemento | String(30) | Não | |
cep | String(8) | Sim | CEP contendo apenas números |
bairro | String(40) | Sim | |
cidade | String(60) | Sim | |
estado | String(2) | Sim | Sigla do estado |
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idCliente | String(40) | Não | Identificação do cliente (subconta) na plataforma AixMobil. Se não for informado, assume-se que a transação está relacionada ao cliente logado na sessão. É obrigatório se o usuário logado for uma conta master. |
portador | String(60) | Sim | Nome do pagador |
valor | Number(15,2) | Sim | Valor da transação no formato ######.## (usar "." Como separador decimal) |
seuNumero | String(30) | Não | Campo livre para identificação interna do cliente |
cpfCnpjPortador | String(14) | Sim | CPF/CNPJ do pagador (apenas números) |
dataNascimento | Date | Não | Data de nascimento do pagador no formato AAAA-MM-DD. É obrigatório apenas se o cliente estiver configurado para ter os CPFs das transações validados na Receita Federal. |
telefone | Number(11) | Não | Número de telefone do pagador (apenas números) |
String(120) | Não | E-mail do pagador. Utilizado para o envio do recibo da transação, caso o cliente esteja configurado para receber recibos por e-mail quando o boleto é compensado. | |
dataLimite | Date | Não Default (D+10) |
Data de validade do boleto no formato AAAA-MM-DD |
tipoTitulo | String(3) | Sim | Ver tabela Espécie Título |
dadosAdicionais | String(120) | Não | Campo livre para inclusão de dados adicionais na transação. É exibido na área de instruções de pagamento do boleto. |
splitConfig | String(20) | Não | Código da configuração do split cadastrado pelo cliente que indica como será o split da transação entre outros clientes |
endereco | Objeto endereço | Sim | Endereço do pagador |
Status de retorno
Retorno da requisição:
201 CREATED
{
"sucesso": true,
"codigoStatus": 50203,
"mensagem": "Transação criada com sucesso!",
"idTransacao": 100,
"urlAutenticacao": "https://ecommerce.cielo.com.br/web/index.cbmp?id=XXX…",
"endereço": {
"logradouro": "Rua dos Atores",
"numero": "123",
"complemento": "Ap. 201 / BL A",
"bairro": "Higienópolis",
"cidade": "Paraíso do Sul",
"estado": "RS",
"cep": "90000000"
}
}
Response Status: HTTP_CREATED (201)
Objeto de retorno
Atributo | Tipo | Descrição |
---|---|---|
sucesso | Boolean | Sucesso da requisição. Neste momento o boleto é registrado e a transação permanece com status Pendente |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
idTransacao | Number(32) | Identificação da transação na plataforma |
endereco | Objeto Endereço | Endereço do pagador |
Transações - Consultas
Consulta de transações
Consulta transações por intervalo de data.
curl -X GET https://api.aixmobil.com/api/transacoes?dataInicio=2016-01-01&dataFim=2016-01-31 \
-H "Content-Type: application/json" \
-H "SessionId: [B@459fecb0"
Requisição HTTP
GET https://api.aixmobil.com/api/transacoes
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Parâmetros da QueryString
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
dataInicio | Date | Sim | Data inicial para consulta das transações no formato AAAA-MM-DD |
dataFim | Date | Sim | Data final para consulta das transações no formato AAAA-MM-DD |
cpfCnpj | String(14) | Não | CPF/CNPJ do cliente |
seuNumero | String(30) | Não | Código de identificação interno utilizado na geração da transação |
numeroPedido | String(30) | Não | Código de identificação interno utilizado na geração da transação. Se informado, este número deve ser único entre as transações aprovadas do cliente. |
tokenCheckout | String(80) | Não | Token de checkout para a qual a transação está sendo paga. Ver seção [Criação de checkout] |
tokenCartao | String(80) | Não | Token do cartão de crédito utilizado no pagamento, se aplicável |
idModalidade | String(3) | Não | Modalidade de pagamento (CRE/DEV/BLQ). |
pagina | Number | Não | Número da página que deseja consultar |
qtdeRegistros | Number | Não | Número de registros que deseja receber para cada consulta. Valor não deve ser superior a 100. Se não for informado será considerado 100 registros. |
Status de retorno
Retorno da requisição:
200 OK
{
"sucesso": true,
"codigoStatus": 200,
"mensagem": "OK",
"transacoes": [
{
"idCliente": "fabio@aixmobil.com",
"idTransacao": 100,
"data": "2016-01-23",
"bandeira": 1,
"portador": "Jorge Simons",
"valor": 123.45,
"valorLiquido": 117.28,
"tarifa": 6.17,
"seuNumero": "123456",
"cpfCnpjPortador": "11111111111",
"telefone": 5199998877,
"email": "jorge@gmail.com.br",
"dadosAdicionais": "",
"statusTransacao": "A",
"idModalidade": "CRE"
},
{
"idCliente": "fabio@aixmobil.com",
"idTransacao": 101,
"data": "2016-01-23",
"bandeira": 2,
"portador": "Fernando Dantas",
"valor": 543.21,
"valorLiquido": 516.05,
"tarifa": 27.16,
"seuNumero": "654321",
"statusTransacao": "A",
"idModalidade": "CRE"
},
{
"idCliente": "fabio@aixmobil.com",
"idTransacao": 101,
"data": "2016-01-23",
"bandeira": 2,
"portador": "Frederico Neto",
"valor": 543.21,
"valorLiquido": 516.05,
"tarifa": 27.16,
"seuNumero": "654321",
"cpfCnpjPortador": "22222222222",
"telefone": 5133334455,
"email": "fred.neto@hotmail.com",
"dadosAdicionais": "",
"statusTransacao": "A",
"idModalidade": "CRE"
}
]
}
Response Status: HTTP_OK (200)
Objeto de retorno
Objeto Transação
Atributo | Tipo | Descrição |
---|---|---|
idCliente | String(80) | E-mail ou username (se o usuário foi criado pela API) do usuário da conta cadastrada na plataforma |
idTransacao | Number(32) | Identificação da transação na plataforma |
data | Date | Data da geração da transação |
bandeira | Number(3) | Identificação da bandeira do cartão (ver códigos na tabela de valores) |
portador | String(60) | Nome do portador do cartão |
valor | Number(15,2) | Valor da transação no formato ######.## (usar "." Como separador decimal) |
valorLiquido | Number(15,2) | Valor da transação descontadas as tarifas incidentes sobre a mesma |
tarifa | Number(15,2) | Valor a ser descontado sobre o valor bruto da transação, de acordo com o plano do cliente |
seuNumero | String(30) | Campo livre para identificação interna do cliente |
cpfCnpjPortador | String(14) | CPF/CNPJ do pagador informado na transação |
telefone | Number(11) | Número de telefone informado na transação |
String(120) | E-mail informado na transação | |
dadosAdicionais | String(120) | Valor informado na transação |
statusTransacao | String(1) | Código do status da transação (ver códigos na tabela de valores) |
idModalidade | String(3) | Modalidade de pagamento (CRE/DEV/BLQ) |
retornoAutorizacao | String(512) | Descrição retornada pelo autorizador na tentativa de aprovar a transação. |
Atributo | Tipo | Descrição |
---|---|---|
sucesso | Boolean | Sucesso da requisição |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
transacoes | Array |
Lista de transações que atendem aos critérios solicitados |
Consulta de detalhe
Consulta os detalhes de uma transação.
curl -X GET https://api.aixmobil.com/api/transacoes/100 \
-H "Content-Type: application/json" \
-H "SessionId: [B@459fecb0"
Requisição HTTP
GET https://api.aixmobil.com/api/transacoes/{idTransacao}
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Parâmetros da URL
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idTransacao | Number(32) | Sim | Identificação da transação na plataforma |
Status de retorno
Retorno da requisição:
200 OK
{
"sucesso": true,
"codigoStatus": 200,
"mensagem": "OK",
"statusTransacao": "A",
"statusParcela": {
"parcela_1": "P"
},
"valor": 123.12,
"valorLiquido": 118.14,
"tarifa": 4.98,
"cartao": "123456******7890",
"autorizacao": "12345678",
"modalidade": "CRE",
"qtdeParcelas": 1,
"dataHora": 1541595588912,
"bandeira": 1,
"dataPagamento": "2018-10-30"
}
Response Status: HTTP_OK (200)
Objeto de retorno
Atributo | Tipo | Descrição |
---|---|---|
sucesso | Boolean | Sucesso da requisição |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
statusTransacao | String(1) | Código do status da transação (ver códigos na tabela de valores) |
statusParcela | Objeto com status de cada parcela da transação (ver códigos na tabela de valores) | |
valor | Number(15,2) | Valor bruto da transação |
valorLiquido | Number(15,2) | Valor da transação descontadas as tarifas incidentes sobre a mesma |
tarifa | Number(15,2) | Valor a ser descontado sobre o valor bruto da transação, de acordo com o plano do cliente |
cartao | String(16) | Número do cartão truncado, seguro para exibição |
autorizacao | String(20) | Código de autorização retornado pela processadora de cartão |
modalidade | String(3) | Modalidade de pagamento (CRE) |
qtdeParcelas | Number(2) | Número de parcelas (valor entre 1 e 12) |
dataHora | Timestamp | Timestamp representando a data e hora da geração da transação |
bandeira | Number(3) | Identificação da bandeira do cartão (ver códigos na tabela de valores) |
dataPagamento | String | Data que o pagamento foi realizado no formato AAAA-MM-DD |
Consulta de detalhe de pagamento
Consulta os detalhes de pagamento de uma transação.
curl -X GET https://api.aixmobil.com/api/transacoes/100/pagamentos \
-H "Content-Type: application/json" \
-H "SessionId: [B@459fecb0"
Requisição HTTP
GET https://api.aixmobil.com/api/transacoes/{idTransacao}/pagamentos
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Parâmetros da URL
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idTransacao | Number(32) | Sim | Identificação da transação na plataforma |
Status de retorno
Retorno da requisição:
200 OK
{
"sucesso": true,
"codigoStatus": 200,
"mensagem": "OK",
"statusTransacao": "A",
"pagamentos": [
{
"nroParcela": 1,
"statusLiquidacao": "N",
"dataLiquidacao": "2016-02-24",
"valor": 260.33
},
{
"nroParcela": 2,
"statusLiquidacao": "N",
"dataLiquidacao": "2016-03-23",
"valor": 260.33
}
],
"cartao": "123456******7890",
"autorizacao": "12345678",
"modalidade": "CRE",
"qtdeParcelas": 1,
"dataHora": 1541595588912,
"bandeira": 1
}
Response Status: HTTP_OK (200)
Objeto de retorno
Objeto Pagamento
Atributo | Tipo | Descrição |
---|---|---|
nroParcela | Number | Número da parcela |
statusLiquidacao | String(1) | Código do status da liquidação (ver códigos na tabela de valores) |
dataLiquidacao | Date | Data da liquidação |
valor | Number(15,2) | Valor liquido da parcela |
Atributo | Tipo | Descrição |
---|---|---|
sucesso | Boolean | Sucesso da requisição |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
statusTransacao | String(1) | Código do status da transação (ver códigos na tabela de valores) |
pagamentos | Array |
Lista de pagamentos da transação |
cartao | String(16) | Número do cartão truncado, seguro para exibição |
autorizacao | String(20) | Código de autorização retornado pela processadora de cartão |
modalidade | String(3) | Modalidade de pagamento (CRE) |
qtdeParcelas | Number(2) | Número de parcelas (valor entre 1 e 12) |
dataHora | Timestamp | Timestamp representando a data e hora da geração da transação |
bandeira | Number(3) | Identificação da bandeira do cartão (ver códigos na tabela de valores) |
Transações - Cancelamento
Cancelamento de transação
Cancela uma transação de pagamento.
curl -X DELETE https://api.aixmobil.com/api/transacoes/100 \
-H "Content-Type: application/json" \
-H "SessionId: [B@459fecb0"
Requisição HTTP
DELETE https://api.aixmobil.com/api/transacoes/{idTransacao}
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Parâmetros da URL
Atributo | Tipo | Descrição |
---|---|---|
idTransacao | Number(32) | Identificação da transação na plataforma |
Status de retorno
Retorno da requisição:
200 OK
{
"sucesso": true,
"codigoStatus": 50202,
"mensagem": "Transação cancelada com sucesso!"
}
Response Status: HTTP_OK (200)
Objeto de retorno
Atributo | Tipo | Descrição |
---|---|---|
sucesso | Boolean | Sucesso da requisição |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
Cancelamento de recorrência
Cancela a recorrência da cobrança, assim como o pagamento ou pagamentos pendentes que foram gerados para as próximas cobranças.
curl -X DELETE https://api.aixmobil.com /api/transacoes/token \
-H "Content-Type: application/json" \
-H "SessionId: [B@459fecb0" \
-d '{
"tokenCartao": "348ec502-3cc7-4d48-8873-2b64e3b7bbd9"
}'
Requisição HTTP
DELETE https://api.aixmobil.com/api/transacoes/token
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Payload da requisição
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
tokenCartao | String(80) | Sim | Token gerado para o cartão na criação da transação com recorrência ad-hoc (cartão de crédito com token) |
Status de retorno
Retorno da requisição:
200 OK
{
"sucesso": true,
"codigoStatus": 30004,
"mensagem": "Cobrança cancelada com sucesso!"
}
Response Status: HTTP_OK (200)
Objeto de retorno
Atributo | Tipo | Descrição |
---|---|---|
sucesso | Boolean | Sucesso da requisição |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
Checkout
Um checkout é uma cobrança que pode ser previamente configurada e associada a um cliente que receberá os pagamentos associados ao checkout.
Criação de checkout
Ao criar uma cobrança é possível associar um valor a ser cobrado e dessa forma todos os pagamentos efetuados para este checkout serão baseados no valor informado ou o valor pode ser deixado em aberto em sua criação para que na hora do pagamento o pagador defina o valor a ser pago (uma doação, por exemplo).
Pode-se também criar o checkout específico para um pagador, informando dados como o nome, CPF/CNPJ, telefone, ou e-mail do pagador, ou deixar que o checkout possa ser pago por qualquer pessoa com acesso ao link do formulário de pagamento.
A plataforma da AixMobil disponibiliza uma página segura com o formulário gerado de acordo com o código de checkout informado na URL e que pode ser compartilhada para que os pagadores efetuem os pagamentos.
curl -X POST https://api.aixmobil.com/api/checkout \
-H "Content-Type: application/json" \
-H "SessionId: [B@459fecb0" \
-d '{
"idCliente": "998877",
"seuNumero": "1001",
"descricao": "Pagamento documento 1001",
"nomeConsumidor": "Carlos Menezes",
"tipoPessoaConsumidor": "F",
"cpfCnpjConsumidor": "11111111111",
"dataNascimentoConsumidor": "1988-01-31",
"telefoneConsumidor": "5199998877",
"emailConsumidor": "carlos.menezes@gmail.com ",
"valorAdicional": -8.50,
"urlCallback": "http://meusite.meudominio.com.br/pagamentos",
"itens":[
{
"codigo":"00001",
"descricao": "Produto 1",
"valorUnitario": 50.25,
"quantidade": 2
}
]
}'
Requisição HTTP
POST https://api.aixmobil.com/api/checkout
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Payload da requisição
Objeto Item
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
codigo | String(120) | Não | Código do item |
descricao | String(10) | Sim | Descrição do item que aparecerá discriminado na cobrança |
valorUnitario | Number(15,2) | Sim | Valor unitário do item utilizado para o cálculo total da cobrança |
quantidade | String(10) | Sim | Quantidade de itens |
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idCliente | String(40) | Não | Identificação do cliente na plataforma AixMobil. Se não for informado, assume-se que a transação está relacionada ao cliente logado na sessão. |
seuNumero | String(30) | Não | Campo livre para identificação interna do cliente |
descricao | String(120) | Não | Campo livre para inclusão de dados adicionais da transação |
nomeConsumidor | String(60) | Não | Nome / Razão Social do consumidor (pagador) |
tipoPessoaConsumidor | String(1) | Não | Tipo do pagador "F" (pessoa física) "J" (pessoa jurídica) |
cpfCnpjPortador | String(14) | Sim | CPF/CNPJ do pagador (apenas números) |
dataNascimentoConsumidor | Date | Não | Data de nascimento do pagador no formato AAAA-MM-DD. Para Pessoa Jurídica pode ser informado a data de fundação da empresa. |
telefoneConsumidor | Number(11) | Não | Número de telefone do pagador (apenas números) |
emailConsumidor | String(120) | Não | E-mail do pagador |
urlCallback | String(240) | Não | A plataforma faz uma requisição GET para a URL informada retornando as propriedades idTransacao , tokenCartao e seuNumero na querystring. Esta URL só é chamada se a cobrança for realizada de forma agendada, como uma cobrança no crédito utilizando o token do cartão ou nos pagamentos de débito ou boleto. |
valor | Number(15,2) | Não | Valor da cobrança no formato ######.## (usar "." Como separador decimal). Caso o pedido possua itens, esta informação será desconsiderada e o valor será calculado com base na soma do valor dos itens. |
valorAdicional | Number(15,2) | Não | Valor de acréscimo ou desconto (incluir o sinal de '-' antes do valor) a ser concedido sobre o valor da cobrança. |
itens | Array |
Não | Lista de itens que compões a cobrança, caso se opte por discriminar a composição da cobrança. O valor total da cobrança será o somatório das quantidades x valores unitários dos itens. Após este cálculo será aplicado o acréscimo/desconto informado no atributo valorAdicional . |
quantidadeUtilizacao | Number(2) | Não | Quantidade máxima de vezes que o checkout pode ser pago. Não será validado se este atributo for omitido. |
validade | Date | Não | Data limite para que o formulário de checkout possa ser visualizado e pago. Não será validado se este atributo for omitido. |
Status de retorno
Retorno da requisição:
201 CREATED
{
"sucesso": true,
"codigoStatus": 80001,
"mensagem": "Checkout salvo com sucesso",
"checkoutToken": "cfcda64c-1a1b-464f-baf1-a629c7d36a85"
}
Response Status: HTTP_CREATED (201)
Objeto de retorno
Atributo | Tipo | Descrição |
---|---|---|
sucesso | Boolean | Sucesso da requisição |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
tokenCheckout | String(40) | Token do checkout criado para montar o formulário de pagamentos |
Visualizando o formulário de checkout
Abrir o navegador e digitar a URL abaixo, substituindo o parâmetro hostName
pela URL de Testes ou Produção e o parâmetro tokenCheckout
pelo token recebido no retorno de sua criação.
{hostName}/#/checkout/{tokenCheckout}
Host de testes: https://dev.aixmobil.com
Host de produção: https://payment.aixmobil.com
Wallet
Utilizando a API de integração da AixMobil é possível gerenciar carteiras digitais (wallets) para os consumidores poderem armazenar de forma segura um ou mais cartões de créditos para serem utilizados em futuras transações sem precisar digitar todos os dados do cartão.
Vale lembrar que a AixMobil não retém dados dos cartões de créditos de seus clientes ou consumidores (clientes dos clientes).
Desta forma, cada cartão de crédito armazenando na wallet possui um token correspondente que é enviado para as bandeiras processarem a transação ao invés de solicitar novamente dos consumidores os dados do cartão, gerando muito mais segurança dos dados e praticidade no momento do pagamento.
Consultar tokens de cartões de crédito de um consumidor
Consulta todos os tokens cartões de crédito de um consumidor, restritos ao cliente logado.
curl -X GET https://api.aixmobil.com/api/encryptCartao \
-H "Content-Type: application/json" \
-H "SessionId: [B@459fecb0" \
Requisição HTTP
GET https://api.aixmobil.com/api/encryptCartao?cpfCnpj=61981289038
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Parâmetros da QueryString
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
cpfCnpj | String(14) | Sim | CPF/CNPJ do consumidor (apenas números) |
Status de retorno
Retorno da requisição:
200 OK
{
"sucesso": true,
"codigoStatus": 15001,
"mensagem": "Cartão salvo com sucesso!",
"cartoes": [
{
"bandeira": 1,
"portador": "Jorge da Silva",
"validade": "12/2022",
"cpfCnpjPortador": "61981289038",
"tokenCartao": "a2d9eaec-76c9-491a-8bdf-949d7ba81632"
}
]
}
Response Status: HTTP_OK (200)
Objeto de retorno
Objeto Cartão
Atributo | Tipo | Descrição |
---|---|---|
bandeira | Number(3) | Identificação da bandeira do cartão (ver códigos na tabela de valores) |
portador | String(60) | Nome do portador do cartão |
validade | String(512) | Validade do cartão no formato MM/AAAA |
cpfCnpjPortador | String(14) | CPF/CNPJ do consumidor (apenas números) |
tokenCartao | String(80) | Token do cartão |
Atributo | Tipo | Descrição |
---|---|---|
sucesso | Boolean | Sucesso da requisição |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
cartoes | Array |
Lista de tokens dos cartões do consumidor |
Adicionar um cartão de crédito
Adiciona um novo cartão de crédito na wallet do pagador.
Os dados sensíveis do cartão (número do cartão, data de validade e CVV) devem ser encriptados seguindo as instruções do manual de client-side encryption (CSE).
curl -X POST https://api.aixmobil.com/api/encryptCartao \
-H "Content-Type: application/json" \
-H "SessionId: [B@459fecb0" \
-d '{
"idCliente": "998877",
"cartao": "[NUMERO_CARTAO_ENCRIPTADO]",
"portador": "Fulano de Tal",
"cvv": "[CVV_ENCRIPTADO]",
"validade": "[VALIDADE_ENCRIPTADO]",
"cpfCnpjPortador": "11111111111",
"checkoutSessionToken": "[TOKEN_SESSAO_RECEBIDO_PELA_LIB_CSE]"
}'
Requisição HTTP
POST https://api.aixmobil.com/api/encryptCartao
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Payload da requisição
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idCliente | String(40) | Não | Identificação do cliente na plataforma AixMobil. Se não for informado, assume-se que a transação está relacionada ao cliente logado na sessão. |
cartao | String(512) | Sim | Número do cartão (apenas números) |
bandeira | Number(3) | Sim | Identificação da bandeira do cartão (ver códigos na tabela de valores) |
portador | String(60) | Sim | Nome do portador do cartão |
cvv | String(512) | Sim | CVV do cartão |
validade | String(512) | Sim | Validade do cartão no formato MM/AAAA |
cpfCnpjPortador | String(14) | Sim | CPF/CNPJ do pagador (apenas números) |
Status de retorno
Retorno da requisição:
201 CREATED
{
"sucesso": true,
"codigoStatus": 15001,
"mensagem": "Cartão salvo com sucesso!",
"tokenCartao": "5a6ee250-26eb-44af-a8c0-bf0f30c66a08",
"cartao": "448583******5451",
"validade": "11/2021"
}
Response Status: HTTP_CREATED (201)
Objeto de retorno
Atributo | Tipo | Descrição |
---|---|---|
sucesso | Boolean | Sucesso da requisição |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
tokenCartao | String(80) | Token gerado para o cartão |
cartao | String | Número truncado do cartão |
validade | String | Data de validade do cartão |
Excluir um cartão de crédito
Exclui um cartão de crédito da wallet do pagador.
curl -X DELETE https://api.aixmobil.com/api/encryptCartao \
-H "Content-Type: application/json" \
-H "SessionId: [B@459fecb0" \
-d '{
"tokenCartao": "348ec502-3cc7-4d48-8873-2b64e3b7bbd9"
}'
Requisição HTTP
DELETE https://api.aixmobil.com/api/encryptCartao
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Payload da requisição
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
tokenCartao | String(80) | Sim | Token do cartão |
Status de retorno
Retorno da requisição:
200 CREATED
{
"sucesso": true,
"codigoStatus": 30004,
"mensagem": "Cartão excluído com sucesso!"
}
Response Status: HTTP_OK (200)
Objeto de retorno
Atributo | Tipo | Descrição |
---|---|---|
sucesso | Boolean | Sucesso da requisição |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
Clientes (sub-contas)
Dentro da plataforma AixMobil, um cliente pode estar cadastrado como um cliente final, que recebe pagamentos, por exemplo, ou pode agir como um revendedor, intermediando outros clientes, também conhecidos como sub-contas.
Criação de cliente
Cria uma sub-conta de cliente vinculada a uma conta "master".
curl -X POST https://api.aixmobil.com/api/clientes \
-H “Content-Type: application/json” \
-H “SessionId: [B@459fecb0” \
-d '{
"tipoPessoa": "J",
"nomeCliente": "ACME LTDA",
"nomeFantasia": "ACME",
"cpfCnpj": "55426392000147",
"dataNascimento": "1980-01-01",
"telefone": "5121215200",
"endereco": {
"logradouro": "Rua das Laranjeiras",
"numero": "123",
"bairro": "Centro ",
"cidade": "Porto Alegre",
"estado": "RS",
"cep": "90001001"
},
"conta": {
"tipo": "C",
"banco": "001",
"agencia": "1234",
"numero": "123456-7"
}
}'
Requisição HTTP
POST https://api.aixmobil.com/api/clientes
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Payload da requisição
Objeto Endereço
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
logradouro | String(120) | Sim | |
numero | String(10) | Não | |
complemento | String(30) | Não | |
cep | String(8) | Sim | CEP contendo apenas números |
bairro | String(40) | Sim | |
cidade | String(60) | Sim | |
estado | String(2) | Sim | Sigla do estado |
Objeto Conta
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
tipo | String(120) | Sim | Tipo da conta "C" (conta corrente) "P" (conta poupança) |
banco | Sim | número do banco | |
agência | Sim | Código da agência, com dígito opcional separado por "-" | |
número | Sim | Número da conta, com dígito opcional separado por "-" | |
Objeto Cliente
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
tipoPessoa | String(1) | Sim | Tipo do cliente "F" (pessoa física) "J" (pessoa jurídica) |
nomeCliente | String(80) | Sim | Nome / Razão Social do cliente |
nomeFantasia | String(80) | Não | Nome fantasia |
cpfCnpj | String(14) | Sim | CPF/CNPJ do cliente (apenas números) |
dataNascimento | Date | Sim | Data de nascimento do cliente no formato AAAA-MM-DD. Para Pessoa Jurídica pode ser informado a data de fundação da empresa. |
rg | String(14) | Não | Número do documento de identificação |
orgaoExpedidor | String(10) | Não | Órgão expedidor do documento de identificação |
telefone | Number(11) | Sim | Número de telefone do cliente (apenas números) |
String(120) | Sim | E-mail de contato | |
endereco | Objeto endereço | Sim | Endereço do cliente |
conta | Objeto conta | Não | Conta corrente do cliente |
saqueAutomatico | Boolean | Não Default: copia a configuração do cliente que está realizando a operação |
True/False indicando se os valores disponíveis deverão ser transferidos automaticamente para a conta bancária cadastrada. |
taxaComissao | Number(4,2) | Não Default: copia a configuração do cliente que está realizando a operação |
% da transação a ser repassada à conta "master" |
tarifaComissao | Number(4,2) | Não Default: copia a configuração do cliente que está realizando a operação |
Valor em Reais a ser repassada à conta "master" |
Status de retorno
Retorno da requisição:
201 CREATED
{
"sucesso": true,
"codigoStatus": 10001,
"mensagem": "Cliente salvo com sucesso!",
"idCliente": "4847315f-dda6-4d4d-97ab-68d721c659e3",
"chaveCliente": "q1i8g9rsnhaxtklu302p"
}
Response Status: HTTP_CREATED (201)
Objeto de retorno
Atributo | Tipo | Descrição |
---|---|---|
sucesso | Boolean | Sucesso da requisição |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
idCliente | String(40) | Identificação do cliente na plataforma |
chaveCliente | String(40) | Senha de acesso do cliente |
Consulta clientes
Consulta clientes vinculados a uma conta "master".
curl -X GET https://api.aixmobil.com/api/clientes \
-H "Content-Type: application/json" \
-H "SessionId: [B@459fecb0"
Requisição HTTP
GET https://api.aixmobil.com/api/clientes
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Status de retorno
Retorno da requisição:
200 OK
{
"sucesso": true,
"clientes": [
{
"idCliente": "4847315f-dda6-4d4d-97ab-68d721c659e3",
"nomeCliente": "ACME LTDA",
"status": "A"
}
]
}
Response Status: HTTP_OK (200)
Objeto de retorno
Objeto Cliente
Atributo | Tipo | Descrição |
---|---|---|
idCliente | String(40) | Identificação do cliente na plataforma |
nomeCliente | String(80) | Nome / Razão Social do cliente |
Atributo | Tipo | Descrição |
---|---|---|
sucesso | Boolean | Sucesso da requisição |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
clientes | Lista |
Clientes consultados |
Consulta detalhe de cliente
Consulta detalhe de cliente vinculado a uma conta "master".
curl -X GET https://api.aixmobil.com/api/clientes/4847315f-dda6-4d4d-97ab-68d721c659e3 \
-H "Content-Type: application/json" \
-H "SessionId: [B@459fecb0"
Requisição HTTP
GET https://api.aixmobil.com/api/clientes/{idCliente}
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Parâmetros da URL
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idCliente | String(40) | Sim | Identificação do cliente na plataforma |
Status de retorno
Retorno da requisição:
200 OK
{
"sucesso": true,
"cliente": {
"tipoPessoa": "J",
"nomeCliente": "ACME LTDA",
"nomeFantasia": "ACME",
"cpfCnpj": "55426392000147",
"dataNascimento": "1980-01-01",
"saqueAutomatico": true,
"endereco": {
"logradouro": "Rua das Laranjeiras",
"numero": "123",
"bairro": "Centro",
"cidade": "Porto Alegre",
"estado": "RS",
"cep": "90001001"
},
"conta": {
"tipo": "C",
"banco": "001",
"agencia": "1234",
"numero": "123456-7",
"status": "P"
},
"status": "A",
"dataCriacao": "2018-05-08",
"saldo": 0,
"disponivelSaque": 0
}
}
Response Status: HTTP_OK (200)
Objeto de retorno
Objeto Endereço
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
logradouro | String(120) | Sim | |
numero | String(10) | Não | |
complemento | String(30) | Não | |
cep | String(8) | Sim | CEP contendo apenas números |
bairro | String(40) | Sim | |
cidade | String(60) | Sim | |
estado | String(2) | Sim | Sigla do estado |
Objeto Conta
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
tipo | String(120) | Sim | Tipo da conta "C" (conta corrente) "P" (conta poupança) |
banco | Sim | número do banco | |
agência | Sim | Código da agência, com dígito opcional separado por "-" | |
número | Sim | Número da conta, com dígito opcional separado por "-" | |
Objeto Cliente
Atributo | Tipo | Descrição |
---|---|---|
tipoPessoa | String(1) | Tipo do cliente "F" (pessoa física) "J" (pessoa jurídica) |
nomeCliente | String(80) | Nome / Razão Social do cliente |
nomeFantasia | String(80) | Nome fantasia |
cpfCnpj | String(14) | CPF/CNPJ do cliente (apenas números) |
dataNascimento | Date | Data de nascimento do cliente no formato AAAA-MM-DD. Para Pessoa Jurídica retorna a data de fundação da empresa. |
telefone | Number(11) | Número de telefone do cliente (apenas números) |
String(120) | E-mail de contato | |
endereco | Objeto endereço | Endereço do cliente |
conta | Objeto conta | Conta corrente do cliente |
saqueAutomatico | Boolean | True/False indicando se os valores disponíveis deverão ser transferidos automaticamente para a conta bancária cadastrada. |
taxaComissao | Number(4,2) | % da transação a ser repassada à conta "master" |
tarifaComissao | Number(4,2) | Valor em Reais a ser repassada à conta "master" |
status | String(1) | (ver códigos na tabela de valores) |
dataCriacao | Date | Data da criação da conta no formato AAAA-MM-DD |
saldo | Number(15,2) | Valor total em recebíveis, descontadas as taxas |
disponivelSaque | Number(15,2) | Valor de recebíveis que podem ser transferidos para a conta bancária do cliente |
Atributo | Tipo | Descrição |
---|---|---|
sucesso | Boolean | Sucesso da requisição |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
cliente | Objeto cliente | Cliente consultado |
Adicionar conta bancária
Adiciona uma nova conta bancária a um cliente, que passa a ser a conta ativa para as próximas transações.
curl -X POST https://api.aixmobil.com/api/clientes/4847315f-dda6-4d4d-97ab-68d721c659e3/conta \
-H “Content-Type: application/json” \
-H “SessionId: [B@459fecb0” \
-d '{
"tipo":"C",
"banco":"001",
"agencia":"1234",
"numero":"123456-7"
}'
Requisição HTTP
POST https://api.aixmobil.com/api/clientes/{idCliente}/conta
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Parâmetros da URL
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idCliente | String(40) | Sim | Identificação do cliente na plataforma |
Payload da requisição
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
tipo | String(120) | Sim | Tipo da conta "C" (conta corrente) "P" (conta poupança) |
banco | Sim | número do banco | |
agência | Sim | Código da agência, com dígito opcional separado por "-" | |
número | Sim | Número da conta, com dígito opcional separado por "-" | |
Status de retorno
Retorno da requisição:
201 CREATED
{
"sucesso": true,
"codigoStatus": 11001,
"mensagem": "Conta salva com sucesso!"
}
Response Status: HTTP_CREATED (201)
Objeto de retorno
Atributo | Tipo | Descrição |
---|---|---|
tipoPessoa | String(1) | Tipo do cliente "F" (pessoa física) "J" (pessoa jurídica) |
nomeCliente | String(80) | Nome / Razão Social do cliente |
nomeFantasia | String(80) | Nome fantasia |
cpfCnpj | String(14) | CPF/CNPJ do cliente (apenas números) |
dataNascimento | Date | Data de nascimento do cliente no formato AAAA-MM-DD. Para Pessoa Jurídica retorna a data de fundação da empresa. |
telefone | Number(11) | Número de telefone do cliente (apenas números) |
String(120) | E-mail de contato | |
endereco | Objeto endereço | Endereço do cliente |
conta | Objeto conta | Conta corrente do cliente |
saqueAutomatico | Boolean | True/False indicando se os valores disponíveis deverão ser transferidos automaticamente para a conta bancária cadastrada. |
taxaComissao | Number(4,2) | % da transação a ser repassada à conta "master" |
tarifaComissao | Number(4,2) | Valor em Reais a ser repassada à conta "master" |
status | String(1) | (ver códigos na tabela de valores) |
dataCriacao | Date | Data da criação da conta no formato AAAA-MM-DD |
saldo | Number(15,2) | Valor total em recebíveis, descontadas as taxas |
disponivelSaque | Number(15,2) | Valor de recebíveis que podem ser transferidos para a conta bancária do cliente |
Redefinir senha
Solicita nova senha de acesso do cliente.
curl -X POST https://api.aixmobil.com/api/clientes/4847315f-dda6-4d4d-97ab-68d721c659e3/reset \
-H "Content-Type: application/json" \
-H "SessionId: [B@459fecb0"
Requisição HTTP
POST https://api.aixmobil.com/api/clientes/{idCliente}/reset
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Parâmetros da URL
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idCliente | String(40) | Sim | Identificação do cliente na plataforma |
Status de retorno
Retorno da requisição:
200 OK
{
"sucesso": true,
"codigoStatus": 40002,
"mensagem": "Usuário alterado com sucesso!",
"idCliente": "4847315f-dda6-4d4d-97ab-68d721c659e3",
"chaveCliente": "cmn4gea7i81g9rshkcnl"
}
Response Status: HTTP_OK (200)
Objeto de retorno
Atributo | Tipo | Descrição |
---|---|---|
sucesso | Boolean | Sucesso da requisição |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
idCliente | String(40) | Identificação do cliente na plataforma |
chaveCliente | String(40) | Senha de acesso do cliente |
Saques
Solicitar saque
Solicita a transferência dos valores disponíveis para a conta bancária do cliente. Será criada uma solicitação com o montante total disponível na "Conta Virtual" do cliente.
curl -X POST https://api.aixmobil.com/api/clientes/4847315f-dda6-4d4d-97ab-68d721c659e3/saque \
-H "Content-Type: application/json" \
-H "SessionId: [B@459fecb0"
Requisição HTTP
POST https://api.aixmobil.com/api/clientes/{idCliente}/saque
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Status de retorno
Retorno da requisição:
201 CREATED
{
"sucesso": true,
"idSaque": "33652935-db76-46dd-8992-f421d9f14fa5",
"valor": 85.23,
"tarifa": 8,
"dataCompensacao": "2018-05-11"
}
Response Status: HTTP_CREATED (201)
Objeto de retorno
Atributo | Tipo | Descrição |
---|---|---|
sucesso | Boolean | Sucesso da requisição |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
idSaque | String(40) | Identificação do pedido de saque |
valor | Number(15,2) | Valor a ser creditado na conta bancária do cliente |
tarifa | Number(15,2) | Tarifa cobrada sobre o pedido de saque |
dataCompensacao | Date | Data prevista para crédito na conta bancária no formato AAAA-MM-DD |
Consultar saques
Consulta a lista de saques de um cliente.
curl -X GET https://api.aixmobil.com/api/saque/?dataInicio=2018-12-01&dataFim=2019-01-22 \
-H "Content-Type: application/json" \
-H "SessionId: [B@459fecb0"
Requisição HTTP
GET https://api.aixmobil.com/api/saque/?dataInicio={dataInicio}&dataFim={dataFim}
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Parâmetros da URL
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
dataInicio | Date | Sim | Data de início do filtro para a data do saque no formato AAAA-MM-DD |
dataFim | Date | Sim | Data fim do filtro para a data do saque no formato AAAA-MM-DD |
detalhe | String(1) | Não | Exibe junto com os dados básicos de cada saque os lançamentos que o compõe. |
Status de retorno
Retorno da requisição:
200 OK
{
"sucesso": true,
"codigoStatus": 200,
"mensagem": "OK",
"saques": [
{
"status": "E",
"idSaque": "766362d5-e41a-4d1a-9883-cfdf47effb50",
"valor": 21081.16,
"dataCompensacao": "2019-01-22",
"lancamentos": [
{
"idTransacao": 108961,
"rubrica": "Liquidação Merchand",
"nroParcela": 9,
"valorLiquidacao": 95.18
},
{
"idTransacao": 107508,
"rubrica": "Liquidação Merchand",
"nroParcela": 11,
"valorLiquidacao": 43.54
}
]
},
{
"status": "E",
"idSaque": "4cb88dde-ef50-4673-8fe6-08e2c220a808",
"valor": 372.41,
"dataCompensacao": "2019-01-22",
"lancamentos": [
{
"idTransacao": 108964,
"rubrica": "Liquidação Merchand",
"nroParcela": 9,
"valorLiquidacao": 95.18
},
{
"idTransacao": 107506,
"rubrica": "Liquidação Merchand",
"nroParcela": 11,
"valorLiquidacao": 43.54
}
]
}
]
}
Response Status: HTTP_OK (200)
Objeto de retorno
Objeto Lançamento
Atributo | Tipo | Descrição |
---|---|---|
idTransacao | Number(32) | Identificação da transação na plataforma |
rubrica | String(40) | Descrição do lançamento |
nroParcela | Number | Número da parcela |
valorLiquidacao | Number(15,2) | Valor liquido da parcela |
Objeto Saque
Atributo | Tipo | Descrição |
---|---|---|
status | String(1) | (ver códigos na tabela de valores) |
idSaque | String(40) | Identificação do saque |
valor | Number(15,2) | Valor creditado na conta bancária do cliente |
dataCompensacao | Date | Data cujo valor foi creditado na conta bancária, no formato AAAA-MM-DD |
lancamentos | Array |
Lista de lançamentos de cada saque. |
Atributo | Tipo | Descrição |
---|---|---|
sucesso | Boolean | Sucesso da requisição |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
saques | Array |
Lista de saques |
Consultar detalhe de saque
Consulta os detalhes das operações financeiras que compõe um saque realizado pelo cliente.
curl -X GET https://api.aixmobil.com/api/saque/33652935-db76-46dd-8992-f421d9f14fa5 \
-H "Content-Type: application/json" \
-H "SessionId: [B@459fecb0"
Requisição HTTP
GET https://api.aixmobil.com/api/saque/{idSaque}
Cabeçalho da requisição
Atributo | Valor |
---|---|
Content-Type | application/json |
SessionId | [TOKEN_RETORNADO_NO_LOGIN] |
Parâmetros da URL
Atributo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idSaque | String(40) | Sim | Identificação do pedido de saque |
Status de retorno
Retorno da requisição:
200 OK
{
"sucesso": true,
"codigoStatus": 200,
"mensagem": 'OK',
"status": "S",
"idSaque": "4cb88dde-ef50-4673-8fe6-08e2c220a808",
"valor": 372.41,
"dataCompensacao": "2019-01-22",
"lancamentos": [
{
"idTransacao": 108961,
"rubrica": "LIQM",
"nroParcela": 6,
"valorLiquidacao": 95.11
},
{
"idTransacao": 107508,
"rubrica": "LIQM",
"nroParcela": 8,
"valorLiquidacao": 43.54
},
{
"idTransacao": 107508,
"rubrica": "LIQM",
"nroParcela": 7,
"valorLiquidacao": 43.54
},
{
"idTransacao": 108961,
"rubrica": "LIQM",
"nroParcela": 7,
"valorLiquidacao": 95.11
},
{
"idTransacao": 108961,
"rubrica": "LIQM",
"nroParcela": 5,
"valorLiquidacao": 95.11
}
]
}
Response Status: HTTP_OK (200)
Objeto de retorno
Objeto Lançamento
Atributo | Tipo | Descrição |
---|---|---|
idTransacao | Number(32) | Identificação da transação na plataforma |
rubrica | String(40) | Descrição do lançamento |
nroParcela | Number | Número da parcela |
valorLiquidacao | Number(15,2) | Valor da parcela |
Atributo | Tipo | Descrição |
---|---|---|
sucesso | Boolean | Sucesso da requisição |
codigoStatus | Number(6) | Código de retorno |
mensagem | String(80) | Mensagem de retorno |
status | String(1) | (ver códigos na tabela de valores) |
idSaque | String(40) | Identificação do pedido de saque |
valor | Number(15,2) | Valor creditado na conta bancária do cliente |
dataCompensacao | Date | Data cujo valor foi creditado na conta bancária, no formato AAAA-MM-DD |
lancamentos | Array |
Lista de lançamentos associados |
Tabelas de valores
Bandeiras
Bandeiras associadas à cartões de crédito e débito aceitas na plataforma de pagamento da AixMobil.
Código | Descrição |
---|---|
1 | VISA |
2 | MASTERCARD |
3 | ELO |
4 | DINERS |
5 | AGIPLAN |
6 | BANESCARD |
7 | CREDZ |
8 | CREDSYSTEM |
9 | SOROCRED |
11 | CABAL |
12 | DISCOVERY |
13 | JCB |
14 | HIPERCARD |
Status da transação
Possíves status de uma transação.
Código | Descrição |
---|---|
P | Pendente de aprovação |
A | Aprovada |
N | Negada |
C | Cancelada |
E | Erro |
Status da parcela
Possíves status de uma parcela de uma transação.
Código | Descrição |
---|---|
P | Pendente de liquidação |
G | Pagamento agendado |
L | Liquidada |
C | Cancelada |
E | Erro |
Status do pagamento (liquidação)
Possíves status de uma parcela de uma transação.
Código | Descrição |
---|---|
N | Não liquidado |
V | Disponível na conta virtual |
E | Enviado ao banco para realização de transferência |
L | Liquidado |
S | Saque solicitado |
Tipos de espécie de título (boletos)
Possíves tipos de espécie relacionados a um boleto.
Código | Descrição |
---|---|
DM | Duplicata Mercantil |
DS | Duplicata de Serviço |
ND | Nota de Débito |
REC | Recibo |
Status de cliente
Possíves status de um cliente.
Código | Descrição |
---|---|
P | Pendente de aprovação |
A | Aprovada |
N | Negada |
C | Cancelada |
E | Erro |