API Reference

Criar Assinatura

Cria uma assinatura e realiza sua adesão.

Log in to see full request history

Criar Assinatura

Cria uma nova assinatura realizando sua adesão simultaneamente.

Como Implementar

Para utilizar esta rota, é necessário possuir um Token API. Esse token é disponibilizado atraves do Suporte, cujos contatos estão disponíveis em nossa página Fix Pay.

Primeiramente, é necessário incluir o token API do estabelecimento no header 'Authorization', juntamente com o header 'Content-Type' definido como 'application/json'.

Abaixo temos um exemplo de como inserir estes dados usando JSON.

{ "Authorization": "Bearer 125SEBXXXXXX20150821", "Content-type": "application/json" }

Como o método utilizado é o POST, devemos inserir os dados no body da requisição.

Abaixo, segue um exemplo de como inserir esses dados utilizando JSON..

{ "FormaPagamento":"CREDITO", "Reference":"aeXXXXXXXXXXRb", "Value":0.01, "DueDate":"05/31", "NumCard":"5123512351235123", "Installments":1, "NameCard":"MARIA S SANTOS", "Brand":"2", "Ccv":"184", "SoftDescriptor":"TESTE", "IdentificadorSessao":"d123a6f-1237-12a3-1237-13123a123a9", "Email":"teste@gmail.com", "CpfCnpj":"07312312312", "BirthDate":"01/01/2001", "Street":"Rua Maria José", "HouseNumber":123, "Neighborhood":"Meireles", "City":"Fortaleza", "State":"CE", "PostalCode":"60312312", "Country":"BR", "Complement":"Apt 123", "ReferencePoint":"Próximo ao mercado", "Phone":"85988998899", "OriginAddress":"192.168.2.123", "cliente_id":"12345", "FlagFrete":true, "Items":[ { "id":"1", "name":"TESTE", "quantity":2, "price":1.99, "subtotal":2.98, "sku":123 } ], "Shipping":{ "Name":"Maria Silva", "Street":"Rua Maria José", "HouseNumber":123, "Neighborhood":"Meireles", "City":"Fortaleza", "State":"CE", "PostalCode":"60312312", "Country":"BR", "Complement":"Apt 123", "ReferencePoint":"Próximo ao mercado" }, "Billing_Name":"Maria Silva" }

Testar rota

Abaixo, você poderá realizar testes na rota em produção, passando os valores nos parâmetros conforme sua descrição e tipo. Na lateral direita da tela, você poderá ver o código da requisição em várias linguagens diferentes e sua resposta. Além disso, na parte de resposta da requisição, você poderá ver todos os possíveis retornos gerados pela rota.

Body Params
string
required

Forma de pagamento.

string
required

Referência gerada pela eRede.

string
required

Identificador da Sessão atual.

double
required

Valor da Assinatura.

string
required

Nome presente no cartão.

string
required

Número do cartão.

string
required

Código de segurança do cartão.

string
required

Data de validade do cartão.

int32
required

Quantidade de parcelas.

string
required

Id da bandeira do cartão.

string
required

Descrição de quem está realizando a cobrança.

string
required

Email do cliente.

string
required

Cpf/Cnpj do cliente.

string
required

Data de nascimento do cliente.

string
required

País do cliente.

string
required

Estado do cliente.

string
required

Cidade do cliente.

string
required

CEP do cliente.

string
required

Bairro do cliente.

string
required

Rua do cliente.

int32
required

Número da casa.

string
required

Complemento do endereço. Ex.: Apartamento 123

string
required

Ponto de referência do endereço.

string
required

Número de telefone do cliente. Ex.: 85988998899

string
required

Ip da máquina atual.

string
required

Id do cliente.

Items
array of objects
required

Item a ser adicionado.

Items*
Shipping
array of objects
required

Endereço de envio

Shipping*
string

Nome da pessoa que receberá a cobrança.

Headers
string
required

Header no qual o valor é o Token do estabelecimento.

string
required
Defaults to application/json

Header no qual o valor tem que ser obrigatoriamente "application/json".

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json