API Reference

Criar e Aderir Assinatura

Cria uma assinatura e realiza sua adesão.

Log in to see full request history

Criar e Aderir à uma Assinatura

Cria uma nova assinatura realizando sua adesão simultaneamente.

É necessário passar o token do estabelecimento no header "Authorization", e no "Content-Type" preenchê-lo com o valor "application/json".

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

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

Abaixo temos um exemplo de como inserir os dados no body usando 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" }
Body Params
string
required

Forma de pagamento. Ex.: CREDITO ou DEBITO

string
required

Referência gerada pela eRede. Ex.: aeXXXX123XXXXRb

string
required

Identificador da Sessão atual. Ex.: deXXXXf-1237-12a3-1237-13XXX1239

double
required

Valor da Assinatura. Ex.: 10.99

string
required

Nome presente no cartão. Ex.: Maria S Santos

string
required

Número do cartão. Ex.: 1234567891234567

string
required

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

string
required

Data de validade do cartão. Ex.: 03/33

int32
required

Quantidade de parcelas. Ex.: 1, 2, 3, ... , 12.

string
required

Id da bandeira do cartão. Ex.: 1, 2, 3...

string
required

Descrição de quem está realizando a cobrança. Ex.: Fix Pay

string
required

Email do cliente. Ex.: teste@gmail.com

string
required

Cpf/Cnpj do cliente. Ex.: 073XXXXXX12

string
required

Data de nascimento do cliente. Ex.: 01/01/2001

string
required

País do cliente. Ex.: BR

string
required

Estado do cliente. Ex.: CE

string
required

Cidade do cliente. Ex.: Fortaleza

string
required

CEP do cliente. Ex. 60312345

string
required

Bairro do cliente. Ex.: Meireles.

string
required

Rua do cliente. Ex.: Rua Maria José.

int32
required

Número da casa. Ex.: 123

string
required

Complemento do endereço. Ex.: Apartamento 123

string
required

Ponto de referência do endereço. Ex.: Próximo ao mercado.

string
required

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

string
required

Ip da máquina atual. Ex.: 192.169.2.123

string
required

Id do cliente. Ex.: 12345

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. Ex.: Maria Santos

Headers
string
required

Header no qual o valor é o Token do estabelecimento. Formato: Bearer 125SEBXXXXXX20150821

string
required

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