Introdução
API Endpoint
https://api.zsystems.com.br/
A API Zspay está implementada em conformidade com o princípio de design REST. Nossa API possui recursos orientados a URLs, com códigos HTTP para indicar erros. Nós utilizamos funcionalidades HTTP nativas, como verbos de ação POST, PUT, GET, DELETE, para operações de leitura e escrita, bem como o modelo básico de autenticação HTTP.
Nós suportamos chamadas diretas aos recursos da API a partir de outras origens, CORS (cross-origin resource sharing), permitindo você interagir de maneira segura com nossas APIs a partir de aplicações web, lembrando sempre de utilizar sua chave pública nesses casos, reservando sua chave secreta para chamadas internas de sistema. Todas as respostas da API estão no formato de dados JSON, incluindo errors.
Para permitir que você possa explorar todos os serviços sem preocupação, nossas contas possuem chaves de acesso nos modos de produção (LIVE) e teste (TEST). Não é possível alternar entre modos, basta usar a chave apropriada para realizar operações em produção ou ambiente de teste. Chamadas feitas com chaves de teste não são processadas junto a instituições bancárias, facilitando o desenvolvimento.
A API REST da Zspay fornece uma interface para os aplicativos interagirem com a plataforma, enviando e recebendo dados como objetos JSON (JavaScript Object Notation)
Para usar esta API, você precisa de um Token API. Entre em contato com o seu marketplace para solicitar seu Token API.
Caso queria fazer download do insomnia com os endpoints e exemplos de como utilizar:
clique aqui
Estabelecimentos
Os estabelecimentos representam pessoas ou empresas dentro do seu marketplace. Normalmente, os estabelecimentos oferecem uma variedade de mercadorias novas, usadas, remodeladas e colecionáveis on-line (cartão não presente) ou em lojas (cartão-presente). Você pode vincular seus cartões de crédito, cartões de débito, vouchers, contas bancárias e fazer transferências, transações (ou seja, débitos), reembolsos e muito mais...
Criar estabelecimento para pessoa física
Exemplo de requisição:
{
"tipoEstabelecimentoId": "1",
"identificadorPlano": "",
"nome": "Laís Betina Aragão",
"sendMail": "false",
"nomeComprovante": "Lais Betina",
"email": "laisbetinaaragao77@gmail.com.br",
"telefone": ""
"celular": "51986060368",
"dataNascimento": "1983-06-07",
"dataNascimento2": "1983-06-07",
"cpf": "88029964153",
"categoria": "27",
"quantidade_pos": "0",
"faturamento_estimado": "10000",
"observacao": "",
"endereco": {
"logradouro": "Rua Iracema",
"numero": "274",
"cidade": "Cachoeirinha",
"estado": "RS",
"cep": "94940130",
"bairro": "Vila Monte Carlo",
"complemento": "",
},
"enderecoPOS": {
"logradouro": "",
"numero": "",
"cidade": "",
"estado": "",
"cep": "",
"bairro": "",
"complemento": "",
},
"proprietario": {
"nome": "",
"sobrenome": "",
"email": "",
"celular": "",
"dataNascimento": "",
"cpf": "",
"endereco": {
"logradouro": "",
"numero": "",
"cidade": "",
"estado": "",
"cep": "",
"bairro": "",
"complemento": ""
}
},
"contaBancaria": {
"tipoContaBancaria": "1",
"nomeTitular": "Lais Betina",
"bancoId": "7",
"agencia": "0190",
"conta": "098730-1",
},
"desativarVendas": "0",
"logo": (binary),
"documentos[]": (binary),
"documentosAtividade[]": (binary),
"documentosResidencia[]": (binary),
}
Requisição com o método POST com posibilidade de enviar JSON ou Multpart/form-data
https://api.zsystems.com.br/estabelecimentos
header: multipart/form-data application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"estabelecimento": {
"id": 16853,
"tipo_estabelecimento_id": 1,
"status_estabelecimento_id": 1,
"categoria_estabelecimento_id": 1,
"endereco_id": 79885,
"razao_social": "",
"nome_fantasia": "Laís Betina Aragão",
"ativo": 0,
"data_nascimento": "1983-06-07T09:00:00.000Z",
"created": "2020-12-17T19:26:44.000Z",
"modified": "2020-12-17T19:26:44.000Z",
"removed": null,
"tipo_estabelecimento": {
"id": 1,
"titulo": "Pessoa Física",
"created": "2019-01-11T20:38:52.000Z",
"modified": "2019-01-11T20:38:52.000Z",
"removed": null
},
"status_estabelecimento": {
"id": 1,
"titulo": "Aguardando Aprovação",
"created": "2019-07-22T20:24:19.000Z",
"modified": "2019-07-22T20:24:19.000Z",
"removed": null
},
"categoria_estabelecimento": {
"id": 1,
"titulo": "Padrão",
"created": "2019-07-25T18:18:17.000Z",
"modified": "2019-07-25T18:18:17.000Z",
"removed": null
},
"endereco": {
"id": 79885,
"logradouro": "Rua Iracema",
"numero": "274",
"complemento": "",
"cep": "94940130",
"bairro": "Vila Monte Carlo",
"cidade": "Cachoeirinha",
"uf": "RS",
"lat": null,
"long": null,
"created": "2020-12-17T19:26:44.000Z",
"modified": "2020-12-17T19:26:44.000Z",
"removed": null
}
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| tipoEstabelecimentoID | 1 = Pessoa Física 2 = Pessoa Jurídica |
|
| identificadorPlano | Código de identificação do plano | |
| nome | Nulo | |
| sendMail | true ou false | |
| nomeComprovante | Nome a ser impresso nos comprovantes | |
| telefone | null | |
| celular | Número do celular | |
| dataNascimento | Data de nascimento padrão ISO | |
| dataNascimento2 | Data de nascimento padrão europeu | |
| cpf | CPF | |
| categoria | Categoria predefinida a qual o estabelecimento pertence | |
| quantidade_pos | Quantidade de POS | |
| faturamento_estimado | Faturamento estimado da empresa | |
| observacao | Observação | |
| logradouro | Logradouro do endereço da empresa | |
| numero | Número do endereço da empresa | |
| cidade | Cidade do endereço da empresa | |
| estado | Código ISO 3166-2 para o estado, com duas letras, da empresa | |
| cep | Código de endereçamento postal da empresa | |
| bairro | Bairro do endereço da empresa | |
| complemento | Complemento do endereço da empresa | |
| logradouro | Logradouro do endereço para envio de POS | |
| numero | Número do endereço para envio de POS | |
| cidade | Cidade do endereço para envio de POS | |
| estado | Código ISO 3166-2 para o estado, com duas letras, para envio de POS | |
| cep | Código de endereçamento postal para envio de POS | |
| bairro | Bairro do endereço para envio de POS | |
| complemento | Complemento do endereço para envio de POS | |
| nome | Nome do proprietário | |
| sobrenome | Sobrenome do proprietário | |
| E-mail do proprietário | ||
| celular | Celular do proprietário | |
| dataNascimento | Data de nascimento do proprietário | |
| cpf | CPF do proprietário | |
| logradouro | Logradouro do endereço do proprietário | |
| numero | Número do endereço do proprietário | |
| cidade | Cidade do endereço do proprietário | |
| estado | Código ISO 3166-2 para o estado, com duas letras, do proprietário | |
| cep | Código Postal do endereço do proprietário | |
| complemento | Complemento do endereço do proprietário | |
| bairro | Bairro do endereço do proprietário | |
| tipoContaBancaria | 1 = Conta Corrente 2 = Poupança |
|
| nomeTitular | Nome do titular da conta | |
| bancoId | Id predefinida do banco | |
| agencia | Agência da conta bancária | |
| conta | Número da conta bancária | |
| razaoSocial | Razão social da empresa | |
| desativarVendas | Flag para habilitar/desabilitar vendas |
Criar estabelecimento para pessoa jurídica
Exemplo de requisição:
{
"tipoEstabelecimentoId": "2",
"nome": "",
"sendMail": "false",
"nomeComprovante": "Danilo/Isabel",
"email": "contabilidade@daniloeisabeltelecomltda.com.br",
"telefone": "1725849273"
"celular": "17983722026",
"dataNascimento": "",
"dataNascimento2": "",
"cpf": "",
"categoria": "23",
"quantidade_pos": "0",
"faturamento_estimado": "100000",
"observacao": "",
"endereco": {
"logradouro": "Rua Silvio Pelicer",
"numero": "608",
"cidade": "São José do Rio Preto",
"estado": "SP",
"cep": "15056024",
"bairro": "Condomínio Village Rio Preto",
"complemento": "",
},
"enderecoPOS": {
"logradouro": "",
"numero": "",
"cidade": "",
"estado": "",
"cep": "",
"bairro": "",
"complemento": "",
},
"proprietario": {
"nome": "Isabel",
"sobrenome": "Benedita Araújo",
"email": "isabeneditaaraujo@marsans.com.br",
"celular": "(67) 9 8590-5327",
"dataNascimento": "06/04/1998",
"cpf": "045.036.078-47",
"endereco": {
"logradouro": "Rua Oulivenca",
"numero": "306",
"cidade": "Campo Grande",
"estado": "MS",
"cep": "79034451",
"bairro": "Parque dos Novos Estados",
"complemento": ""
}
},
"contaBancaria": {
"tipoContaBancaria": "1",
"nomeTitular": "Isabel Benedita",
"bancoId": "6",
"agencia": "0590",
"conta": "012855-3",
},
"desativarVendas": "0",
"razaoSocial": "Danilo e Isabel Telecom Ltda",
"nomeFantasia": "Danilo e Isabel Telecom Ltda",
"cnpj": "63792040000133",
"logo": (binary),
"documentos[]": (binary),
"documentosProprietario[]": (binary),
"documentosAtividade[]": (binary),
"documentosResidencia[]": (binary),
}
Requisição com o método POST com posibilidade de enviar JSON ou Multpart/form-data
https://api.zsystems.com.br/estabelecimentos
header: Multipart/form-data: application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"estabelecimento": {
"id": 16842,
"tipo_estabelecimento_id": 2,
"status_estabelecimento_id": 1,
"categoria_estabelecimento_id": 1,
"endereco_id": 79412,
"razao_social": "Danilo e Isabel Telecom Ltda",
"nome_fantasia": "Danilo e Isabel Telecom Ltda",
"ativo": 0,
"data_nascimento": null,
"created": "2020-12-17T15:23:27.000Z",
"modified": "2020-12-17T15:23:28.000Z",
"removed": null,
"tipo_estabelecimento": {
"id": 2,
"titulo": "Pessoa Jurídica",
"created": "2019-01-11T20:38:59.000Z",
"modified": "2019-01-11T20:38:59.000Z",
"removed": null
},
"status_estabelecimento": {
"id": 1,
"titulo": "Aguardando Aprovação",
"created": "2019-07-22T20:24:19.000Z",
"modified": "2019-07-22T20:24:19.000Z",
"removed": null
},
"categoria_estabelecimento": {
"id": 1,
"titulo": "Padrão",
"created": "2019-07-25T18:18:17.000Z",
"modified": "2019-07-25T18:18:17.000Z",
"removed": null
},
"endereco": {
"id": 79412,
"logradouro": "Rua Silvio Pelicer",
"numero": "608",
"complemento": "",
"cep": "15056024",
"bairro": "Condomínio Village Rio Preto",
"cidade": "São José do Rio Preto",
"uf": "SP",
"lat": null,
"long": null,
"created": "2020-12-17T15:23:27.000Z",
"modified": "2020-12-17T15:23:27.000Z",
"removed": null
}
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| tipoEstabelecimentoID | 1 = Pessoa fisica 2 = Pessoa Jurídica |
|
| identificadorPlano | Código de identificação do plano | |
| nome | Nulo | |
| sendMail | true ou false | |
| nomeComprovante | Nome a ser impresso nos comprovantes | |
| E-mail da empresa | ||
| telefone | Número do telefone | |
| celular | Número do celular | |
| dataNascimento | Nulo | |
| dataNascimento2 | Nulo | |
| cpf | Nulo | |
| categoria | Categoria predefinida a qual o estabelecimento pertence | |
| quantidade_pos | Quantidade de POS | |
| faturamento_estimado | Faturamento estimado da empresa | |
| observacao | Observação | |
| logradouro | Logradouro do endereço da empresa | |
| numero | Número do endereço da empresa | |
| cidade | Cidade do endereço da empresa | |
| estado | Código ISO 3166-2 para o estado, com duas letras, da empresa | |
| cep | Código de endereçamento postal da empresa | |
| bairro | Bairro do endereço da empresa | |
| complemento | Complemento do endereço da empresa | |
| logradouro | Logradouro do endereço para envio de POS | |
| numero | Número do endereço para envio de POS | |
| cidade | Cidade do endereço para envio de POS | |
| estado | Código ISO 3166-2 para o estado, com duas letras, para envio de POS | |
| cep | Código de endereçamento postal para envio de POS | |
| bairro | Bairro do endereço para envio de POS | |
| complemento | Complemento do endereço para envio de POS | |
| nome | Nome do proprietário | |
| sobrenome | Sobrenome do proprietário | |
| E-mail do proprietário | ||
| celular | Celular do proprietário | |
| dataNascimento | Data de nascimento do proprietário | |
| cpf | CPF do proprietário | |
| logradouro | Logradouro do endereço do proprietário | |
| numero | Número do endereço do proprietário | |
| cidade | Cidade do endereço do proprietário | |
| estado | Código ISO 3166-2 para o estado, com duas letras, do proprietário | |
| cep | Código Postal do endereço do proprietário | |
| complemento | Complemento do endereço do proprietário | |
| bairro | Bairro do endereço do proprietário | |
| tipoContaBancaria | 1 = Conta Corrente 2 = Poupança |
|
| nomeTitular | Nome do titular da conta | |
| bancoId | Id predefinida do banco | |
| agencia | Agência da conta bancária | |
| conta | Número da conta bancária | |
| razaoSocial | Razão social da empresa | |
| desativarVendas | Flag para habilitar/desabilitar vendas | |
| razaoSocial | Razão Social da empresa | |
| nomeFantasia | Nome fantasia da empresa | |
| cnpj | CNPJ da empresa |
Listar Estabelecimentos
Exemplo de requisição:
{
page: 0
limit: 2
filters: {"omni":"","parentId":null}
}
Requisição GET para o seguinte URL:
https://api.zsystems.com.br/estabelecimentos/filhos
header: ContentType application/json
authorization Bearer 'Token API'
Converter parâmetros de entrada de JSON para Query String para utilização na URL
Exemplo de resultado :
{
"success": true,
"paginas": 174,
"quantidade": 348,
"estabelecimentos": [
{
"id": 9831,
"tipo_estabelecimento_id": 1,
"status_estabelecimento_id": 1,
"endereco_id": 14811,
"logo_id": 45779,
"razao_social": "",
"nome_fantasia": "095.219.250-00",
"ativo": 0,
"identificacao_fatura": "095.219.250-00",
"data_nascimento": "1989-12-06T08:00:00.000Z",
"mcc": 27,
"created": "2020-05-22T15:14:01.000Z",
"modified": "2020-08-14T21:00:16.000Z",
"removed": null,
"plano_venda_id": null,
"tipo_estabelecimento": {
"id": 1,
"titulo": "Pessoa Física",
"created": "2019-01-11T20:38:52.000Z",
"modified": "2019-01-11T20:38:52.000Z",
"removed": null
},
"status_estabelecimento": {
"id": 1,
"titulo": "Aguardando Aprovação",
"created": "2019-07-22T20:24:19.000Z",
"modified": "2019-07-22T20:24:19.000Z",
"removed": null
},
"estabelecimentos_documentos": [
{
"id": 39389,
"estabelecimento_id": 9831,
"tipo_documento_id": 2,
"arquivo_id": null,
"documento": "09521925000",
"created": "2020-05-22T15:14:01.000Z",
"modified": "2020-05-22T15:14:01.000Z",
"removed": null
}
],
"estabelecimentos_contatos": [
{
"id": 25154,
"estabelecimento_id": 9831,
"tipo_contato_id": 2,
"nome": "095.219.250-00",
"contato": "15615616165",
"created": "2020-05-22T15:14:01.000Z",
"modified": "2020-05-22T15:14:01.000Z",
"removed": null
},
{
"id": 25155,
"estabelecimento_id": 9831,
"tipo_contato_id": 3,
"nome": "095.219.250-00",
"contato": "095.219.250-00@gmail.com",
"created": "2020-05-22T15:14:01.000Z",
"modified": "2020-08-14T17:36:23.000Z",
"removed": null
}
],
"plano_venda": null,
"documento": "09521925000",
"email": "095.219.250-00@gmail.com",
"status": "Aguardando Aprovação",
"repMaster": null,
"plano": null
},
{
"id": 10564,
"tipo_estabelecimento_id": 1,
"status_estabelecimento_id": 1,
"endereco_id": 19943,
"logo_id": null,
"razao_social": "",
"nome_fantasia": "099.991.360-36",
"ativo": 0,
"identificacao_fatura": "099.991.360-36",
"data_nascimento": "1989-12-06T08:00:00.000Z",
"mcc": 5,
"created": "2020-06-09T21:13:49.000Z",
"modified": "2020-06-10T00:20:08.000Z",
"removed": null,
"plano_venda_id": null,
"tipo_estabelecimento": {
"id": 1,
"titulo": "Pessoa Física",
"created": "2019-01-11T20:38:52.000Z",
"modified": "2019-01-11T20:38:52.000Z",
"removed": null
},
"status_estabelecimento": {
"id": 1,
"titulo": "Aguardando Aprovação",
"created": "2019-07-22T20:24:19.000Z",
"modified": "2019-07-22T20:24:19.000Z",
"removed": null
},
"estabelecimentos_documentos": [
{
"id": 43202,
"estabelecimento_id": 10564,
"tipo_documento_id": 2,
"arquivo_id": null,
"documento": "09999136036",
"created": "2020-06-09T21:13:49.000Z",
"modified": "2020-06-09T21:13:49.000Z",
"removed": null
}
],
"estabelecimentos_contatos": [
{
"id": 27645,
"estabelecimento_id": 10564,
"tipo_contato_id": 2,
"nome": "099.991.360-36",
"contato": "09999136036",
"created": "2020-06-09T21:13:49.000Z",
"modified": "2020-06-09T21:13:49.000Z",
"removed": null
},
{
"id": 27646,
"estabelecimento_id": 10564,
"tipo_contato_id": 3,
"nome": "099.991.360-36",
"contato": "099.991.360-36@gmail.com",
"created": "2020-06-09T21:13:49.000Z",
"modified": "2020-06-09T21:13:49.000Z",
"removed": null
}
],
"plano_venda": null,
"documento": "09999136036",
"email": "099.991.360-36@gmail.com",
"status": "Aguardando Aprovação",
"repMaster": "Representante",
"plano": null
}
]
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| page | Número de páginas | |
| limit | Define a quantidade de estabelecimentos a serem exibidos por página | |
| omni | Campo utilizado como ferramenta de pesquisa | |
| parentId | Identifica a qual estabelecimento está vinculado |
Consultar Token
Exemplo de requisição:
{ }
Requisição GET com parâmetros na URL:
https://api.zsystems.com.br/estabelecimentos/{idEstabelecimento}/token
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"token": "a4bd2bfeaec0445dc6233d2ccca662777ae45268"
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| idEstabelecimento | Código de identificação do estabelecimento |
Consultar Saldo
Exemplo de requisição:
{ }
Requisição GET com parâmetros na URL:
https://api.zsystems.com.br/estabelecimentos/{idEstabelecimento}/saldo
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"saldo": {
"atual": "0.00",
"futuro": "297625.33"
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| idEstabelecimento | Código de identificação do estabelecimento |
Consultar estabelecimento por documento
Exemplo de requisição:
{ }
Requisição GET com parâmetros na URL:
https://api.zsystems.com.br/estabelecimentos/por_documento/{documento}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"estabelecimento": {
"id": 12696,
"tipo_estabelecimento_id": 1,
"status_estabelecimento_id": 1,
"logo_id": null,
"nome_fantasia": "Teste doc",
"razao_social": "",
"ativo": 0,
"arquivo": null,
"tipo_estabelecimento": {
"id": 1,
"titulo": "Pessoa Física"
},
"estabelecimentos_contatos": [
{
"id": 32804,
"tipo_contato_id": 3,
"contato": "ks.bonini@gmail.com"
}
],
"estabelecimentos_documentos": [
{
"id": 56413,
"tipo_documento_id": 2,
"documento": "35856667875"
}
],
"status_estabelecimento": {
"id": 1,
"titulo": "Aguardando Aprovação"
}
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| documento | Número do documento do estabelecimento a ser consultado |
Habilitar estabelecimento
Exemplo de requisição:
{ }
Requisição POST com parâmetros na URL:
https://api.zsystems.com.br/estabelecimentos/{idEstabelecimento}/habilitar
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| idEstabelecimento | Código de identificação do estabelecimento |
Desabilitar estabelecimento
Exemplo de requisição:
{ }
Requisição DELETE com parâmetros na URL :
https://api.zsystems.com.br/estabelecimentos/{idEstabelecimento}/desabilitar
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| idEstabelecimento | Código de identificação do estabelecimento |
Habilitar POS
Exemplo de requisição:
{ }
Requisição POST com parâmetros na URL :
https://api.zsystems.com.br/estabelecimentos/{estabelecimentoId}/habilitar_pos/{token}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| EstabelecimentoId | Código de identificação do estabelecimento | |
| Token | Token do estabelecimento |
Listar POS
Exemplo de requisição:
{ }
Requisição GET com parâmetros na URL :
https://api.zsystems.com.br/estabelecimentos/{estabelecimentoId}/pos
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"pos": [
{
"id": 83811,
"identification_number": "87a8c03e55e9454aa652716f93c0d4e5",
"serial": "6M822995",
"chip": null,
"valorTotalVendas": "35280.39"
}
]
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| EstabelecimentoId | Código de identificação do estabelecimento |
Habilitar / Desabilitar Split
Exemplo de requisição:
{ }
Requisição PUT com parâmetros na URL:
https://api.zsystems.com.br/estabelecimentos/{estabelecimentoId}/splits/{splitId}/status
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Status alterado com sucesso."
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| estabelecimentoId | Código de identificação do estabelecimento | |
| splitId | ID do split a ser habilitado |
Editar estabelecimento
Exemplo de requisição:
{
"tipoEstabelecimentoId": "1",
"identificadorPlano": "",
"nome": "209.056.810-02",
"nomeComprovante": "209.056.810-02",
"email": "209.056.810-02@teste.com",
"telefone": ""
"celular": "20905681002",
"dataNascimento": "1989-12-06",
"dataNascimento2": "1989-12-06",
"cpf": "20905681002",
"categoria": "29",
"quantidade_pos": "0",
"faturamento_estimado": "0",
"observacao": "",
"endereco": {
"logradouro": "Rua Genaro Arilla Arensanz",
"numero": "625",
"cidade": "São Paulo",
"estado": "SP",
"cep": "03275090",
"complemento": "",
"bairro": "Vila Ivone",
},
"enderecoPOS": {
"logradouro": "",
"numero": "",
"cidade": "",
"estado": "",
"cep": "",
"bairro": "",
"complemento": "",
},
"proprietario": {
"nome": "",
"sobrenome": "",
"email": "",
"celular": "",
"dataNascimento": "",
"cpf": "",
"endereco": {
"logradouro": "",
"numero": "",
"cidade": "",
"estado": "",
"cep": "",
"bairro": "",
"complemento": ""
}
},
"contaBancaria": {
"tipoContaBancaria": "1",
"nomeTitular": "",
"bancoId": "",
"agencia": "",
"conta": "",
},
"desativarVendas": "0",
"razaoSocial": "",
"nomeFantasia": "209.056.811-02",
"cnpj": ""
}
Para realizar o envio de arquivos, é necessário fazer a requisição com o método PUT, porém, os dados trafegados não serão JSON e sim Multipart/form-data:
https://api.zsystems.com.br/estabelecimentos/{estabelecimentoId}
header: multipart/form-data application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"estabelecimento": {
"id": 19624,
"parent_id": 158,
"marketplace_id": 3,
"tipo_estabelecimento_id": 1,
"status_estabelecimento_id": 1,
"categoria_estabelecimento_id": 1,
"endereco_id": 112803,
"zoop_seller_id": "c81fd769248141cba5deaa071b6795e8",
"logo_id": null,
"logo_boleto_id": null,
"logo_email_id": null,
"razao_social": "",
"nome_fantasia": "209.056.810-02",
"identificacao_fatura": "209.056.810-02",
"identificador_plano": "",
"faturamento_estimado": 0,
"quantidade_pos": "0",
"observacao": "",
"ativo": 0,
"data_nascimento": "1989-12-06T08:00:00.000Z",
"mcc": "29",
"plano_venda_id": null,
"pos_endereco_id": null,
"data_desabilitado": null,
"termos_condicoes_aceito": false,
"termos_condicoes_aceito_data": null,
"termos_condicoes_aceito_usuario_id": null,
"termos_condicoes_aceito_ip": null,
"created": "2021-07-05T14:54:28.000Z",
"modified": "2022-06-22T13:46:24.292Z",
"removed": null
},
"warnings": []
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| tipoEstabelecimentoID | 1 = Pessoa Física 2 = Pessoa Jurídica |
|
| identificadorPlano | Código de identificação do plano | |
| nome | Nulo | |
| nomeComprovante | Nome a ser impresso nos comprovantes | |
| telefone | null | |
| celular | Número do celular | |
| dataNascimento | Data de nascimento padrão ISO | |
| dataNascimento2 | Data de nascimento padrão europeu | |
| cpf | CPF | |
| categoria | Categoria predefinida a qual o estabelecimento pertence | |
| quantidade_pos | Quantidade de POS | |
| faturamento_estimado | Faturamento estimado da empresa | |
| observacao | Observação | |
| logradouro | Logradouro do endereço da empresa | |
| numero | Número do endereço da empresa | |
| cidade | Cidade do endereço da empresa | |
| estado | Código ISO 3166-2 para o estado, com duas letras, da empresa | |
| cep | Código de endereçamento postal da empresa | |
| complemento | Complemento do endereço da empresa | |
| bairro | Bairro do endereço da empresa | |
| logradouro | Logradouro do endereço para envio de POS | |
| numero | Número do endereço para envio de POS | |
| cidade | Cidade do endereço para envio de POS | |
| estado | Código ISO 3166-2 para o estado, com duas letras, para envio de POS | |
| cep | Código de endereçamento postal para envio de POS | |
| bairro | Bairro do endereço para envio de POS | |
| complemento | Complemento do endereço para envio de POS | |
| nome | Nome do proprietário | |
| sobrenome | Sobrenome do proprietário | |
| E-mail do proprietário | ||
| celular | Celular do proprietário | |
| dataNascimento | Data de nascimento do proprietário | |
| cpf | CPF do proprietário | |
| logradouro | Logradouro do endereço do proprietário | |
| numero | Número do endereço do proprietário | |
| cidade | Cidade do endereço do proprietário | |
| estado | Código ISO 3166-2 para o estado, com duas letras, do proprietário | |
| cep | Código Postal do endereço do proprietário | |
| complemento | Complemento do endereço do proprietário | |
| bairro | Bairro do endereço do proprietário | |
| tipoContaBancaria | 1 = Conta Corrente 2 = Poupança |
|
| nomeTitular | Nome do titular da conta | |
| bancoId | Id predefinida do banco | |
| agencia | Agência da conta bancária | |
| conta | Número da conta bancária | |
| desativarVendas | Flag para habilitar/desabilitar vendas | |
| razaoSocial | Razão social da empresa | |
| nomeFantasia | Nome fantasia |
Cadastrar split sem limite de data e valor
Exemplo de requisição:
{
"dataFim": null,
"dataInicio": null,
"estabelecimentos":[
{
"chargeProcessingFee": true,
"estabelecimentoId": 10564,
"tipoSplit": 2,
"valor": 1
}
],
"valorMaximo": null
}
Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/estabelecimentos/:id/splits
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso!",
"split": {
"valor_pago": 0,
"ativo": true,
"id": 17919,
"estabelecimento_id": "15891",
"categoria": 1,
"data_inicio": null,
"data_fim": null,
"valor_maximo": null,
"modified": "2023-03-23T17:05:09.694Z",
"created": "2023-03-23T17:05:09.694Z"
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| id | Id do estabelecimento que vai receber a regra de split | |
| dataInicio | Enviar como null | |
| dataFim | Enviar como null | |
| chargeProcessingFee |
0 = Bruto 1 = Líquido |
|
| estabelecimentoId | Id do estabelecimento que recebera a taxa do split | |
| tipoSplit |
2 = Percentual |
|
| valor | Porcentagem | |
| valorMaximo | Enviar como null |
Cadastrar split com limite de data
Exemplo de requisição:
{
"dataInicio": "2023-03-03",
"dataFim": "2023-04-03",
"estabelecimentos":[
{
"chargeProcessingFee":0,
"estabelecimentoId":10564,
"tipoSplit":2,
"valor":1
}
],
"valorMaximo": null
}
Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/estabelecimentos/:id/splits
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso!",
"split": {
"valor_pago": 0,
"ativo": true,
"id": 17924,
"estabelecimento_id": "15891",
"categoria": 1,
"data_inicio": "2023-03-03T03:00:00.000Z",
"data_fim": "2023-04-03T03:00:00.000Z",
"valor_maximo": null,
"modified": "2023-03-23T17:59:44.490Z",
"created": "2023-03-23T17:59:44.490Z"
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| id | Id do estabelecimento que vai receber a regra de split | |
| dataInicio | Enviar data de inicio | |
| dataFim | Enviar data de fim | |
| chargeProcessingFee |
0 = Bruto 1 = Líquido |
|
| estabelecimentoId | Id do estabelecimento que recebera a taxa do split | |
| tipoSplit |
2 = Percentual |
|
| valor | Porcentagem | |
| valorMaximo | Enviar como null |
Cadastrar split com limite de data e valor
Exemplo de requisição:
{
"dataFim": "2023-05-03",
"dataInicio": "2023-04-04",
"estabelecimentos":[
{
"chargeProcessingFee":0,
"estabelecimentoId":10564,
"tipoSplit":2,
"valor":1
}
],
"valorMaximo": 10
}
Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/estabelecimentos/:id/splits
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso!",
"split": {
"valor_pago": 0,
"ativo": true,
"id": 17926,
"estabelecimento_id": "15891",
"categoria": 1,
"data_inicio": "2023-04-04T03:00:00.000Z",
"data_fim": "2023-05-03T03:00:00.000Z",
"valor_maximo": 10,
"modified": "2023-03-23T18:08:46.929Z",
"created": "2023-03-23T18:08:46.929Z"
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| id | Id do estabelecimento que vai receber a regra de split | |
| dataInicio | Enviar data de inicio | |
| dataFim | Enviar data de fim | |
| chargeProcessingFee |
0 = Bruto 1 = Líquido |
|
| estabelecimentoId | Id do estabelecimento que recebera a taxa do split | |
| tipoSplit |
2 = Percentual |
|
| valor | Porcentagem | |
| valorMaximo | Enviar valor maximo |
Contas bancárias
Ao criar contas bancárias você poderá creditar / debitá-lo sem ter que inserir repetidamente a informação.
O recurso representa uma conta bancária e você só pode criar uma nova se tiver um token bancário seguro. A Zspay usa tokenização para proteger contas bancárias, cartões e informações confidenciais de identificação pessoal (PII) para cumprir os padrões da indústria e os regulamentos governamentais.
Cadastrar conta bancária
Exemplo de requisição:
{
"tipoContaBancaria": 1,
"nomeTitular": "Integração Z-Systems",
"bancoId": 2,
"agencia": "0000",
"conta": "000000"
}
Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/estabelecimentos/contas_bancarias
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"contaBancaria": {
"id": 49,
"tipo_conta_bancaria_id": 1,
"banco_id": 2,
"nome_titular": "Integração Z-Systems",
"agencia": "0000",
"conta": "000000",
"documento": "00000000000",
"modified": "2019-12-06T14:38:30.846Z",
"created": "2019-12-06T14:38:30.846Z"
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| tipoContaBancaria | 1 = Conta Corrente 2 = Poupança |
|
| nomeTitular | Nome do titular da conta | |
| bancoId | Id predefinida do banco | |
| agencia | Agência da conta bancária | |
| conta | Número da conta bancária |
Listar conta bancária
Exemplo de requisição:
{ }
Requisição GET com parâmetro na URL:
https://api.zsystems.com.br/estabelecimentos/contas_bancarias
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success":true,
"contasBancarias":[
{
"id":27,
"tipoContaBancaria":1,
"nomeTitular":"Z-Systems Software de Gestão",
"agencia":"000",
"conta":"000000",
"banco":"Itaú Unibanco S.A.",
"ativo":true
},
{
"id":28,
"tipoContaBancaria":1,
"nomeTitular":"Z-Systems Software de Gestão",
"agencia":"0000",
"conta":"000000000",
"banco":"Banco Santander (Brasil) S.A.",
"ativo":false
}
]
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| id | id da conta bancária |
Selecionar conta bancária
Exemplo de requisição:
{ }
Requisição PUT com parâmetros na URL:
https://api.zsystems.com.br/estabelecimentos/estabelecimentoid/contas_bancarias/{id}/ativar
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success":true
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| id | id do estabelecimento | |
| id | id da conta bancária |
Remover uma conta bancária
Exemplo de requisição:
{ }
Requisição DELETE com parâmetros na URL:
https://api.zsystems.com.br/estabelecimentos/{EstabelecimentoId}/contas_bancarias/{ContaBancariaId}/excluir
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success":true,
"message":"Operação realizada com sucesso",
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| EstabelecimentoId | Código de identificação do estabelecimento | |
| ContaBancariaId | Código de identificação da conta bancária |
Payout automático - pagamento em conta
| Descrição |
|---|
| Transferência dos recebíveis(saldo das vendas) para conta bancária. Se desativado o saldo é acumulado e o payout pode ser feito através das transferências . |
Exemplo de requisição:
{ }
Requisição POST com parâmetros na URL:
https://api.zsystems.com.br/estabelecimentos/{estabelecimentoId}/politicaRecebimento/{parametro}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"result": {
"id": "bd7180fcc4864886a1d57c4d4fdd164f",
"transfer_interval": "daily",
"transfer_day": null,
"transfer_enabled": true,
"minimum_transfer_value": 100
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| parametro=0 | boolean | Desativado |
| parametro=1 | boolean | Ativado |
| estabelecimentoId | Id do estabelecimento que está solicitando |
Transferências
Uma transferência (pagamento) é uma operação onde os fundos são enviados para uma conta bancária com depósito direto da ACH.
Para creditar uma conta bancária, você usa uma conta existente e armazena um ID de cliente existente (vendedor ou comprador) previamente associada a uma conta bancária, ou simplesmente envie o valor junto com os novos detalhes da mesma conta, mais tarde, descartaremos os detalhes da conta bancária quando você fizer uma transferência dessa maneira.
Transferir ou Agendar Transferência
Exemplo de requisição:
{
"tipoTransferencia": 2,
"valor": 0.10,
"toEstabelecimentoId": null,
"contaBancariaId": 27,
"senha": "1234567",
"descricao": "pagamento",
"agendadoPara": "2019-12-05T20:18:22.851Z"
}
Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/transferencias
header: ContentType application/json
authorization Bearer 'Token API'
Caso seja utilizado o token fornecido para o estabelecimento, não será necessária utilização de senha para o usuário.
Exemplo de resultado :
{
"success": true,
"message": "Agendamento realizada com sucesso!",
"agendamento": {
"id": 1,
"usuario_id": 107,
"tipo_transferencia_id": 2,
"conta_bancaria_id": 27,
"descricao": "pagamento",
"valor": 0.10,
"agendado_para": "2019-12-05",
"to_estabelecimento_id": null,
"from_estabelecimento_id": 131,
"executada": 0,
"modified": "2019-12-04T20:21:46.902Z",
"created": "2019-12-04T20:21:46.902Z"
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| tipoTransferencia | 1 = Conta Digital 2 = Conta Bancária |
|
| valor | Valor a ser transferido, utilizando .(ponto) em vez de ,(vírgula) para casas decimais. Ex.: para transferir R$ 100,00 utiliza-se 100.00 ; para R$ 0,21 utiliza-se 0.21 | |
| toEstabelecimentoId | Caso seja tipoTransferencia = 1 informe o id do estabelecimento para que seja realizada a transferência | |
| contaBancariaId | Caso seja tipoTransferencia = 2 informe o id da contaBancaria para que seja realizada a transferência | |
| senha | Informar a senha do usuário que está fazendo essa ação, essa senha é gerada no ato do cadastro tanto do estabelecimento quanto de um novo usuário | |
| descricao | Descrever para que conste em seu extrato | |
| agendadoPara | Utiliza-se apenas em caso de agendamento de transferência, caso contrário, não é necessário informar este campo. |
Visualizar transferências
Exemplo de requisição:
{
"limit": 200,
"current": 0,
"totalRows": 0,
"startDate": 2020-03-21,
"endDate": 2022-08-22,
"omni": "",
"omni2": "",
"status[]": "3",
"tipo[]": "1",
}
Requisição GET com parâmetros na URL:
https://api.zsystems.com.br/transferencias
header: ContentType application/json
authorization Bearer 'Token API'
Converter parâmetros de entrada de JSON para Query String para utilização na URL
Exemplo de resultado :
{
"success": true,
"transferencias": [
{
"id": 1705643,
"descricao": "Transferência Automática",
"status_transferencia_id": 1,
"to_estabelecimento_id": null,
"conta_bancaria_id": 305809,
"tipo_transferencia_id": 3,
"valor": "12342.00",
"created": "2022-02-25T17:00:16.000Z",
"FromEstabelecimento": {
"nome_fantasia": "Made Nova Madeiras Ltda",
"razao_social": "Made Nova Madeiras Ltda",
"estabelecimentos_documentos": [
{
"id": 508,
"estabelecimento_id": 158,
"tipo_documento_id": 3,
"arquivo_id": null,
"documento": "68293877000151",
"created": "2019-12-19T14:04:01.000Z",
"modified": "2019-12-19T14:04:01.000Z",
"removed": null
}
]
},
"ToEstabelecimento": null,
"conta_bancaria": {
"id": 305809,
"tipo_conta_bancaria_id": 1,
"banco_id": 2,
"nome_titular": "vilanio a silva",
"agencia": "21421",
"conta": "55556",
"documento": "68293877000151",
"zoop_token_id": "",
"zoop_bank_account_id": "2f2cb5e325714ea99ab7c44a42107eb9",
"ativo": false,
"created": "2022-08-19T14:50:40.000Z",
"modified": "2022-08-19T14:50:40.000Z",
"removed": null
},
"status_transferencia": {
"titulo": "Pendente"
}
},
......
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| limit | Limite de transferências por página | |
| current | numero atual da pagina | |
| totalRows | total de itens por página | |
| startDate | Data inicial a ser pesquisada | |
| endDate | Data final a ser pesquisada | |
| omni | numero de documento | |
| omni2 | nome do estabeleciemento | |
| status[ ] |
1 = Pendente 2 = Aprovado 3 = Cancelada |
|
| tipo[ ] | 1 = Conta Digital 2 = Conta Bancária 3 = Automática |
Visualizar transferências agendadas
Exemplo de requisição:
{ }
Requisição GET com parâmetros na URL:
https://api.zsystems.com.br/transferencias/agendadas/{tipoTransferenciaId}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"data": [
{
"id": 2,
"valor": "0.10",
"tipoId": 2,
"tipo": "Conta Bancária",
"descricao": "pagamento",
"agendadoPara": "2019-12-05",
"contaBancaria": {
"id": 27,
"agencia": "0000",
"conta": "000000",
"nome_titular": "Z-Systems Software de Gestão",
"tipo_conta_bancaria": {
"id": 1,
"titulo": "Conta Corrente"
},
"banco": {
"id": 55,
"nome": "Itaú Unibanco S.A."
}
},
"created": "2019-12-04T20:26:53.000Z",
"from": {
"nome": "Integração Z-Systems",
"documento": "000000000000",
"email": "integracao@zsystems.com.br"
},
"to": {
"nome": null,
"documento": null,
"email": null
}
},
{
"id": 4,
"valor": "0.10",
"tipoId": 2,
"tipo": "Conta Bancária",
"descricao": "pagamento",
"agendadoPara": "2019-15-05",
"contaBancaria": {
"id": 27,
"agencia": "0000",
"conta": "000000",
"nome_titular": "Z-Systems Software de Gestão",
"tipo_conta_bancaria": {
"id": 1,
"titulo": "Conta Corrente"
},
"banco": {
"id": 55,
"nome": "Itaú Unibanco S.A."
}
},
"created": "2019-12-04T20:26:53.000Z",
"from": {
"nome": "Integração Z-Systems",
"documento": "00000000000",
"email": "integracao@zsystems.com.br"
},
"to": {
"nome": null,
"documento": null,
"email": null
}
}
]
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| tipoTransferenciaId | 1 = Conta Digital 2 = Conta Bancária |
Tipo de recebimento
Exemplo de requisição:
{}
Define se o estabelecimento vai receber o saldo na conta digital ou direto na conta bancária
Requisição POST com parâmentros na URL:
https://api.zsystems.com.br/estabelecimentos/{estabelecimentoId}/politicaRecebimento/{tipoDeRecebimentoId}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"result": {
"id": "d9db18e83b984c0387f1ccc313363d72",
"transfer_interval": "daily",
"transfer_day": null,
"transfer_enabled": true,
"minimum_transfer_value": 100
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| estabelecimentoId | Id do estabelecimento | |
| tipoDeRecebimentoId | 0 = Conta Digital 1 = Conta bancaria |
Remover transferências agendadas
Exemplo de requisição:
{ }
Requisição DELETE com parâmetros na URL:
https://api.zsystems.com.br/transferencias/{idTransfencia}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso."
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| idTransfencia | Id da trasnferência que foi agendado anteriormente e que deseja deletar |
Clientes
Nesta sessão, vamos falar um pouco mais sobre o objeto "cliente".
O objeto cliente é usado para editar, excluir e atualizar os compradores, bem como para permitir reembolsos, assinaturas, inserir detalhes do cartão de crédito para um cliente, editar detalhes e, claro, fazer transações.
Você pode buscar apenas um cliente, bem como uma lista de todos os compradores do seu marketplace.
Criar um novo cliente
Exemplo de requisição:
{
"nome": "João Paulo",
"documento": "00000000000",
"dataNascimento": "1993-12-16",
"email": "teste2@zsystems.com.br",
"celular": "00999998888",
"sexo": "M",
"endereco": {
"logradouro": "Rua Pedro Souza",
"numero": "124",
"cep": "03380-200",
"cidade": "São Paulo",
"estado": "SP",
"complemento": ""
}
}
Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/clientes
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"cliente": {
"id": 18638,
"endereco_id": 700,
"nome": "João Paulo",
"email": "teste2@zsystems.com.br",
"senha": "",
"sexo": "M",
"ativo": true,
"data_nascimento": "1993-12-16",
"created": "2020-02-07T21:49:38.000Z",
"modified": "2020-02-07T21:49:38.000Z",
"removed": null,
"endereco": {
"id": 700,
"logradouro": "Rua Souza Lima",
"numero": "124",
"complemento": "",
"cep": "03380200",
"cidade": "São Paulo",
"uf": "SP",
"lat": null,
"long": null,
"created": "2020-02-07T21:49:38.000Z",
"modified": "2020-02-07T21:49:38.000Z",
"removed": null
}
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| nome | Nome do cliente / Razão Social | |
| documento | CPF ou CNPJ do cliente | |
| dataNascimento | Data de nascimento do cliente, caso o documento seja CPF | |
| E-mail do cliente | ||
| celular | Número celular do cliente | |
| sexo | M = Masculino F = Feminino |
|
| logradouro | Rua ou Avenida do endereço | |
| numero | Número do endereço | |
| cep | Código postal do endereço | |
| cidade | Cidade do endereço | |
| estado | Código ISO 3166-2 para o estado, com duas letras | |
| complemento | Complemento do endereço |
Vincular cartão a um cliente
Exemplo de requisição:
{
"numero": "5234233381847212",
"titular": "Joao Paulo ",
"codigoSeguranca": "069",
"validade": "02/2025"
}
Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/clientes/{cliente_id}/cartoes
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso",
"cartaoId": {
"id": 18628,
"cliente_id": 18638,
"nome_titular": "Joao Paulo",
"bandeira": "Mastercard",
"ultimos_digitos": "7212",
"ano_expiracao": "2025",
"mes_expiracao": "02",
"modified": "2020-02-07T21:52:41.015Z",
"created": "2020-02-07T21:52:41.015Z"
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| numero | Número do cartão | |
| titular | Nome impresso no cartão | |
| codigoSeguranca | Código de segurança ou CVV do cartão | |
| validade | Mês e ano em que o cartão expira sua validade |
Excluir Cliente
Exemplo de requisição:
{ }
Requisição DELETE com parâmetros na URL:
https://api.zsystems.com.br/clientes/{ClienteId}/excluir
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Cliente removido com sucesso."
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| clienteId | Código de identificação do cliente |
Listar Cartões de crédito
Exemplo de requisição:
{ }
Requisição GET com parâmetros na URL:
https://api.zsystems.com.br/clientes/{clienteId}/cartoes
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"cliente": {
"id": 13845789,
"nome": "Victor Oliver Alexandre Freitas",
"email": "victoroliverfreitas@paulistadovale.org.br",
"sexo": "M",
"data_nascimento": "2002-01-16",
"clientes_cartoes": [
{
"id": 12504346,
"ultimos_digitos": 2075
},
{
"id": 12999943,
"ultimos_digitos": 2075
},
{
"id": 13151708,
"ultimos_digitos": 2075
},
{
"id": 13195502,
"ultimos_digitos": 2075
},
{
"id": 13229566,
"ultimos_digitos": 2075
},
{
"id": 13229605,
"ultimos_digitos": 8779
},
{
"id": 13229619,
"ultimos_digitos": 6850
},
{
"id": 13229638,
"ultimos_digitos": 5079
},
{
"id": 13229657,
"ultimos_digitos": 7013
},
{
"id": 13229669,
"ultimos_digitos": 8015
},
{
"id": 13229683,
"ultimos_digitos": 2438
},
{
"id": 13229691,
"ultimos_digitos": 4001
},
{
"id": 13229698,
"ultimos_digitos": 4322
}
]
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| clienteId | Código de identificação do cliente |
Usuários
Nesta sessão, vamos falar um pouco mais sobre o objeto "Usuário".
O objeto usuário é usado para consultar, incluir, alterar e excluir os usuários.
Você pode buscar apenas um usuário por nome/cpf ou listar todos os usuários
Cadastrar usuário
Exemplo de requisição:
{
"estabelecimentoId": 158,
"usuario": {
"nome": "Jonatas",
"email": "jonatas@teste.com.br",
"dataNascimento": "2002-05-29",
"dataNascimento2": "29/05/2002",
"sexo": "M",
"grupoId": 5
},
"documentos": [
{
"id": null,
"tipoDocumento": 2,
"documento": "47451835855"
}
],
"contatos": [
{
"tipoContato": 2,
"valorContato": "11999999999"
},
"tipoContato": 1,
"valorContato": "1188888888"
}
],
"endereco": {
"logradouro": "Rua Luís de Andrade",
"numero": "567",
"cep": "02920000",
"cidade": "São Paulo",
"estado": "SP",
"complemento": "",
"bairro": "Vila Pereira Barreto"
}
}
Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/usuarios
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Usuário cadastrado com sucesso.",
"usuario": {
"ativo": "1",
"id": 13251,
"nome": "Jonatas",
"email": "jonatas@teste.com.br",
"sexo": "M",
"parent_id": null,
"senha": "3ae0b6825f571201b167223bd72e08ed54df1135",
"token": "ce935b9aab1f7a7dca2bc9825d80da35ed5fce75",
"grupo_id": 5,
"endereco_id": 35336,
"data_nascimento": "2002-05-29",
"principal_estabelecimento_id": 158,
"modified": "2020-08-17T15:47:47.942Z",
"created": "2020-08-17T15:47:47.942Z"
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| estabelecimentoId | Código de identificação do estabelecimento | |
| nome | Nome do usuário | |
| E-mail do usuário | ||
| data de nascimento | Data de nascimento do usuário | |
| sexo | Sexo do usuário | |
| grupoId |
1 = Administrador 2 = Gerencial 3 = Básico 4 = Financeiro 5 = Representante 7 = Backoffice 7 = Representante básico |
id | null |
| tipoDocumento |
1 = RG 2 = CPF 3 = CNPJ 4 = Outros 5 = Identificação 6 = Comprovante de atividade 7 = Comprovante de residência 8 = Identificação de usuário |
|
| documento | Número do documento | |
| tipoContato |
1 = Fixo 2 = Celular |
|
| valorContato | Número do telefone | |
| logradouro | Logradouro do endereço do usuário | |
| numero | Número do endereço | |
| cep | Código Postal do endereço do usuário | |
| Cidade | Nome da cidade | |
| estado | Código ISO 3166-2 para o estado, com duas letras da empresa | |
| complemento | Complemento do endereço do usuário | |
| bairro | Bairro do endereço do usuário |
Consultar usuário
Exemplo de requisição:
{ }
Requisição GET com parâmetros na URL:
https://api.zsystems.com.br/usuarios/{idUsuario}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"usuario": {
"id": 12964,
"parent_id": null,
"nome": "Teste",
"email": "teste@teste.com.br",
"foto": null,
"sexo": "M",
"data_nascimento": "1990-05-29",
"ativo": 1,
"token": "82d42c1589a50771ef6c8eda98925e8ec2f171be",
"usuarios_estabelecimentos": [
{
"id": 33507,
"usuario_id": 12964,
"estabelecimento_id": 158,
"created": "2020-08-10T19:48:00.000Z",
"modified": "2020-08-10T19:48:00.000Z",
"removed": null,
"estabelecimento": {
"id": 158,
"nomeFantasia": "Made Nova Madeiras Ltda",
"razaoSocial": "Made Nova Madeiras Ltda"
}
}
],
"endereco": {
"id": 34859,
"logradouro": "Rua Luís de Andrade",
"numero": "550",
"complemento": "Casa",
"cep": "02920000",
"cidade": "São Paulo",
"uf": "SP",
"bairro": "Vila Pereira Barreto"
},
"usuarios_contatos": [
{
"id": 626,
"tipo_contato_id": 1,
"contato": "1199999999"
},
{
"id": 625,
"tipo_contato_id": 2,
"contato": "11999999999"
}
],
"usuarios_documentos": [
{
"id": 266,
"tipo_documento_id": 2,
"documento": "46122469858"
}
],
"grupo": {
"id": 7,
"nome": "Backoffice"
},
"estabelecimentos": [
{
"id": 158,
"nomeFantasia": "Made Nova Madeiras Ltda",
"razaoSocial": "Made Nova Madeiras Ltda"
}
]
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| idUsuario | Código de identificação do usuário que deseja consultar |
Editar usuário
Exemplo de requisição:
{
"usuario": {
"nome": "Renan",
"email": "renan@teste.com.br",
"dataNascimento": "1998-01-01",
"dataNascimento2": "01/01/2002",
"sexo": "M",
"grupoId": 2,
"parentId": null
},
"contatos": [
{
"tipoContato": 1,
"valorContato": "11888888888"
},
{
"tipoContato": 2,
"valorContato": "11888888888"
}
],
"endereco": {
"logradouro": "Rua Salvador Simoes",
"numero": "801",
"cep": "02920000",
"cidade": "São Paulo",
"estado": "SP",
"complemento": "",
"bairro": "Alto do Ipiranga"
},
"usuarioId": "12991"
}
Requisição PUT com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/usuarios/{usuarioId}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Usuário editado com sucesso.",
"usuario": {
"id": 12991,
"parent_id": null,
"grupo_id": 2,
"endereco_id": 34914,
"nome": "Renan",
"email": "renan@teste.com.br",
"senha": "59657da0958df8d7736be3556867d4f5c2a75806",
"foto": null,
"sexo": "M",
"data_nascimento": "1998-01-01",
"ativo": 1,
"token": "b0241d60dd348d8545a0b3d41d6fe192561b61e4",
"principal_estabelecimento_id": 158,
"created": "2020-08-11T17:25:55.000Z",
"modified": "2020-08-13T17:27:09.122Z",
"removed": null,
"endereco": {
"id": 34914,
"logradouro": "Rua Salvador Simoes",
"numero": "801",
"complemento": "",
"cep": "02920000",
"bairro": "Vila Pereira Barreto",
"cidade": "São Paulo",
"uf": "SP",
"lat": null,
"long": null,
"created": "2020-08-11T17:25:55.000Z",
"modified": "2020-08-13T17:27:09.111Z",
"removed": null
},
"usuarios_contatos": [
{
"id": 628,
"usuario_id": 12991,
"tipo_contato_id": 2,
"nome": "Teste",
"contato": "11888888888",
"created": "2020-08-11T17:25:55.000Z",
"modified": "2020-08-13T17:27:09.147Z",
"removed": null
},
{
"id": 629,
"usuario_id": 12991,
"tipo_contato_id": 1,
"nome": "Teste",
"contato": "11888888888",
"created": "2020-08-11T17:25:55.000Z",
"modified": "2020-08-13T17:27:09.130Z",
"removed": null
}
],
"usuarios_documentos": [
{
"id": 267,
"usuario_id": 12991,
"tipo_documento_id": 2,
"documento": "46122469858",
"arquivo": null,
"created": "2020-08-11T17:25:55.000Z",
"modified": "2020-08-11T17:25:55.000Z",
"removed": null
}
]
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| nome | Nome do usuário | |
| E-mail do usuário | ||
| data de nascimento | Data de nascimento do usuário | |
| sexo | Sexo do usuário | |
| grupoId |
1 = Administrador 2 = Gerencial 3 = Básico 4 = Financeiro 5 = Representante 7 = Backoffice 7 = Representante básico |
|
| parentId | Identifica a qual estabelecimento está vinculado | |
| tipoContato |
1 = Fixo 2 = Celular |
|
| valorContato | Número do telefone | |
| logradouro | Logradouro do endereço da empresa | |
| numero | Número do endereço | |
| cep | Código Postal do endereço da empresa | |
| cidade | Nome da cidade | |
| estado | Código ISO 3166-2 para o estado, com duas letras da empresa | |
| complemento | Complemento do endereço do usuário | |
| bairro | Bairro do endereço do usuário | |
| usuarioId | Código de identificação do usuário |
Excluir usuário
Exemplo de requisição:
{ }
Requisição DELETE com parâmetros na URL:
https://api.zsystems.com.br/usuarios/{idUsuario}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso!"
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| idUsuario | Código de identificação do usuário que deseja excluir |
vendas
Quando um cliente fornece um número de cartão, mas não tem acesso ao cartão físico, a compra é conhecida como uma transação de cartão não presente (CNP). Esse tipo de transação geralmente ocorre através da Internet ou através de um call center.
O recurso de transações é usado para debitar um cartão ou uma conta bancária eletronicamente via ACH. Ele retorna um identificador exclusivo que pode ser posteriormente usado para emitir um reembolso integral ou parcial. Você precisará de um ID de cliente existente (vendedor ou comprador) ou de um método de pagamento válido (cartão ou conta bancária). Tanto o cartão como a conta bancária devem ser um token não usado ou um ID exclusivo existente já associado a um cliente. Alternativamente, você também pode usar um ID de pré-autorização.
Nova venda via cartão de crédito
Exemplo de requisição:
{
"cartao": {
"codigoSeguranca": "270",
"numero": "5216649341292186",
"titular": "Alduir Geronimo",
"validade": "05/2022"
},
"cliente": {
"celular": "12090190912",
"cpf": "54311325045",
"dataNascimento": "1999-09-10",
"email": "alduir@email.com",
"nome": "Alduir Geronimo"
},
"endereco": {
"cep": "02912-000",
"cidade": "São Paulo",
"complemento": "Perto do posto Petrobrás",
"estado": "SP",
"logradouro": "Rua Coronel Bento Bicudo",
"numero": "847"
},
"ip": "201.27.139.162",
"parcelas": 5,
"splits": [
],
"tipoPagamentoId": 3,
"valor": 850
}Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/vendas
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"pedido": {
"id": 7901439,
"parent_id": null,
"tipo_pedido_id": 1,
"usuario_id": 125,
"cliente_id": 5725186,
"estabelecimento_id": 158,
"marketplace_id": null,
"status_pedido_id": 2,
"cliente_cartao_id": 5688319,
"pos_identification_number": null,
"valor_bruto": "850.00",
"valor_liquido": "0.00",
"tipo_pagamento": null,
"bandeira": null,
"parcelas": 5,
"markup": null,
"capture_mode": null,
"splitted": 0,
"oculto": 0,
"splitted_link": 0,
"taxed": 0,
"antecipado": 0,
"referencia": "",
"msg_erro": null,
"created": "2021-02-11T19:32:40.000Z",
"modified": "2021-02-11T19:32:44.000Z",
"removed": null,
"cartaoId": 5688319
}
}
Exemplo de erro :
{
"success": false,
"error": {
"type": "card_error",
"category": "card_declined",
"message": "Transação não autorizada. Para
mais informações, entre em contato com seu banco."
},
"message": "Transação não autorizada. Para
mais informações, entre em contato com seu banco."
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| codigoSeguranca | Código de Segurança ou CVV do cartão | |
| numero | Número do cartão | |
| titular | Nome do titular do cartão | |
| validade | Mês e ano em que o cartão expira sua validade | |
| celular | Número celular do cliente | |
| cpf | CPF do cliente | |
| dataNascimento | Data de nascimento do cliente | |
| E-mail do cliente | ||
| nome | Nome do cliente | |
| cep | Código postal do endereço | |
| cidade | Cidade do endereço | |
| complemento | Complemento do endereço | |
| estado | Código ISO 3166-2 para o estado, com duas letras | |
| logradouro | Rua ou Avenida do endereço | |
| numero | Número do endereço | |
| ip | Identificador da rede ou dispositivo | |
| parcelas | Quantidade de parcelas da compra no cartão | |
| tipoPagamentoId | 1 = Boleto 2 = Débito(Não implementado) 3 = Cartão de crédito |
|
| valor | Valor total da nova venda |
Venda sem enviar e-mail para o cliente
Exemplo de requisição:
{
"cartao": {
"codigoSeguranca": "270",
"numero": "5216649341292186",
"titular": "Alduir Geronimo",
"validade": "05/2023"
},
"cliente": {
"celular": "12090190912",
"cpf": "54311325045",
"dataNascimento": "1999-09-10",
"email": "alduir@email.com",
"nome": "Alduir Geronimo"
},
"endereco": {
"cep": "02912-000",
"cidade": "São Paulo",
"complemento": "Perto do posto Petrobrás",
"estado": "SP",
"logradouro": "Rua Coronel Bento Bicudo",
"numero": "847"
},
"ip": "201.27.139.162",
"parcelas": 1,
"splits": [
],
"tipoPagamentoId": 3,
"email": false,
"valor": 8
}Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/vendas
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"pedido": {
"id": 27496549,
"parent_id": null,
"tipo_pedido_id": 1,
"usuario_id": 125,
"cliente_id": 14715015,
"estabelecimento_id": 158,
"marketplace_id": null,
"status_pedido_id": 2,
"cliente_cartao_id": 13368009,
"pos_identification_number": null,
"valor_bruto": "8.00",
"valor_liquido": "0.00",
"tipo_pagamento": null,
"bandeira": null,
"parcelas": 1,
"markup": null,
"capture_mode": null,
"splitted": 0,
"oculto": 0,
"splitted_taxa_recorrente": 0,
"splitted_invoice": 0,
"splitted_link": 0,
"taxed": 0,
"antecipado": 0,
"referencia": "",
"msg_erro": null,
"created": "2022-06-27T14:34:43.000Z",
"modified": "2022-06-27T14:34:45.000Z",
"removed": null,
"cartaoId": 13368009,
"status_pedido": {
"id": 2,
"titulo": "Aprovado"
}
}
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| codigoSeguranca | Código de Segurança ou CVV do cartão | |
| numero | Número do cartão | |
| titular | Nome do titular do cartão | |
| validade | Mês e ano em que o cartão expira sua validade | |
| celular | Número celular do cliente | |
| cpf | CPF do cliente | |
| dataNascimento | Data de nascimento do cliente | |
| E-mail do cliente | ||
| nome | Nome do cliente | |
| cep | Código postal do endereço | |
| cidade | Cidade do endereço | |
| complemento | Complemento do endereço | |
| estado | Código ISO 3166-2 para o estado, com duas letras | |
| logradouro | Rua ou Avenida do endereço | |
| numero | Número do endereço | |
| ip | Identificador da rede ou dispositivo | |
| parcelas | Quantidade de parcelas da compra no cartão | |
| tipoPagamentoId | 1 = Boleto 2 = Débito(Não implementado) 3 = Cartão de crédito |
|
| true ou false | ||
| valor | Valor total da nova venda |
Nova venda via PIX
Exemplo de requisição:
{
"cliente":{
"celular":"63987222161",
"cpf":"20701528125",
"dataNascimento":"1983-05-02",
"email":"guilherme_melo@netsite.com.br",
"nome":"Guilherme Rodrigo Matheus Melo",
"clienteId":13460961
},
"descricao":"venda pix",
"endereco":{
"cep":"69915-846",
"cidade":"Rio Branco",
"complemento": "",
"estado":"AC",
"logradouro":"Rua Projetada 1029",
"numero":892
},
"estabelecimentoId":158,
"ip":"45.183.240.45",
"splits":[
],
"tipoPagamentoId":5,
"valor":40
}Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/vendas
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"pedido": {
"id": 23437313,
"parent_id": null,
"tipo_pedido_id": 1,
"usuario_id": 1,
"cliente_id": 13464944,
"estabelecimento_id": 158,
"marketplace_id": null,
"status_pedido_id": 1,
"cliente_cartao_id": null,
"pos_identification_number": null,
"valor_bruto": "40.00",
"valor_liquido": "0.00",
"tipo_pagamento": null,
"bandeira": null,
"parcelas": null,
"markup": null,
"capture_mode": null,
"splitted": 0,
"oculto": 0,
"splitted_taxa_recorrente": 0,
"splitted_link": 0,
"taxed": 0,
"antecipado": 0,
"referencia": "",
"msg_erro": null,
"created": "2022-04-20T17:06:16.000Z",
"modified": "2022-04-20T17:06:18.000Z",
"removed": null,
"qrCodePix": "00020101021226770014BR.GOV.BCB.PIX2555api.itau/pix/qr/v2/c8458811-8803-4c1d-aeab-31229b1945dc5204000053039865802BR5925Zoop Tecnologia E Meios D6009SAO PAULO62070503***6304BE40",
"validadePix": "20/04/2022 17:11:17",
"status_pedido": {
"id": 1,
"titulo": "Pendente"
}
}
}
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| celular | Número celular do cliente | |
| cpf | CPF do cliente | |
| dataNascimento | Data de nascimento do cliente | |
| E-mail do cliente | ||
| nome | Nome do cliente | |
| ClienteId | Identificador do cliente já cadastrado | |
| Descrição | Descrição da transação | |
| cep | Código postal do endereço | |
| cidade | Cidade do endereço | |
| complemento | Complemento do endereço | |
| estado | Código ISO 3166-2 para o estado, com duas letras | |
| logradouro | Rua ou Avenida do endereço | |
| numero | Número do endereço | |
| estabelecimentoId | Código de identificação do estabelecimento | |
| ip | Identificador da rede ou dispositivo | |
| tipoPagamentoId | 1 = Boleto 2 = Débito(Não implementado) 3 = Cartão de crédito 5 = PIX |
|
| valor | Valor total da nova venda |
Nova venda via cartão de crédito com cliente já definido
Exemplo de requisição:
{
"tipoPagamentoId": 3,
"clienteId": 5648913,
"splits": [
],
"valor": 640,
"parcelas": 8,
"cartao": {
"titular": "moacir berere",
"numero": "36299109484952",
"codigoSeguranca": "654",
"validade": "07/2021"
},
"ip": "201.27.139.162"
}Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/vendas
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"pedido": {
"id": 7901715,
"parent_id": null,
"tipo_pedido_id": 1,
"usuario_id": 125,
"cliente_id": 5648913,
"estabelecimento_id": 158,
"marketplace_id": null,
"status_pedido_id": 2,
"cliente_cartao_id": 5688515,
"pos_identification_number": null,
"valor_bruto": "640.00",
"valor_liquido": "0.00",
"tipo_pagamento": null,
"bandeira": null,
"parcelas": 8,
"markup": null,
"capture_mode": null,
"splitted": 0,
"oculto": 0,
"splitted_link": 0,
"taxed": 0,
"antecipado": 0,
"referencia": "",
"msg_erro": null,
"created": "2021-02-11T19:46:33.000Z",
"modified": "2021-02-11T19:46:38.000Z",
"removed": null,
"cartaoId": 5688515
}
}
Exemplo de erro :
{
"success": false,
"error": {
"type": "card_error",
"category": "card_declined",
"message": "Transação não autorizada. Para
mais informações, entre em contato com seu banco."
},
"message": "Transação não autorizada. Para
mais informações, entre em contato com seu banco."
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| tipoPagamentoId | 1 = Boleto 2 = Débito(Não implementado) 3 = Cartão de crédito |
|
| clienteId | Identificador do cliente já cadastrado | |
| valor | Valor total da nova venda | |
| parcelas | Quantidade de parcelas da compra no cartão | |
| titular | Nome do titular do cartão | |
| numero | Número do cartão | |
| codigoSeguranca | Código de Segurança ou CVV do cartão | |
| validade | Mês e ano em que o cartão expira sua validade | |
| logradouro | Rua ou avenida do endereço | |
| numero | Número do endereço | |
| cep | Código postal do endereço | |
| cidade | Cidade do endereço | |
| estado | Código ISO 3166-2 para o estado, com duas letras | |
| complemento | Complemento do endereço | |
| ip | Identificador da rede ou dispositivo |
NOVA VENDA VIA CARTAO DE CREDITO COM CLIENTE E CARTAO JA DEFINIDOS
Exemplo de requisição:
{
"clienteId": 5724394,
"cartaoId": 5687542,
"tipoPagamentoId": 3,
"splits": [
],
"valor": 930,
"parcelas": 10,
"ip": "201.27.139.162"
}Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/vendas
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"pedido": {
"id": 7901001,
"parent_id": null,
"tipo_pedido_id": 1,
"usuario_id": 125,
"cliente_id": 5724394,
"estabelecimento_id": 158,
"marketplace_id": null,
"status_pedido_id": 2,
"cliente_cartao_id": 5687542,
"pos_identification_number": null,
"valor_bruto": "930.00",
"valor_liquido": "0.00",
"tipo_pagamento": null,
"bandeira": null,
"parcelas": 10,
"markup": null,
"capture_mode": null,
"splitted": 0,
"oculto": 0,
"splitted_link": 0,
"taxed": 0,
"antecipado": 0,
"referencia": "",
"msg_erro": null,
"created": "2021-02-11T19:11:01.000Z",
"modified": "2021-02-11T19:11:05.000Z",
"removed": null,
"cartaoId": 5687542
}
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| clienteId | Código de identificação do cliente | |
| cartaoId | Código de identificaçaõ do cartão de crédito | |
| tipoPagamentoId | 1 = Boleto 2 = Débito(Não implementado) 3 = Cartão de crédito |
|
| valor | Valor total da nova venda | |
| parcelas | Quantidade de parcelas da compra no cartão | |
| ip | Identificador da rede ou dispositivo |
Estornar venda via cartão de crédito
Exemplo de requisição:
{ }Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/vendas/{pedidoId}/estornar
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso."
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| PedidoId | Identificação do pedido já criado |
Nova venda via boleto
Exemplo de requisição:
{
"tipoPagamentoId": 1,
"splits": [
],
"valor": 10.50,
"dataVencimento": "2022-04-20",
"descricao": "Boleto de teste diogo",
"cliente": {
"nome": "Diogo Oliver Almada",
"cpf": "64751686020",
"dataNascimento": "1954-03-23",
"email": "diogo-almada93@semco.com.br",
"celular": "4426434316"
},
"endereco": {
"logradouro": "Rua das Petúnias",
"numero": 177,
"cep": "87308-175",
"cidade": "São Paulo",
"estado": "SP",
"complemento": ""
},
"ip": "201.27.139.162"
}
Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/vendas
header: ContentType application/json
authorization Bearer 'Token API'
O valor mínimo do boleto é R$ 5,00
Exemplo de resultado :
{
"success": true,
"pedido": {
"id": 7844429,
"parent_id": null,
"tipo_pedido_id": 1,
"usuario_id": 125,
"cliente_id": 5699915,
"estabelecimento_id": 158,
"marketplace_id": null,
"status_pedido_id": 1,
"cliente_cartao_id": null,
"pos_identification_number": null,
"valor_bruto": "230.00",
"valor_liquido": "0.00",
"tipo_pagamento": null,
"bandeira": null,
"parcelas": null,
"markup": null,
"capture_mode": null,
"splitted": 0,
"oculto": 0,
"splitted_link": 0,
"taxed": 0,
"antecipado": 0,
"referencia": "",
"msg_erro": null,
"created": "2021-02-09T17:28:13.000Z",
"modified": "2021-02-09T17:28:15.000Z",
"removed": null,
"urlBoleto": "https://api-boleto-production.s3.amazonaws.com/6bc96895695342919afb9d9036510977/476cf826cf1d43d2a48c35307e6cb4c6/6022c62f678fed08db978147.html",
"boleto": {
"id": 1006761,
"url": "https://api-boleto-production.s3.amazonaws.com/6bc96895695342919afb9d9036510977/476cf826cf1d43d2a48c35307e6cb4c6/6022c62f678fed08db978147.html",
"codigo_barras": "34191091070639421893431977690002185310000023000",
"data_vencimento": "2021-02-13",
"modified": "2021-02-09T17:28:15.623Z",
"created": "2021-02-09T17:28:15.623Z"
}
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| tipoPagamentoId | 1 = Boleto 2 = Débito(Não implementado) 3 = Cartão de crédito |
|
| valor | Valor a ser transferido, utilizando .(ponto) em vez de ,(vírgula) para casas decimais. Ex.: para transferir R$ 100,00 utiliza-se 100.00 ; para R$ 0,21 utiliza-se 0.21 | |
| chargeProcessingFee |
0 = Bruto 1 = Líquido |
|
| valor | Valor total do boleto | |
| dataVencimento | Data que o boleto irá vencer | |
| descricao | Descrição da transação | |
| nome | Nome do cliente | |
| cpf | CPF do cliente | |
| dataNascimento | Data de nascimento do cliente | |
| E-mail do cliente | ||
| celular | Número celular do cliente | |
| logradouro | Rua ou Avenida do endereço | |
| numero | Número do endereço | |
| cep | Código postal do endereço | |
| cidade | Cidade do endereço | |
| estado | Código ISO 3166-2 para o estado, com duas letras | |
| complemento | Complemento do endereço | |
| ip | Identificador da rede ou dispositivo |
Nova venda via boleto com cliente já definido
Exemplo de requisição:
{
"tipoPagamentoId": 1,
"splits": [
],
"valor": 980,
"dataVencimento": "2022-05-20",
"descricao": "teste de venda ",
"clienteId": 13363443
}
Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/vendas
header: ContentType application/json
authorization Bearer 'Token API'
O valor mínimo do boleto é R$ 5,00
Exemplo de resultado :
{
"success": true,
"pedido": {
"id": 24173165,
"parent_id": null,
"tipo_pedido_id": 1,
"usuario_id": 125,
"cliente_id": 13363443,
"estabelecimento_id": 158,
"marketplace_id": null,
"status_pedido_id": 1,
"cliente_cartao_id": null,
"pos_identification_number": null,
"valor_bruto": "980.00",
"valor_liquido": "0.00",
"tipo_pagamento": null,
"bandeira": null,
"parcelas": null,
"markup": null,
"capture_mode": null,
"splitted": 0,
"oculto": 0,
"splitted_taxa_recorrente": 0,
"splitted_link": 0,
"taxed": 0,
"antecipado": 0,
"referencia": "",
"msg_erro": null,
"created": "2022-05-04T13:44:44.000Z",
"modified": "2022-05-04T13:44:48.000Z",
"removed": null,
"urlBoleto": "https://api-boleto-production.s3.amazonaws.com/6bc96895695342919afb9d9036510977/476cf826cf1d43d2a48c35307e6cb4c6/627283503b8d30079c567133.html",
"boleto": {
"id": 7736238,
"url": "https://api-boleto-production.s3.amazonaws.com/6bc96895695342919afb9d9036510977/476cf826cf1d43d2a48c35307e6cb4c6/627283503b8d30079c567133.html",
"codigo_barras": "34191092220541801893231339210002489780000098000",
"descricao": "teste de venda ",
"data_vencimento": "2022-05-07",
"modified": "2022-05-04T13:44:48.457Z",
"created": "2022-05-04T13:44:48.457Z"
},
"status_pedido": {
"id": 1,
"titulo": "Pendente"
}
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| tipoPagamentoId | 1 = Boleto 2 = Débito(Não implementado) 3 = Cartão de crédito |
|
| valor | Valor a ser transferido, utilizando .(ponto) em vez de ,(vírgula) para casas decimais. Ex.: para transferir R$ 100,00 utiliza-se 100.00 ; para R$ 0,21 utiliza-se 0.21 | |
| valor | Valor total do boleto | |
| dataVencimento | Data que o boleto irá vencer | |
| descricao | Descrição da transação | |
| clienteId | Identificador do cliente já cadastrado |
Nova venda com split
Exemplo de requisição:
{
"tipoPagamentoId": 3,
"splits": [
{
"estabelecimentoId": 10564,
"tipoSplit": 2,
"valor": 10
}
],
"valor": 65,
"parcelas": 12,
"cartao": {
"titular": "altair antunes",
"numero": "36359579152636",
"codigoSeguranca": "139",
"validade": "11/2022"
},
"cliente": {
"nome": "Altair Antunes",
"cpf": "30024289060",
"dataNascimento": "1985-03-10",
"email": "altair@email.com",
"celular": "12901021030"
},
"endereco": {
"logradouro": "Rua Luís de Andrade",
"numero": "594",
"cep": "02920-000",
"cidade": "São Paulo",
"estado": "SP",
"complemento": "ap 5a"
},
"ip": "201.27.139.162"
}Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/vendas
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"pedido": {
"id": 7902204,
"parent_id": null,
"tipo_pedido_id": 1,
"usuario_id": 125,
"cliente_id": 5725687,
"estabelecimento_id": 158,
"marketplace_id": null,
"status_pedido_id": 2,
"cliente_cartao_id": 5688821,
"pos_identification_number": null,
"valor_bruto": "65.00",
"valor_liquido": "0.00",
"tipo_pagamento": null,
"bandeira": null,
"parcelas": 12,
"markup": null,
"capture_mode": null,
"splitted": 0,
"oculto": 0,
"splitted_link": 0,
"taxed": 0,
"antecipado": 0,
"referencia": "",
"msg_erro": null,
"created": "2021-02-11T20:14:00.000Z",
"modified": "2021-02-11T20:14:04.000Z",
"removed": null,
"cartaoId": 5688821
}
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| tipoPagamentoId | 1 = Boleto 2 = Débito(Não implementado) 3 = Cartão de crédito |
|
| splits: estabelecimentoId | Código de identificação do estabelecimento que receberá Split | |
| splits: tipoSplit |
2 = Percentual |
|
| splits: valor | Valor do Split em porcentagem | |
| valor | Valor total da nova venda | |
| parcelas | Quantidade de parcelas da compra no cartão | |
| titular | Nome do titular do cartão | |
| numero | Número do cartão | |
| codigoSeguranca | Código de Segurança ou CVV do cartão | |
| validade | Mês e ano em que o cartão expira sua validade | |
| nome | Nome do cliente | |
| cpf | CPF do cliente | |
| dataNascimento | Data de nascimento do cliente | |
| E-mail do cliente | ||
| celular | Número celular do cliente | |
| logradouro | Rua ou Avenida do endereço | |
| numero | Número do endereço | |
| cep | Código postal do endereço | |
| cidade | Cidade do endereço | |
| estado | Código ISO 3166-2 para o estado, com duas letras | |
| complemento | Complemento do endereço | |
| ip | Identificador da rede ou dispositivo |
Nova pré captura via cartão de credito
Exemplo de requisição:
{
"tipoPagamentoId": 3,
"valor":1.00,
"cartaoId": 1234,
"clienteId":17188
}Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/vendas/pre_captura
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso",
"pedido": {
"id": 20212,
"parent_id": null,
"tipo_pedido_id": 1,
"cliente_id": 17881,
"estabelecimento_id": 131,
"status_pedido_id": 8,
"cliente": {
"id": 17881,
"nome": "João Paulo",
"email": "teste2@zsystems.com.br"
},
"status_pedido": {
"id": 8,
"titulo": "Pré Autorizado"
},
"pedidos_produtos": [
{
"id": 428,
"pedido_id": 20212,
"valor_unitario": "1.00",
"quantidade": 1
}
],
"pagamentos": [
{
"id": 20562,
"tipo_pagamento_id": 3,
"status_pagamento_id": 5,
"pedido_id": 20212,
"valor": "1.00",
"taxa": "0.00",
"data_recebimento": "2020-02-07T21:14:10.000Z",
"valor_recebido": "0.00",
"data_pagamento": null,
"tipo_pagamento": {
"id": 3,
"titulo": "Cartão de Crédito"
},
"status_pagamento": {
"id": 5,
"titulo": "Pré autorizado"
}
}
]
}
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| tipoPagamentoId | 1 = Boleto 2 = Débito(Não implementado) 3 = Cartão de crédito |
|
| valor | Valor a ser transferido, utilizando .(ponto) em vez de ,(vírgula) para casas decimais. Ex.: para transferir R$ 100,00 utiliza-se 100.00 ; para R$ 0,21 utiliza-se 0.21 | |
| cartaoId | Identificador do cartão já cadastrado | |
| clienteId | Identificador do cliente já cadastrado |
Executar venda pré capturada via cartão de credito
Exemplo de requisição:
{
"pedidoId": 20212
}Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/vendas/captura
header: ContentType application/json
authorization Bearer 'Token API'
Note que o array de pagamentos está vazio, pois estamos processando a requisição dentro de alguns segundos o valor estará preenchido e você receberá um webhook avisando sobre o pedido o recebível.
Exemplo de resultado :
{
"success": true,
"message": "Operação efetuada com sucesso",
"pedido": {
"id": 20212,
"parent_id": null,
"tipo_pedido_id": 1,
"cliente_id": 17881,
"estabelecimento_id": 131,
"status_pedido_id": 2,
"cliente": {
"id": 17881,
"nome": "João Paulo",
"email": "teste2@zsystems.com.br"
},
"status_pedido": {
"id": 2,
"titulo": "Aprovado"
},
"pedidos_produtos": [
{
"id": 428,
"pedido_id": 20212,
"valor_unitario": "1.00",
"quantidade": 1
}
],
"pagamentos": []
}
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| valor | Valor a ser transferido, utilizando .(ponto) em vez de ,(vírgula) para casas decimais. Ex.: para transferir R$ 100,00 utiliza-se 100.00 ; para R$ 0,21 utiliza-se 0.21 | |
| cartaoId | Identificador do cartão já cadastrado | |
| clienteId | Identificador do cliente já cadastrado |
Verificar as informações de uma venda
Exemplo de requisição:
{ }Requisição GET com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/vendas/{vendaId}/dados
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Venda",
"venda": {
"id": 42789090,
"parent_id": null,
"zoop_transaction_id": "07291c6cbe714021aba67322cd00306a",
"tipo_pedido_id": 1,
"created": "2023-01-10T21:18:49.000Z",
"msg_erro": null,
"oculto": false,
"pos": null,
"tipoPagamento": {
"id": 3,
"titulo": "Cartão de Crédito",
"cartaoCredito": {
"id": 18600853,
"nome_titular": "Tiago Silva",
"bandeira": "Mastercard",
"ultimos_digitos": 719,
"ano_expiracao": 2024,
"mes_expiracao": 12,
"cliente_id": 20004179
},
"boleto": null
},
"valores": {
"total": "8.99",
"taxa": 0.36,
"splits": 0,
"liquido": 8.63,
"splits2": {},
"taxas": {},
"markup": null,
"taxaAntecipacao": 0,
"taxaTotal": 0,
"splitNormal": 0,
"taxaCusto": 0,
"spread": 0
},
"status": {
"id": 2,
"titulo": "Aprovado"
},
"cliente": {
"nome": "Tiago Silva",
"email": "tiagoluizrs@gmail.com",
"clientes_documentos": [
{
"documento": "14722549702"
}
]
},
"estabelecimento": {
"id": 158,
"nome_fantasia": "Made Nova Madeiras Ltda",
"razao_social": "Made Nova Madeiras Ltda",
"arquivo": {
"url": "https://z-systems-bucket.s3.sa-east-1.amazonaws.com/files/estabelecimentos/logos/1657051509122_logo-necta.png"
}
},
"produtos": [
{
"valorUnitario": "8.99",
"quantidade": 1,
"nome": "Venda via API"
}
],
"pagamentos": [
{
"id": 143135247,
"valor": 8.99,
"taxa": "0.36",
"valorRecebido": "8.63",
"tipoPagamento": {
"id": 3,
"titulo": "Cartão de Crédito"
},
"statusPagamento": {
"id": 1,
"titulo": "Pendente"
},
"dataRecebimento": "2023-02-09T03:00:00.000Z",
"dataPagamento": null,
"parcela": 1,
"pagamentoCartao": {
"id": 18600853,
"nome_titular": "Tiago Silva",
"bandeira": "Mastercard",
"ultimos_digitos": 719,
"ano_expiracao": 2024,
"mes_expiracao": 12,
"cliente_id": 20004179
},
"pagamentoBoleto": null
}
],
"splitParcela": "0.00",
"splitParcelaFinal": "0.00",
"spreadParcela": 0,
"spreadParcelaFinal": 0,
"taxas": 0,
"markup": null,
"spread": 0,
"split": 0,
"splitsNormais": [],
"ecMarkup": 0,
"taxasFinais": {
"taxaZoop": 0.36,
"splits": 0,
"taxaSpread": 0,
"taxaVendaOnline": 0,
"markupEC": 0,
"markup": 0,
"markupFilho": 0,
"taxaTotal": 0.36
},
"descontos": [],
"authorization_code": "000000",
"authorization_nsu": "00000000000000000"
}
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| vendaId | Identificação da venda já criada |
Listar Vendas
Exemplo de requisição:
{
page: 1,
limit: 200,
startDate: 2024-03-21T03:00:00.000Z,
endDate: 2024-03-21T19:40:55.525Z,
reference:
valor: 0
valor2: 0
omni:
omni2:
pos:
}
Requisição GET para o seguinte URL:
https://api.zsystems.com.br/vendas/lista
header: ContentType application/json
authorization Bearer 'Token API'
Converter parâmetros de entrada de JSON para Query String para utilização na URL
Exemplo de resultado :
{
"success": true,
"message": "Vendas",
"vendas": [
{
"id": 115697579,
"cliente": {
"id": 38481464,
"nome": "MARLENE LUIZA PONTES"
},
"estabelecimento": {
"id": 144778,
"nome_fantasia": "drogaria santa luzia"
},
"created": "2024-03-21T19:36:52.000Z",
"modified": "2024-03-21T19:37:59.000Z",
"bandeira": "elo",
"removed": null,
"parcelas": 1,
"pos_identification_number": "22dfe65c8514413eb6fbd32126424296",
"nsu": "359921766",
"authorization_code": "784061",
"status_pedido_id": 2,
"tipo_pagamento": "debit",
"valor_bruto": "131.00",
"valor_liquido": 127.80000000000001
},
{
"id": 115696326,
"cliente": {
"id": 38481011,
"nome": "Sem Nome - fb74b1fe3c754d12bdcda7060645e22b"
},
"estabelecimento": {
"id": 149836,
"nome_fantasia": "Restaurante Meia Ponte"
},
"created": "2024-03-21T19:27:47.000Z",
"modified": "2024-03-21T19:28:38.000Z",
"bandeira": "maestro",
"removed": null,
"parcelas": 1,
"pos_identification_number": "68541a36434f4683bc470c04a37cbd99",
"nsu": "359509434",
"authorization_code": "418913",
"status_pedido_id": 2,
"tipo_pagamento": "debit",
"valor_bruto": "26.50",
"valor_liquido": 26.09
}
]
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| Page | Número atual da página | |
| Limit | Define a quantidade de vendas a serem exibidos por página | |
| StartDate | Data inicial a ser pesquisada | |
| EndDate | Data final a ser pesquisada | |
| Reference | Campo para indentificação das transações | |
| Valor | Valor Bruto | |
| Valor 2 | Valor liquido | |
| Omni | Valor bruto | |
| Omni2 | Nome do estabeleciemento | |
| Pos | Identificador do numero da venda |
Cadastrar split em uma venda ja realizada com porcentagem
Exemplo de requisição:
{
"pedidoId": "48818058",
"percentual": "1",
"estabelecimentoId": "12309",
}
Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/vendas/split
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso",
"pedido": {
"id": 48818058,
"parent_id": null,
"tipo_pedido_id": 3,
"cliente_id": 5138782,
"estabelecimento_id": 158,
"status_pedido_id": 2,
"cliente": {
"id": 5138782,
"nome": "aaaa",
"email": "douglas@w3.care"
},
"status_pedido": {
"id": 2,
"titulo": "Aprovado"
},
"pedidos_produtos": [],
"pagamentos": [
{
"id": 158756856,
"tipo_pagamento_id": 3,
"status_pagamento_id": 1,
"pedido_id": 48818058,
"valor": "149.90",
"taxa": "5.98",
"data_recebimento": "2023-04-24T03:00:00.000Z",
"valor_recebido": "143.92",
"data_pagamento": null,
"tipo_pagamento": {
"id": 3,
"titulo": "Cartão de Crédito"
},
"status_pagamento": {
"id": 1,
"titulo": "Pendente"
}
}
]
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| pedidoId | Id da venda que vai receber a regra de split | |
| percentual | O Valor em centavos a ser splitado | |
| estabelecimentoId | Id do estabelecimento que recebera o split |
Cadastrar split em uma venda ja realizada com valor real
Exemplo de requisição:
{
"pedidoId": "48818058",
"amount": "10",
"estabelecimentoId": "12309",
}
Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/vendas/split
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso",
"pedido": {
"id": 48818058,
"parent_id": null,
"tipo_pedido_id": 3,
"cliente_id": 5138782,
"estabelecimento_id": 158,
"status_pedido_id": 2,
"cliente": {
"id": 5138782,
"nome": "aaaa",
"email": "douglas@w3.care"
},
"status_pedido": {
"id": 2,
"titulo": "Aprovado"
},
"pedidos_produtos": [],
"pagamentos": [
{
"id": 158756856,
"tipo_pagamento_id": 3,
"status_pagamento_id": 1,
"pedido_id": 48818058,
"valor": "149.90",
"taxa": "5.98",
"data_recebimento": "2023-04-24T03:00:00.000Z",
"valor_recebido": "143.92",
"data_pagamento": null,
"tipo_pagamento": {
"id": 3,
"titulo": "Cartão de Crédito"
},
"status_pagamento": {
"id": 1,
"titulo": "Pendente"
}
}
]
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| pedidoId | Id da venda que vai receber a regra de split | |
| estabelecimentoId | Id do estabelecimento que recebera o split | |
| amount | O Valor em centavos a ser splitado |
Autorização direta
Exemplo de requisição:
{
"description": "description description",
"capture": true,
"amount": 19,
"card": {
"cardNumber": "0000484668230000",
"holderName": "Dayglor Campos",
"expirationMonth": "07",
"expirationYear": "2031",
"securityCode": "807"
},
"installments": 1
}
Requisição POST com objetos JSON para o seguinte URL:
https://api-v2.zsystems.com.br/transaction/direct-authorization
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"transaction": "286f3b0dd2954850b23abe925967ce4d",
}
PARÂMETROS
| Id | Descrição | |
|---|---|---|
| description | Descrição da autorização | |
| capture | A transação será capturada agora? (true) | |
| amount | O Valor em centavos | |
| card |
cardNumber = Número do cartão holderName = Nome no cartão expirationMonth = Mês de validade do cartão expirationYear = Ano de validade do cartão securityCode = Código de segurança do cartão |
|
| installments | Número de parcelas |
Links de Pagamentos
Pagar através de um link é um modelo que permite que o lojista envie um link para o cliente realizar o pagamento. O consumidor não precisa acessar a loja online, selecionar os produtos nem finalizar a compra.
Criar um link de pagamento sem juros e split
Exemplo de requisição:
{
"id": null,
"titulo": "Link de pagamento sem juros e split",
"descricao": "Sem juros e split",
"amount": 150000,
"parcelamento_ate": 3,
"meio_pagamento": 3,
"data_expiracao": "2021-03-11T19:51:37.668Z",
"logo": true,
"split": false,
"token": null,
"nome_fantasia": "",
"pedidos": [],
"juros": false,
"percentual": 0,
"juros_a_partir": 2,
"chargeProcessingFee": true,
"splits": [],
"repassarTaxaCliente": false,
}
Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/pre_venda
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"preVenda": {
"repassar_taxa_cliente": false,
"ativo": true,
"id": 57733,
"titulo": "Link de pagamento sem juros e split",
"descricao": "Sem juros e split",
"amount": 150000,
"parcelamento_ate": 3,
"data_expiracao": "2021-03-11T19:51:37.668Z",
"logo": true,
"token": "1581612900454136",
"juros": 0,
"juros_a_partir": 0,
"estabelecimento_id": 158,
"tipo_pagamento_id": 3,
"updatedAt": "2021-02-09T19:54:14.137Z",
"createdAt": "2021-02-09T19:54:14.137Z",
"estabelecimento": {
"id": 158,
"status_estabelecimento_id": 2,
"categoria_estabelecimento_id": 1,
"endereco_id": 247,
"logo_id": null,
"logo_boleto_id": null,
"razao_social": "Made Nova Madeiras Ltda",
"nome_fantasia": "Made Nova Madeiras Ltda",
"identificacao_fatura": "madepag",
"identificador_plano": null,
"observacao": null,
"ativo": 1,
"data_nascimento": null,
"mcc": 104,
"data_desabilitado": null,
"termos_condicoes_aceito": true,
"termos_condicoes_aceito_data": "2020-12-09T15:32:12.000Z",
"termos_condicoes_aceito_usuario_id": 125,
"created": "2019-12-19T14:04:00.000Z",
"modified": "2021-01-08T14:15:52.000Z",
"removed": null
},
"link": "http://sandbox.z4money.com.br/app/lp/1581612900454136"
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| id | Código de identificação do link de pagamento | |
| titulo | Título do link de pagamento | |
| descricao | Descrição do link de pagamento | |
| amount | Valor da recorrência, ex.: 25 = R$ 0.25, 100 = R$ 1.00, 10000 = R$ 100.00 | |
| parcelamento_ate | Define a quantidade de parcelas a serem pagas | |
| meio_pagamento | Define a forma de pagamento | |
| data_expiracao | Define a data de vencimento do link de pagamento | |
| logo | Define se o logo do estabelecimento será exibido ou não | |
| split | Define se o valor recebido do link de pagamento terá ou não configuração de split | |
| token | Código de autenticação | |
| nome_fantasia | Nome fantasia | |
| juros | Define se serão cobrados juros nas vendas de cartão de crédito parcelado | |
| percentual | Define o percentual de juros a ser cobrado nas vendas de cartão de crédito parcelado | |
| juros_a_partir | Define a partir de qual parcela que os juros serão cobrados | |
| chargeProcessingFee |
0 = Bruto 1 = Líquido |
Criar um link de pagamento com juros
Exemplo de requisição:
{
"id": null,
"titulo": "Link de pagamento com juros e split",
"descricao": "Link com juros e split",
"amount": 275000,
"parcelamento_ate": 12,
"meio_pagamento": 3,
"data_expiracao": "2021-03-11T20:12:00.830Z",
"logo": true,
"split": true,
"token": null,
"nome_fantasia": "",
"pedidos": [],
"juros": false,
"percentual": 0,
"juros_a_partir": 2,
"chargeProcessingFee": true,
"splits": [
{
"estabelecimentoId": 16778,
"cpfcnpj": "26044977005",
"nome": "Arya Stark",
"email": "5fd9efb161768501380332c2@w3.care",
"value": 0,
"tipoSplit": 2,
"chargeProcessingFee": true,
"valor": 2
}
],
"repassarTaxaCliente": false,
"ip": "201.27.139.162"
}
Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/pre_venda
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"preVenda": {
"repassar_taxa_cliente": false,
"ativo": true,
"id": 57735,
"titulo": "Link de pagamento com juros e split",
"descricao": "Link com juros e split",
"amount": 275000,
"parcelamento_ate": 12,
"data_expiracao": "2021-03-11T20:12:00.830Z",
"logo": true,
"token": "1581612901921552",
"juros": 0,
"juros_a_partir": 0,
"estabelecimento_id": 158,
"tipo_pagamento_id": 3,
"updatedAt": "2021-02-09T20:18:41.552Z",
"createdAt": "2021-02-09T20:18:41.552Z",
"estabelecimento": {
"id": 158,
"status_estabelecimento_id": 2,
"categoria_estabelecimento_id": 1,
"endereco_id": 247,
"logo_id": null,
"logo_boleto_id": null,
"razao_social": "Made Nova Madeiras Ltda",
"nome_fantasia": "Made Nova Madeiras Ltda",
"identificacao_fatura": "madepag",
"identificador_plano": null,
"observacao": null,
"ativo": 1,
"data_nascimento": null,
"mcc": 104,
"data_desabilitado": null,
"termos_condicoes_aceito": true,
"termos_condicoes_aceito_data": "2020-12-09T15:32:12.000Z",
"termos_condicoes_aceito_usuario_id": 125,
"created": "2019-12-19T14:04:00.000Z",
"modified": "2021-01-08T14:15:52.000Z",
"removed": null
},
"link": "http://sandbox.z4money.com.br/app/lp/1581612901921552"
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| id | Código de identificação do link de pagamento | |
| titulo | Título do link de pagamento | |
| descricao | Descrição do link de pagamento | |
| amount | Valor da recorrência, ex.: 25 = R$ 0.25, 100 = R$ 1.00, 10000 = R$ 100.00 | |
| parcelamento_ate | Define a quantidade de parcelas a serem pagas | |
| meio_pagamento | Define a forma de pagamento | |
| data_expiracao | Define a data de vencimento do link de pagamento | |
| logo | Define se o logo do estabelecimento será exibido ou não | |
| split | Define se o valor recebido do link de pagamento terá ou não configuração de split | |
| token | Código de autenticação | |
| nome_fantasia | Nome fantasia | |
| juros | Define se serão cobrados juros nas vendas de cartão de crédito parcelado | |
| percentual | Define o percentual de juros a ser cobrado nas vendas de cartão de crédito parcelado | |
| juros_a_partir | Define a partir de qual parcela que os juros serão cobrados | |
| chargeProcessingFee |
0 = Bruto 1 = Líquido |
|
| estabelecimentoId | Código de identificação do estabelecimento que receberá Split | |
| cpfcnpj | Número do documento do estabelecimento que receberá Split | |
| nome | Nome do estabelecimento que receberá Split | |
| E-mail do estabelecimento que receberá Split | ||
| value | Valor do Split a ser recebido em porcentagem | |
| tipoSplit |
2 = Percentual |
|
| ip | Identificador da rede ou dispositivo |
Listar links de pagamentos
Exemplo de requisição:
{ }
Requisição GET com parâmetros na URL:
https://api.zsystems.com.br/pre_venda
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"paginas": 39,
"quantidade": 77,
"pre_vendas": [
{
"id": 956,
"estabelecimento_id": 158,
"tipo_pagamento_id": 3,
"juros_a_partir": 2,
"juros": 1.11,
"titulo": "Teste",
"descricao": "Teste",
"parcelamento_ate": 2,
"amount": "150000",
"token": "24a7fc64ef13dd255276e140e62a7658233ff077",
"pedido_id": null,
"data_expiracao": "2020-09-16T20:04:09.000Z",
"ativo": true,
"logo": true,
"createdAt": "2020-08-17T20:05:11.000Z",
"updatedAt": "2020-08-17T20:05:11.000Z",
"removedAt": null,
"estabelecimento": {
"nome_fantasia": "Made Nova Madeiras Ltda"
},
"pre_venda_pedidos": []
},
{
"id": 947,
"estabelecimento_id": 158,
"tipo_pagamento_id": 3,
"juros_a_partir": 0,
"juros": 0,
"titulo": "A - Compra de Ativo Digital",
"descricao": "50 unidades de TREEPS",
"parcelamento_ate": 5,
"amount": "3500",
"token": "fef220fe1c1d98555bf7eeeec20023540645510d",
"pedido_id": null,
"data_expiracao": "2020-09-15T18:42:10.000Z",
"ativo": true,
"logo": true,
"createdAt": "2020-08-16T18:42:52.000Z",
"updatedAt": "2020-08-16T18:42:52.000Z",
"removedAt": null,
"estabelecimento": {
"nome_fantasia": "Made Nova Madeiras Ltda"
},
"pre_venda_pedidos": []
}
]
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|
Consultar Link de pagamento
Exemplo de requisição:
{ }
Requisição GET com parâmetros URL:
https://api.zsystems.com.br/pre_venda/{id_pre_venda}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"preVenda": {
"id": 906,
"estabelecimento_id": 158,
"tipo_pagamento_id": 3,
"juros_a_partir": 0,
"juros": 0,
"titulo": "Teste",
"descricao": "Teste",
"parcelamento_ate": 1,
"amount": "15000",
"token": "a7d941e702ccba9d8c7a9d04253d20eb6a8a0ad3",
"pedido_id": null,
"data_expiracao": "2020-09-09T20:58:22.000Z",
"ativo": true,
"logo": true,
"createdAt": "2020-08-10T20:58:57.000Z",
"updatedAt": "2020-08-10T20:58:57.000Z",
"removedAt": null,
"estabelecimento": {
"id": 158,
"nome_fantasia": "Made Nova Madeiras Ltda",
"razao_social": "Made Nova Madeiras Ltda"
},
"pre_venda_pedidos": []
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| id_pre_venda | Código de identificação do link de pagamento que deseja consultar |
Excluir link de pagamento
Exemplo de requisição:
{ }
Requisição DELETE com Parâmetros na URL:
https://api.zsystems.com.br/pre_venda/{id_pre_venda}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| id_pre_venda | Código de identificação do link de pagamento que deseja excluir |
Link de pagamento por boleto ou cartão de crédito
Exemplo de requisição:
{
amount:1000
chargeProcessingFee: true
data_expiracao: "2023-09-30T18:41:26.802Z"
descricao:"testelinkdesc"
email: "didiego@gmail.com"
juros: false
juros_a_partir: 2
logo: true
meio_pagamento: 8
nome_fantasia: ""
parcelamento_ate: 1
percentual: 0
repassarTaxaCliente: false
split: false
splits: [
{
estabelecimentoId: false,
cpfcnpj: "",
nome: "",
email: "",
value: 0,
tipoSplit: 2
},
{
estabelecimentoId: false,
cpfcnpj: "",
nome: "",
email: "",
value: 0,
tipoSplit: 2
}
]
titulo: "testelink"
}
Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/pre_venda
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"preVenda": {
"repassar_taxa_cliente": false,
"ativo": true,
"id": 137990,
"titulo": "testelink",
"descricao": "testelinkdesc",
"email": "didiego@gmail.com",
"amount": 1000,
"parcelamento_ate": 1,
"data_expiracao": "2023-09-30T18:41:26.802Z",
"logo": true,
"token": "1581693507368891",
"juros": 0,
"juros_a_partir": 0,
"usuario_id": 125,
"estabelecimento_id": 158,
"tipo_pagamento_id": 8,
"updatedAt": "2023-08-31T18:42:48.892Z",
"createdAt": "2023-08-31T18:42:48.892Z",
"estabelecimento": {
"id": 158,
"status_estabelecimento_id": 2,
"categoria_estabelecimento_id": 1,
"endereco_id": 247,
"logo_id": 200339,
"logo_boleto_id": 199934,
"logo_email_id": 200340,
"razao_social": "Made Nova Madeiras Ltda",
"nome_fantasia": "Made Nova Madeiras Ltda",
"identificacao_fatura": "madepag",
"identificador_plano": null,
"observacao": null,
"ativo": 1,
"data_nascimento": null,
"mcc": 104,
"data_desabilitado": null,
"termos_condicoes_aceito": true,
"termos_condicoes_aceito_data": "2020-12-09T15:32:12.000Z",
"termos_condicoes_aceito_usuario_id": 125,
"termos_condicoes_aceito_ip": "",
"inativo_desde": null,
"created": "2019-12-19T14:04:00.000Z",
"modified": "2023-06-21T19:20:44.000Z",
"removed": null
},
"link": "https://sandbox.z4money.com.br/app/lp/1581693507368891"
}
}
PARÂMETROS
| Id | Descrição | |
|---|---|---|
| amount | Valor em centavos | |
| chargeProcessingFee | O Split vai ser em cima do valor liquido? (true) | |
| data_expiracao | Data de expiração | |
| descricao | Descrição do pagamento | |
| Email de quem será notificado | ||
| juros | Haverá juros? (true ou false) | |
| juros_a_partir | A partir de qual parcela haverá juros? | |
| logo | Há logo? (true ou false) | |
| meio_pagamento | ID do meio de pagamento | |
| nome_fantasia | Nome fantasia | |
| parcelamento_ate | Número máximo de parcelas | |
| percentual | Percentual de juros | |
| repassarTaxaCliente | Vai repassar a taxa para o cliente? | |
| split | Haverá split? (true ou false) | |
| splits |
[{ estabelecimentoId: false,Há estabelecimento vinculado? (true ou false) cpfcnpj = Cpf ou Cnpj do estabelecimento nome = Nome do estabelecimento email = Email do estabelecimento value = Valor do split tipoSplit: 2 = Informar id do tipo do split ]} |
|
| titulo | Título do link de pagamento |
Planos
Um plano define como assinaturas serão vendidas, renovadas e faturadas. Por exemplo, uma academia pode possuir um "Plano mensal" que é renovado automaticamente todo mês, ou um "Plano bimestral", renovado automaticamente a cada dois meses.
Na criação de planos é possível informar a frequência (frequency) de cobrança do plano, podendo ser diário, mensal, semanal ou anual, bem como o intervalo (interval) de cobrança com base na frequência definida, ou seja, caso a frequência seja mensal e o intervalo dois (02) a cobrança será feita a cada dois meses.
Planos são gerenciados por marketplace, sendo possível criar múltiplos planos com diferentes políticas de cobrança, cada qual com seu valor em centavos, formas de pagamentos permitidas, período de carência para primeira cobrança e prazo de tolerância em caso de atraso no pagamento.
Criar um novo plano
Exemplo de requisição:
{
"name": "Adicionar plano com boleto",
"description": "Plano sendo adicionado com boleto ",
"email": "testecomboleto@email.com",
"setup_amount": 50000,
"amount": 180000,
"grace_period": "7",
"tolerance_period": 0,
"frequency": "monthly",
"interval": 1,
"logo": true,
"currency": "BRL",
"payment_methods": "boleto",
"plan_expiration_date": "2021-08-09T03:00:00.000Z",
"has_expiration": true,
"expire_subscriptions": true,
"subscription_duration": "6"
}
Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/planos
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso",
"plano": 847
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| name | Nome do plano. Ex.: Plano semanal | |
| description | Descrição do plano, falando sobre os beneficios da assinatura | |
| Email para qual será enviado a notificação das ações realizadas por este plano | ||
| setup_amount | Valor a ser pago no ato da adesão do plano, ex.: 25 = R$ 0.25, 100 = R$ 1.00, 10000 = R$ 100.00 | |
| amount | Valor da recorrência, ex.: 25 = R$ 0.25, 100 = R$ 1.00, 10000 = R$ 100.00 | |
| grace_period | Período gratuito antes da primeira cobrança | |
| tolerance_period | Período de tolerância quando o pagamento não ocorre | |
| frequency | Frequencia na qual a recorrencia vai acontecer. Nesse campo pode receber 4 valores, sendo eles: ['daily', 'weekly', 'monthly', 'annualy'] | |
| interval | Intervalo de tempo que vai acontecer a recorrencia, por exemplo: Se você tiver marcado que a frequencia é semanal e colocar o valor de 1 nesse campo, semanalmente ocorrera a cobrança, mas se você colocar o valor de 2, a cobrança ocorrera de 2 em 2 semanas. No caso de colocar 4 , a cobrança ocorrerá acada 4 semanas | |
| logo | Campo que define se exibir logo do estabelecimento na tela de adesão ou não | |
| currency | Tipo de moeda a ser utilizado, no caso sempre BRL | |
| payment_methods | Método de pagamento. Cartão de crédito ou boleto | |
| plan_expiration_date | Data de expiração do plano | |
| has_expiration | Flag para definir se o plano tem expiração | |
| expire_subscriptions | Flag para definir se a assinatura tem expiração | |
| subscription_duration | Duração da assinatura em meses |
Visualizar planos cadastrados
Exemplo de requisição:
{ }
Requisição GET para o seguinte URL:
https://api.zsystems.com.br/planos
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso",
"planos": [
{
"assinantes": 2,
"id": 42,
"name": "Plano Anual",
"description": "Plano com cobrança recorrente
anualmente",
"frequency": "monthly",
"interval": 1,
"amount": 125,
"setup_amount": 25,
"currency": "BRL",
"grace_period": "0",
"tolerance_period": 0,
"created": "2019-11-26T20:18:43.000Z",
"removed": null,
"modified": "2019-11-26T20:18:43.000Z",
"estabelecimento": {
"id": 3,
"nome_fantasia": "Integração Z-Systems"
}
}
],
"paginas": 1,
"quantidade": 1
}Recuperar plano pelo identificador
Exemplo de requisição:
{ }
Requisição GET com parâmetros na URL:
https://api.zsystems.com.br/planos/{PlanoId}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso",
"plano": {
"id": 42,
"name": "Plano Mensal---",
"description": "Plano com cobrança recorrente mensal",
"frequency": "monthly",
"interval": 1,
"amount": 125,
"setup_amount": 25,
"currency": "BRL",
"grace_period": "0",
"tolerance_period": 0,
"duration": null,
"created": "2019-11-26T20:18:43.000Z",
"modified": "2019-11-26T20:18:43.000Z",
"removed": null
}
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| PlanoId | Identificador do plano já cadastrado |
Editar um plano
Exemplo de requisição:
{
"name": "Plano 6 Avançado",
"description": "Plano portal de noticias + Plus",
"setup_amount": 0,
"amount": 100,
"grace_period": "0",
"tolerance_period": 3,
"frequency": "monthly",
"interval": 1
}
Requisição PUT com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/planos/{PlanoId}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso",
"plano": {
"id": 42,
"name": "Plano 6 Avançado",
"description": "Plano portal de noticias + Plus",
"frequency": "monthly",
"interval": 1,
"amount": 100,
"setup_amount": 0,
"grace_period": "0",
"tolerance_period": 3,
"estabelecimento_id": 3,
"created": "2019-10-04T19:11:10.000Z",
"modified": "2019-11-26T20:45:21.161Z",
"removed": null
}
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| PlanoId | Identificador do plano já cadastrado | |
| name | Nome do plano. Ex.: Plano semanal | |
| description | Descrição do plano, falando sobre os beneficios da assinatura | |
| setup_amount | Valor a ser pago no ato da adesão do plano, ex.: 25 = R$ 0.25, 100 = R$ 1.00, 10000 = R$ 100.00 | |
| amount | Valor da recorrência, ex.: 25 = R$ 0.25, 100 = R$ 1.00, 10000 = R$ 100.00 | |
| grace_period | Período gratuito antes da primeira cobrança | |
| tolerance_period | Período de tolerância quando o pagamento não ocorre | |
| frequency | Frequencia na qual a recorrencia vai acontecer. Nesse campo pode receber 4 valores, sendo eles: ['daily', 'weekly', 'monthly', 'annualy'] | |
| interval | Intervalo de tempo que vai acontecer a recorrencia, por exemplo: Se você tiver marcado que a frequencia é semanal e colocar o valor de 1 nesse campo, semanalmente ocorrera a cobrança, mas se você colocar o valor de 2, a cobrança ocorrera de 2 em 2 semanas. No caso de colocar 4 , a cobrança ocorrerá acada 4 semanas | |
| currency | Tipo de moeda a ser utilizado, no caso sempre BRL | |
| payment_methods | Métodos de pagamento, no futuro pode ser implementado outros métodos, mas hoje só está disponível via crédito |
Remover um plano
Exemplo de requisição:
{ }
Requisição DELETE com parâmetros na URL:
https://api.zsystems.com.br/planos/{PlanoId}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success":true,
"message":"Operação realizada com sucesso",
"plano":42
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| PlanoId | Identificador do plano já cadastrado |
Filtrar listagem de planos
Exemplo de requisição:
{
"page": 1,
"limit": 15,
"id": 56,
"nome": "",
"valor": 0
}
Requisição GET com objetos JSON para o seguinte URL:
http://api.zsystems.com.br/planos
Converter parâmetros de entrada de JSON para Query String para utilização na URL
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso",
"planos": [
{
"assinantes": 1,
"id": 56,
"name": "Plano Básico - Edited",
"description": "Plano báscio MDB com cobrança automática mensalmente",
"frequency": "daily",
"interval": 10,
"amount": 1000,
"setup_amount": 0,
"currency": "BRL",
"grace_period": "0",
"tolerance_period": 0,
"created": "2020-04-10T14:03:54.000Z",
"removed": null,
"modified": "2020-04-10T14:09:40.000Z",
"estabelecimento": {
"id": 158,
"nome_fantasia": "Made Nova Madeiras Ltda"
}
}
],
"paginas": 1,
"quantidade": 1
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| page | Número da página de listagem de planos | |
| limit | Limite de planos por página | |
| id | Id do plano | |
| nome | Título do plano | |
| valor | Valor do plano |
Assinaturas
Assinaturas definem a relação entre um plano e um cliente, possuindo data de início e fim, representando um contrato com cobranças recorrentes baseadas nas regras estabelecidas entre o cliente e o parceiro, conforme plano vinculado.
Na criação de assinatura é obrigatório informar o plano associado, bem como o comprador, sendo possível configurar uma data de expiração (data para a primeira cobrança).
Nova assinatura
Exemplo de requisição:
{
"planoId": 42,
"expiration_date": "2019-12-12",
"cliente": {
"nome": "João Paulo",
"email": "teste2@zsystems.com.br",
"dataNascimento": "1991-10-10",
"cpf": "00000000000",
"telefone": "0033332222",
"celular": "00999998888"
},
"endereco": {
"logradouro": "leoneta",
"numero": "123",
"cep": "03380235",
"cidade": "sp",
"estado": "sp"
},
"cartao": {
"titular": "João Paulo",
"validade": "02/25",
"numero": "5234233381847212",
"codigoSeguranca": "069"
}
}Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/planos/assinar
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso",
"data": {
"id": 90,
"ativo": 1,
"status_assinatura_id": 1,
"payment_method": "credit",
"due_date": "2019-11-26",
"expiration_date": null,
"amount": 125.00,
"currency": "BRL",
"plano_id": 42,
"cliente_id": 202,
"modified": "2019-11-26T21:21:57.076Z",
"created": "2019-11-26T21:21:57.076Z"
}
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| planoId | Identificação do plano já cadastrado | |
| expiration_date | Quando expira a assinatura, se não houver data de expiração favor remover | |
| nome | Nome do cliente ou Razão Social | |
| E-mail do cliente | ||
| cpf ou cnpj | CPF ou CNPJ cliente, se enviar o CPF, não enviar CNPJ e vice-versa | |
| dataNascimento | Data de nascimento do cliente | |
| telefone | Número telefone fixo do cliente | |
| celular | Número celular do cliente | |
| logradouro | Rua ou Avenida do endereço | |
| numero | Número do endereço | |
| cep | Código postal do endereço | |
| cidade | Cidade do endereço | |
| estado | Código ISO 3166-2 para o estado, com duas letras | |
| complemento | Complemento do endereço | |
| titular | Nome do titular do cartão | |
| numero | Número do cartão | |
| codigoSeguranca | Código de Segurança ou CVV do cartão | |
| validade | Mês e ano em que o cartão expira sua validade |
Listar assinaturas
Exemplo de requisição:
{
"page": "1",
"limit": "3",
"filters": {"omni":"","assinaturaId":null}
}
Requisição GET para o seguinte URL:
https://api.zsystems.com.br/planos/assinaturas
Converter parâmetros de entrada de JSON para Query String para utilização na URL
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso",
"assinaturas": [
{
"id": 780,
"plano_id": 647,
"ativo": 1,
"status_assinatura_id": 3,
"payment_method": "credit",
"due_date": "2021-01-17",
"due_since_date": "2020-12-17",
"expiration_date": null,
"suspended_at": null,
"amount": 14990,
"currency": "BRL",
"subscription_id": "303465a17c0949cd82947d254557921c",
"created": "2020-12-17T17:33:25.000Z",
"modified": "2020-12-17T17:35:21.000Z",
"removed": null,
"plano": {
"id": 647,
"name": "Plano WeCareTest2 mensal",
"description": "Plano com cobrança mensal",
"img": null,
"value": null,
"frequency": "monthly",
"interval": 1,
"amount": 14990,
"setup_amount": 1,
"currency": "BRL",
"grace_period": "0",
"method": "credito",
"tolerance_period": 0,
"subscription_duration": null,
"expire_subscriptions": false,
"plan_expiration_date": null,
"estabelecimento_id": 158,
"logo": false,
"created": "2020-12-11T12:56:43.000Z",
"modified": "2020-12-16T17:51:36.000Z",
"removed": null,
"estabelecimento": {
"id": 158,
"parent_id": null,
"marketplace_id": 3,
"tipo_estabelecimento_id": 2,
"status_estabelecimento_id": 2,
"categoria_estabelecimento_id": 1,
"endereco_id": 247,
"logo_id": null,
"logo_boleto_id": null,
"razao_social": "Made Nova Madeiras Ltda",
"nome_fantasia": "Made Nova Madeiras Ltda",
"identificacao_fatura": "madepag",
"identificador_plano": null,
"faturamento_estimado": "0",
"quantidade_pos": 0,
"observacao": null,
"ativo": 1,
"data_nascimento": null,
"mcc": 104,
"plano_venda_id": null,
"pos_endereco_id": null,
"data_desabilitado": null,
"termos_condicoes_aceito": true,
"termos_condicoes_aceito_data": "2020-12-09T15:32:12.000Z",
"termos_condicoes_aceito_usuario_id": 125,
"created": "2019-12-19T14:04:00.000Z",
"modified": "2020-12-09T15:32:12.000Z",
"removed": null
}
},
"cliente": {
"id": 5031247,
"endereco_id": 79656,
"nome": "Teste Safari",
"email": "jamilcade@hotmail.com",
"senha": "",
"sexo": "M",
"ativo": true,
"data_nascimento": "1974-07-01",
"visible": true,
"created": "2020-12-17T17:33:22.000Z",
"modified": "2020-12-17T17:33:22.000Z",
"removed": null
}
},
{
"id": 779,
"plano_id": 647,
"ativo": 1,
"status_assinatura_id": 3,
"payment_method": "credit",
"due_date": "2021-01-17",
"due_since_date": "2020-12-17",
"expiration_date": null,
"suspended_at": null,
"amount": 14990,
"currency": "BRL",
"subscription_id": "63b7e8f2fd00405aba2ee147e33233d1",
"created": "2020-12-17T17:21:42.000Z",
"modified": "2020-12-17T17:22:22.000Z",
"removed": null,
"plano": {
"id": 647,
"name": "Plano WeCareTest2 mensal",
"description": "Plano com cobrança mensal",
"img": null,
"value": null,
"frequency": "monthly",
"interval": 1,
"amount": 14990,
"setup_amount": 1,
"currency": "BRL",
"grace_period": "0",
"method": "credito",
"tolerance_period": 0,
"subscription_duration": null,
"expire_subscriptions": false,
"plan_expiration_date": null,
"estabelecimento_id": 158,
"logo": false,
"created": "2020-12-11T12:56:43.000Z",
"modified": "2020-12-16T17:51:36.000Z",
"removed": null,
"estabelecimento": {
"id": 158,
"parent_id": null,
"marketplace_id": 3,
"tipo_estabelecimento_id": 2,
"status_estabelecimento_id": 2,
"categoria_estabelecimento_id": 1,
"endereco_id": 247,
"logo_id": null,
"logo_boleto_id": null,
"razao_social": "Made Nova Madeiras Ltda",
"nome_fantasia": "Made Nova Madeiras Ltda",
"identificacao_fatura": "madepag",
"identificador_plano": null,
"faturamento_estimado": "0",
"quantidade_pos": 0,
"observacao": null,
"ativo": 1,
"data_nascimento": null,
"mcc": 104,
"plano_venda_id": null,
"pos_endereco_id": null,
"data_desabilitado": null,
"termos_condicoes_aceito": true,
"termos_condicoes_aceito_data": "2020-12-09T15:32:12.000Z",
"termos_condicoes_aceito_usuario_id": 125,
"created": "2019-12-19T14:04:00.000Z",
"modified": "2020-12-09T15:32:12.000Z",
"removed": null
}
},
"cliente": {
"id": 5030888,
"endereco_id": 79626,
"nome": "Marcus de Magalhães",
"email": "fivoleb730@ahhtee.com",
"senha": "",
"sexo": "M",
"ativo": true,
"data_nascimento": "1980-06-03",
"visible": true,
"created": "2020-12-17T17:21:37.000Z",
"modified": "2020-12-17T17:21:37.000Z",
"removed": null
}
},
{
"id": 778,
"plano_id": 647,
"ativo": 1,
"status_assinatura_id": 3,
"payment_method": "credit",
"due_date": "2021-01-17",
"due_since_date": "2020-12-17",
"expiration_date": null,
"suspended_at": null,
"amount": 14990,
"currency": "BRL",
"subscription_id": "7d36b72393184c8ba73cd2a98083f2c1",
"created": "2020-12-17T16:44:12.000Z",
"modified": "2020-12-17T16:46:21.000Z",
"removed": null,
"plano": {
"id": 647,
"name": "Plano WeCareTest2 mensal",
"description": "Plano com cobrança mensal",
"img": null,
"value": null,
"frequency": "monthly",
"interval": 1,
"amount": 14990,
"setup_amount": 1,
"currency": "BRL",
"grace_period": "0",
"method": "credito",
"tolerance_period": 0,
"subscription_duration": null,
"expire_subscriptions": false,
"plan_expiration_date": null,
"estabelecimento_id": 158,
"logo": false,
"created": "2020-12-11T12:56:43.000Z",
"modified": "2020-12-16T17:51:36.000Z",
"removed": null,
"estabelecimento": {
"id": 158,
"parent_id": null,
"marketplace_id": 3,
"tipo_estabelecimento_id": 2,
"status_estabelecimento_id": 2,
"categoria_estabelecimento_id": 1,
"endereco_id": 247,
"logo_id": null,
"logo_boleto_id": null,
"razao_social": "Made Nova Madeiras Ltda",
"nome_fantasia": "Made Nova Madeiras Ltda",
"identificacao_fatura": "madepag",
"identificador_plano": null,
"faturamento_estimado": "0",
"quantidade_pos": 0,
"observacao": null,
"ativo": 1,
"data_nascimento": null,
"mcc": 104,
"plano_venda_id": null,
"pos_endereco_id": null,
"data_desabilitado": null,
"termos_condicoes_aceito": true,
"termos_condicoes_aceito_data": "2020-12-09T15:32:12.000Z",
"termos_condicoes_aceito_usuario_id": 125,
"created": "2019-12-19T14:04:00.000Z",
"modified": "2020-12-09T15:32:12.000Z",
"removed": null
}
},
"cliente": {
"id": 5029658,
"endereco_id": 79548,
"nome": "Wanderson Silva",
"email": "wanderson@w3.care",
"senha": "",
"sexo": "M",
"ativo": true,
"data_nascimento": "2020-01-08",
"visible": true,
"created": "2020-12-17T16:44:10.000Z",
"modified": "2020-12-17T16:44:10.000Z",
"removed": null
}
}
],
"paginas": 23,
"quantidade": 335
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| page | Número de páginas | |
| limit | Define a quantidade de assinaturas a serem exibidas por página | |
| omni | Campo utilizado como ferramenta de pesquisa | |
| assinaturaId | Código de identificação da assinatura |
Visualizar detalhes de uma assinatura
Exemplo de requisição:
{}Requisição GET com praâmetros na URL:
https://api.zsystems.com.br/planos/assinatura/{AssinaturaId}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso!",
"data": {
"id": 90,
"plano_id": 42,
"ativo": 1,
"status_assinatura_id": 1,
"payment_method": "credit",
"due_date": "2019-11-26",
"due_since_date": null,
"expiration_date": null,
"suspended_at": null,
"amount": 125,
"currency": "BRL",
"created": "2019-11-26T21:21:57.000Z",
"modified": "2019-11-26T21:21:57.000Z",
"removed": null,
"plano": {
"id": 42,
"name": "Plano Anual ---",
"amount": 125.00,
"description": "Plano com cobrança recorrente
anualmente",
"frequency": "monthly",
"grace_period": "0",
"interval": 1,
"setup_amount": 25.00,
"tolerance_period": 0,
"estabelecimento": {
"id": 3,
"nome_fantasia": "Integração Z-Systems",
"razao_social": ""
}
},
"cliente": {
"id": 202,
"nome": "João Paulo",
"data_nascimento": "1991-10-10",
"email": "teste2@zsystems.com.br",
"sexo": "M",
"ativo": true,
"endereco": {
"id": 365,
"logradouro": "leoneta",
"numero": "123",
"complemento": null,
"cep": "03380235",
"cidade": "sp",
"uf": "sp",
"lat": null,
"long": null,
"created": "2019-11-26T21:21:47.000Z",
"modified": "2019-11-26T21:21:47.000Z",
"removed": null
},
"clientes_documentos": [
{
"id": 179,
"tipo_documento_id": 2,
"documento": "00000000000",
"arquivo": null
}
],
"clientes_contatos": [
{
"id": 208,
"tipo_contato_id": 1,
"nome": null,
"contato": "0033332222"
},
{
"id": 209,
"tipo_contato_id": 2,
"nome": null,
"contato": "00999998888"
}
],
"clientes_cartoes": [
{
"id": 224,
"cliente_id": 202,
"nome_titular": "João Paulo",
"bandeira": "Mastercard",
"ultimos_digitos": 7212,
"ano_expiracao": 25,
"mes_expiracao": 02,
"created": "2019-11-26T21:21:51.000Z",
"modified": "2019-11-26T21:21:51.000Z",
"removed": null
}
]
}
}
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| AssinaturaId | Identificação da assinatura já cadastrada |
Alterar data da próxima recorrência
Exemplo de requisição:
{
"due_date":’2020-12-18’,
}Requisição PUT com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/planos/assinatura/{AssinaturaId}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso",
"data": {
"id": 764,
"plano_id": 647,
"cliente_id": 5012185,
"ativo": 1,
"status_assinatura_id": 1,
"payment_method": "credit",
"due_date": "2020-12-18",
"expiration_date": "2020-12-17T03:00:00.000Z",
"suspended_at": null,
"amount": 14990,
"currency": "BRL",
"created": "2020-12-16T20:00:12.000Z",
"modified": "2020-12-16T20:47:17.736Z",
"removed": null,
"plano": {
"id": 647,
"name": "Plano WeCareTest2 mensal",
"description": "Plano com cobrança mensal",
"img": null,
"value": null,
"frequency": "monthly",
"interval": 1,
"amount": 14990,
"setup_amount": 1,
"currency": "BRL",
"grace_period": "0",
"method": "credito",
"tolerance_period": 0,
"subscription_duration": null,
"expire_subscriptions": false,
"plan_expiration_date": null,
"estabelecimento_id": 158,
"logo": false,
"created": "2020-12-11T12:56:43.000Z",
"modified": "2020-12-16T17:51:36.000Z",
"removed": null,
"estabelecimento": {
"id": 158,
"nome_fantasia": "Made Nova Madeiras Ltda"
}
},
"cliente": {
"id": 5012185,
"endereco_id": 78140,
"nome": "Médico Mensal Teste 15/12",
"email": "douglas@w3.care",
"senha": "",
"sexo": "M",
"ativo": true,
"data_nascimento": "1980-10-10",
"visible": true,
"created": "2020-12-16T20:00:09.000Z",
"modified": "2020-12-16T20:00:09.000Z",
"removed": null
}
}
}
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| AssinaturaId | Identificação da assinatura já cadastrada | |
| due_date | Data da próxima recorrência |
Alterar valor da assinatura
Exemplo de requisição:
{
"amount":"500",
}
Requisição PUT com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/planos/assinatura/{AssinaturaId}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso",
"data": {
"id": 3564,
"plano_id": 3391,
"cliente_id": 2173334,
"socio": "",
"socioCpf": "",
"ativo": 1,
"status_assinatura_id": 3,
"payment_method": "credit",
"due_date": "2022-08-28",
"expiration_date": null,
"suspended_at": null,
"amount": 500,
"currency": "BRL",
"created": "2022-06-28T17:26:58.000Z",
"modified": "2022-08-16T21:25:54.186Z",
"removed": null,
"plano": {
"id": 3391,
"name": "vfc",
"description": "dsadssfc",
"img": null,
"value": null,
"frequency": "monthly",
"interval": 1,
"amount": 500,
"setup_amount": 0,
"currency": "BRL",
"grace_period": "0",
"method": "credito",
"tolerance_period": 0,
"subscription_duration": 0,
"expire_subscriptions": false,
"plan_expiration_date": null,
"due_days": null,
"estabelecimento_id": 158,
"logo": false,
"email": "",
"created": "2022-06-15T18:22:48.000Z",
"modified": "2022-06-15T18:22:48.000Z",
"removed": null,
"estabelecimento": {
"id": 158,
"nome_fantasia": "Made Nova Madeiras Ltda"
}
},
"cliente": {
"id": 2173334,
"endereco_id": 35222,
"nome": "Teste",
"email": "guitncruz100@gmail.com",
"senha": "",
"sexo": "M",
"ativo": true,
"data_nascimento": "1998-01-01",
"visible": true,
"created": "2020-08-14T14:44:43.000Z",
"modified": "2022-03-17T14:23:05.000Z",
"removed": null
}
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| AssinaturaId | Identificação da assinatura já cadastrada |
Suspender uma assinatura
Exemplo de requisição:
{
"assinatura_id": 90
}Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/planos/assinatura/suspender
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso"
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| assinatura_id | Identificação da assinatura já cadastrada |
Reativar uma assinatura
Exemplo de requisição:
{
"assinatura_id": 90
}Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/planos/assinatura/reativar
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso"
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| assinatura_id | Identificação da assinatura já cadastrada |
Remover uma assinatura
Exemplo de requisição:
{}Requisição DELETE com parâmetros na URL:
https://api.zsystems.com.br/planos/{PlanoId}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso"
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| PlanoId | Identificação da assinatura já cadastrada |
Recuperar faturas de uma assinatura
Exemplo de requisição:
{}Requisição GET com parâmetros na URL:
https://api.zsystems.com.br/planos/assinatura/{assinaturaId}/faturas
header: ContentType application/json
authorization Bearer 'Token API'
Esse end point retorna um array com as faturas de uma assinatura
Converter parâmetros de entrada de JSON para Query String para utilização na URL
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso",
"totalRows": 4,
"pages": 1,
"faturas": [
{
"id": 6920,
"assinatura_id": 376,
"pedido_id": null,
"expiration_date": null,
"amount": "21400",
"paid_at": "2021-01-16T03:02:17.000Z",
"date_invoice": "2021-01-16",
"voided_at": null,
"retries": 0,
"max_retries": 3,
"status": "paid",
"created": "2021-01-16T03:00:25.000Z",
"modified": "2021-01-16T03:10:00.000Z",
"removed": null,
"pedido": null
},
{
"id": 4185,
"assinatura_id": 376,
"pedido_id": null,
"expiration_date": null,
"amount": "21400",
"paid_at": "2020-12-16T03:02:13.000Z",
"date_invoice": "2020-12-16",
"voided_at": null,
"retries": 0,
"max_retries": 3,
"status": "paid",
"created": "2020-12-16T03:00:22.000Z",
"modified": "2020-12-16T03:02:25.000Z",
"removed": null,
"pedido": null
},
{
"id": 3127,
"assinatura_id": 376,
"pedido_id": null,
"expiration_date": null,
"amount": "21400",
"paid_at": "2020-11-16T03:02:07.000Z",
"date_invoice": "2020-11-16",
"voided_at": null,
"retries": 0,
"max_retries": 3,
"status": "paid",
"created": "2020-11-26T22:26:07.000Z",
"modified": "2020-11-26T22:26:08.000Z",
"removed": null,
"pedido": null
},
{
"id": 1780,
"assinatura_id": 376,
"pedido_id": null,
"expiration_date": null,
"amount": "21400",
"paid_at": "2020-10-16T03:01:26.000Z",
"date_invoice": "2020-10-16",
"voided_at": null,
"retries": 0,
"max_retries": 3,
"status": "paid",
"created": "2020-10-16T03:00:20.000Z",
"modified": "2020-10-16T03:01:36.000Z",
"removed": null,
"pedido": null
}
]
}Parâmetros
| Id | Tipo | Descrição |
|---|---|---|
| assinaturaId | Identificação da assinatura já cadastrada | |
| startDate | Data inicial para filtrar as faturas | |
| endDate | Data final para filtrar as faturas | |
| limit | Define a quantidade de estabelecimentos a serem exibidos por página | |
| page | Define o número da página a ser exibida |
Estornar uma fatura
Exemplo de requisição:
{
"id": 841
}Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/planos/assinatura/estornar
header: ContentType application/json
authorization Bearer 'Token API'
Esse end point retorna um array com todos os últimos 50 pagamentos do cliente.
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso",
}PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| id | Identificação da fatura para estorno |
Carnês
Carnês são uma maneira de pagar por algo em parcelas mensais, com boletos bancários que indicam o valor e a data de vencimento de cada parcela.
Criação de carnê
Exemplo de requisição:
{
"cliente": {
"nome": "LUCAS COELHO",
"cpf": "03927561029",
"dataNascimento": "2000-02-08",
"email": "RUA SAO JOSEMARIA ESCRIVA",
"celular": "99562909"
},
"clienteId:2666",
"descontos": [
{
"mode": "",
"value": 0,
"limitDate": "2023-09-13T19:24:05.619Z"
}
],
"descricao":"descricaoteste",
"diaVencimento":"2023-09-18",
"endereco": {
"logradouro": "Rua São Josemaría Escrivá",
"numero": " 669 ",
"cep": "91410-470",
"cidade": "Porto Alegre",
"estado": "RS",
"complemento": ""
}
"estabelecimentoId":155,
"parcelas":1,
"splits": [
{
"estabelecimentoId": false,
"cpfcnpj": "",
"nome": "",
"email": "",
"value": 0,
"tipoSplit": 2,
"chargeProcessingFee": true
}
],
"tipoPagamentoId": 4,
"titulo": "tete",
"valor": 10,
}
Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/carnes
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"carne": {
"id": 8441,
"estabelecimento_id": 158,
"usuario_id": 125,
"cliente_id": 27432251,
"titulo": "tete",
"descricao": "teste",
"parcelas": 1,
"dia_vencimento": "18",
"valor": 10,
"modified": "2023-09-13T19:26:23.154Z",
"created": "2023-09-13T19:26:23.154Z"
}
}
PARÂMETROS
| Id | Descrição | |
|---|---|---|
| cliente |
nome:Nome do cliente cpf = Cpf do cliente dataNascimento = data de nascimento do cliente email = Email do cliente celular = Nº de telefone celular do cliente |
|
| descontos |
mode:Tipo de desconto value = valor do desconto limitDate = expiração do desconto |
|
| descricao | Descrição do carnê | |
| diaVencimento | Data de validade do carnê | |
| endereco |
Endereço de cobrança logradouro:Logradouro numero = Nº Residencial cep = cep do endereço cidade = cidade estado = estado complemento = complemento |
|
| estabelecimentoId | Id do estabelecimento | |
| parcelas | parcelas do carnê | |
| splits |
estabelecimentoId:Id do estabelecimento de referencia cpfcnpj Documento identificador do individuo splitado nome = Nome do individuo ou estabelecimento email = email do individuo ou estabelecimento value = valor do split tipoSplit = tipo de split chargeProcessingFree = 0=Bruto / 1=Líquido |
|
| tipoPagamentoId | ID do tipo de pagamento | |
| titulo | titulo do carnê | |
| valor | valor total do carnê | |
| percentual | Percentual de juros | |
| repassarTaxaCliente | Vai repassar a taxa para o cliente? | |
| split | Haverá split? (true ou false) | |
| splits |
[{ estabelecimentoId: false,Há estabelecimento vinculado? (true ou false) cpfcnpj = Cpf ou Cnpj do estabelecimento nome = Nome do estabelecimento email = Email do estabelecimento value = Valor do split tipoSplit: 2 = Informar id do tipo do split ]} |
|
| titulo | Título do link de pagamento |
Listagem de carnê
Exemplo de requisição:
{
"page": 1
"cliente":
"titulo":
"id":
"limit": 15
"estabelecimentoId": 158
}
Requisição GET com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/carnes?page=1&cliente=&titulo=&id=&limit=15
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"carnes": [
{
"id": 7,
"titulo": "Carnê 2",
"descricao": "Descrição do Carnê",
"parcelas": 10,
"dia_vencimento": 31,
"valor": "10.00",
"status_carne_id": 2,
"created": "2021-05-12T17:51:01.000Z",
"usuario": {
"nome": "Made Nova Madeiras Ltda"
},
"cliente": {
"nome": "Altair Antunes"
}
},
{
"id": 8,
"titulo": "\Testre",
"descricao": "",
"parcelas": 7,
"dia_vencimento": 24,
"valor": "156.84",
"status_carne_id": 2,
"created": "2021-05-19T03:44:44.000Z",
"usuario": {
"nome": "Made Nova Madeiras Ltda"
},
"cliente": {
"nome": "Parcerias"
}
},
}
PARÂMETROS
| Id | Descrição | |
|---|---|---|
| page | Número de páginas | |
| cliente | Nome do cliente, ex: Junior | |
| titulo | Título do carnê | |
| limit | Limite de itens por página | |
| estabelecimentoId | Id do estabelecimento |
Detalhes do carnê
Exemplo de requisição:
{}
Requisição GET com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/carnes/{id}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"carne": {
"id": 7,
"estabelecimento_id": 158,
"titulo": "Carnê 2",
"descricao": "Descrição do Carnê",
"parcelas": 10,
"dia_vencimento": 31,
"valor": "10.00",
"created": "2021-05-12T17:51:01.000Z",
"status_carne_id": 2,
"carnes_parcelas": [
{
"id": 4,
"carne_id": 7,
"data_vencimento": "2021-05-31",
"valor": "10.00",
"parcela": 1,
"codigo_barras": "34191091234614491893831977690002186230000001000",
"multa": "null",
"mora": "null",
"created": "2021-05-12T17:51:03.000Z",
"pedido": null
},
{
"id": 5,
"carne_id": 7,
"data_vencimento": "2021-06-30",
"valor": "10.00",
"parcela": 2,
"codigo_barras": "34191091234614475893831977690002986230000001000",
"multa": "null",
"mora": "null",
"created": "2021-05-12T17:51:03.000Z",
"pedido": null
},
}
PARÂMETROS
| Id | Descrição | |
|---|---|---|
| id | id do carnê |
Status
Os status são os retornos predefinidos de alguns elementos, veja abaixo a lista.
Tipos Pagamento
| Id | Descrição |
|---|---|
| 1 | Boleto bancário |
| 2 | Cartão de débito(não implementado) |
| 3 | Cartão de crédito |
Status de pagamento
| Id | Descrição |
|---|---|
| 1 | Pendente |
| 2 | Pago |
| 3 | Cancelado |
| 4 | Estornado |
| 5 | Pré-autorizado |
Status do pedido (venda)
| Id | Descrição |
|---|---|
| 1 | Pendente |
| 2 | Aprovado |
| 3 | Falhado |
| 4 | Cancelado |
| 5 | Parcialmente pago |
| 6 | Estornado |
| 7 | Em processamento |
| 8 | Pré-autorizado |
Status da assinatura
| Id | Descrição |
|---|---|
| 1 | Aguardando |
| 2 | Cancelado |
| 3 | Pago |
| 4 | Atrasado |
| 5 | Suspenso |
Predefinições
As predefinições referem-se aos dados pré definidos utilizados na plataforma
Consultar bancos
Exemplo de requisição:
{ }
Requisição GET para o seguinte URL:
http://api.zsystems.com.br/bancos
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"bancos": [
{
"id": 1,
"nome": "001 - Banco do Brasil S.A.",
"codigo": 1
},
{
"id": 10,
"nome": "033 - Banco Santander (Brasil) S.A.",
"codigo": 33
},
{
"id": 55,
"nome": "341 - Itaú Unibanco S.A.",
"codigo": 341
},
{
"id": 45,
"nome": "237 - Banco Bradesco S.A.",
"codigo": 237
},
{
"id": 30,
"nome": "104 - Caixa Econômica Federal",
"codigo": 104
},
{
"id": 61,
"nome": "399 - HSBC Bank Brasil S.A. - Banco Múltiplo",
"codigo": 399
},
{
"id": 88,
"nome": "745 - Banco Citibank S.A.",
"codigo": 745
},
{
"id": 2,
"nome": "003 - Banco da Amazônia S.A.",
"codigo": 3
},
{
"id": 3,
"nome": "004 - Banco do Nordeste do Brasil S.A.",
"codigo": 4
},
{
"id": 4,
"nome": "012 - Banco Standard de Investimentos S.A.",
"codigo": 12
},
{
"id": 5,
"nome": "021 - BANESTES S.A. Banco do Estado do Espírito Santo",
"codigo": 21
},
{
"id": 6,
"nome": "024 - Banco BANDEPE S.A.",
"codigo": 24
},
{
"id": 7,
"nome": "025 - Banco Alfa S.A.",
"codigo": 25
},
{
"id": 8,
"nome": "029 - Banco Banerj S.A.",
"codigo": 29
},
{
"id": 9,
"nome": "031 - Banco Beg S.A.",
"codigo": 31
},
{
"id": 106,
"nome": "036 - Banco Bradesco BBI S.A.",
"codigo": 36
},
{
"id": 11,
"nome": "037 - Banco do Estado do Pará S.A.",
"codigo": 37
},
{
"id": 12,
"nome": "040 - Banco Cargill S.A.",
"codigo": 40
},
{
"id": 13,
"nome": "041 - Banco do Estado do Rio Grande do Sul S.A.",
"codigo": 41
},
{
"id": 14,
"nome": "045 - Banco Opportunity S.A.",
"codigo": 45
},
{
"id": 15,
"nome": "047 - Banco do Estado de Sergipe S.A.",
"codigo": 47
},
{
"id": 16,
"nome": "062 - Hipercard Banco Múltiplo S.A.",
"codigo": 62
},
{
"id": 17,
"nome": "063 - Banco Ibi S.A. Banco Múltiplo",
"codigo": 63
},
{
"id": 18,
"nome": "064 - Goldman Sachs do Brasil Banco Múltiplo S.A.",
"codigo": 64
},
{
"id": 19,
"nome": "065 - Banco AndBank (Brasil) S.A.",
"codigo": 65
},
{
"id": 20,
"nome": "069 - BPN Brasil Banco Múltiplo S.A.",
"codigo": 69
},
{
"id": 21,
"nome": "070 - BRB - Banco de Brasília S.A.",
"codigo": 70
},
{
"id": 22,
"nome": "073 - BB Banco Popular do Brasil S.A.",
"codigo": 73
},
{
"id": 23,
"nome": "074 - Banco J. Safra S.A.",
"codigo": 74
},
{
"id": 24,
"nome": "075 - Banco ABN AMRO S.A.",
"codigo": 75
},
{
"id": 25,
"nome": "077 - Banco Inter",
"codigo": 77
},
{
"id": 26,
"nome": "078 - BES Investimento do Brasil S.A.-Banco de Investimento",
"codigo": 78
},
{
"id": 102,
"nome": "084 - CC UNIPRIME NORTE DO PARANA",
"codigo": 84
},
{
"id": 100,
"nome": "085 - COOP CENTRAL AILOS",
"codigo": 85
},
{
"id": 27,
"nome": "090 - UNICRED MUTUO",
"codigo": 90
},
{
"id": 28,
"nome": "095 - Banco Confidence de Câmbio S.A.",
"codigo": 95
},
{
"id": 29,
"nome": "096 - Banco BM&FBOVESPA de Serviços de Liquidação e Custódia S.A",
"codigo": 96
},
{
"id": 31,
"nome": "107 - Banco BBM S.A.",
"codigo": 107
},
{
"id": 32,
"nome": "109 - Banco Zoop",
"codigo": 109
},
{
"id": 33,
"nome": "119 - Banco Western Union do Brasil S.A.",
"codigo": 119
},
{
"id": 34,
"nome": "125 - Brasil Plural S.A. - Banco Múltiplo",
"codigo": 125
},
{
"id": 108,
"nome": "133 - Banco Cresol",
"codigo": 133
},
{
"id": 35,
"nome": "136 - UNICRED",
"codigo": 136
},
{
"id": 99,
"nome": "144 - BEXS BANCO DE CAMBIO S.A.",
"codigo": 144
},
{
"id": 109,
"nome": "184 - Banco Itaú BBA S.A.",
"codigo": 184
},
{
"id": 104,
"nome": "197 - Stone Pagamentos",
"codigo": 197
},
{
"id": 36,
"nome": "208 - Banco BTG Pactual S.A.",
"codigo": 208
},
{
"id": 37,
"nome": "212 - Banco Original S.A.",
"codigo": 212
},
{
"id": 38,
"nome": "214 - Banco Dibens S.A.",
"codigo": 214
},
{
"id": 39,
"nome": "215 - Banco Comercial e de Investimento Sudameris S.A.",
"codigo": 215
},
{
"id": 40,
"nome": "217 - Banco John Deere S.A.",
"codigo": 217
},
{
"id": 41,
"nome": "218 - Banco Bonsucesso S.A.",
"codigo": 218
},
{
"id": 42,
"nome": "222 - Banco Credit Agricole Brasil S.A.",
"codigo": 222
},
{
"id": 43,
"nome": "224 - Banco Fibra S.A.",
"codigo": 224
},
{
"id": 44,
"nome": "233 - Banco Cifra S.A.",
"codigo": 233
},
{
"id": 103,
"nome": "237 - Banco Next",
"codigo": 237
},
{
"id": 46,
"nome": "248 - Banco Boavista Interatlântico S.A.",
"codigo": 248
},
{
"id": 47,
"nome": "249 - Banco Investcred Unibanco S.A.",
"codigo": 249
},
{
"id": 48,
"nome": "250 - BCV - Banco de Crédito e Varejo S.A.",
"codigo": 250
},
{
"id": 49,
"nome": "254 - Paraná Banco S.A.",
"codigo": 254
},
{
"id": 50,
"nome": "260 - Nu Bank",
"codigo": 260
},
{
"id": 51,
"nome": "263 - Banco Cacique S.A.",
"codigo": 263
},
{
"id": 52,
"nome": "265 - Banco Fator S.A.",
"codigo": 265
},
{
"id": 98,
"nome": "290 - Pagseguro Internet S.A",
"codigo": 290
},
{
"id": 53,
"nome": "318 - Banco BMG S.A.",
"codigo": 318
},
{
"id": 54,
"nome": "320 - Banco Industrial e Comercial S.A.",
"codigo": 320
},
{
"id": 105,
"nome": "323 - Mercado Pago",
"codigo": 323
},
{
"id": 97,
"nome": "336 - Banco C6 Bank",
"codigo": 336
},
{
"id": 56,
"nome": "356 - Banco Real S.A.",
"codigo": 356
},
{
"id": 57,
"nome": "366 - Banco Société Générale Brasil S.A.",
"codigo": 366
},
{
"id": 58,
"nome": "370 - Banco Mizuho do Brasil S.A.",
"codigo": 370
},
{
"id": 59,
"nome": "376 - Banco J. P. Morgan S.A.",
"codigo": 376
},
{
"id": 60,
"nome": "389 - Banco Mercantil do Brasil S.A.",
"codigo": 389
},
{
"id": 62,
"nome": "409 - UNIBANCO - União de Bancos Brasileiros S.A.",
"codigo": 409
},
{
"id": 63,
"nome": "422 - Banco Safra S.A.",
"codigo": 422
},
{
"id": 64,
"nome": "456 - Banco de Tokyo-Mitsubishi UFJ Brasil S.A.",
"codigo": 456
},
{
"id": 65,
"nome": "464 - Banco Sumitomo Mitsui Brasileiro S.A.",
"codigo": 464
},
{
"id": 66,
"nome": "477 - Citibank S.A.",
"codigo": 477
},
{
"id": 67,
"nome": "487 - Deutsche Bank S.A. - Banco Alemão",
"codigo": 487
},
{
"id": 68,
"nome": "488 - JPMorgan Chase Bank",
"codigo": 488
},
{
"id": 69,
"nome": "492 - ING Bank N.V.",
"codigo": 492
},
{
"id": 70,
"nome": "505 - Banco Credit Suisse (Brasil) S.A.",
"codigo": 505
},
{
"id": 71,
"nome": "600 - Banco Luso Brasileiro S.A.",
"codigo": 600
},
{
"id": 72,
"nome": "604 - Banco Industrial do Brasil S.A.",
"codigo": 604
},
{
"id": 73,
"nome": "610 - Banco VR S.A.",
"codigo": 610
},
{
"id": 74,
"nome": "611 - Banco Paulista S.A.",
"codigo": 611
},
{
"id": 75,
"nome": "612 - Banco Guanabara S.A.",
"codigo": 612
},
{
"id": 76,
"nome": "623 - Banco PAN S.A.",
"codigo": 623
},
{
"id": 77,
"nome": "626 - Banco Ficsa S.A.",
"codigo": 626
},
{
"id": 107,
"nome": "630 - Banco Intercap",
"codigo": 630
},
{
"id": 78,
"nome": "633 - Banco Rendimento S.A.",
"codigo": 633
},
{
"id": 79,
"nome": "634 - Banco Triângulo S.A.",
"codigo": 634
},
{
"id": 80,
"nome": "641 - Banco Alvorada S.A.",
"codigo": 641
},
{
"id": 81,
"nome": "643 - Banco Pine S.A.",
"codigo": 643
},
{
"id": 82,
"nome": "653 - Banco Indusval S.A.",
"codigo": 653
},
{
"id": 83,
"nome": "655 - Banco Votorantim S.A.",
"codigo": 655
},
{
"id": 84,
"nome": "707 - Banco Daycoval S.A.",
"codigo": 707
},
{
"id": 85,
"nome": "719 - Banif-Banco Internacional do Funchal (Brasil)S.A.",
"codigo": 719
},
{
"id": 101,
"nome": "735 - Banco Neon",
"codigo": 735
},
{
"id": 86,
"nome": "739 - Banco Cetelem S.A.",
"codigo": 739
},
{
"id": 87,
"nome": "740 - Banco Barclays S.A.",
"codigo": 740
},
{
"id": 89,
"nome": "746 - Banco Modal S.A.",
"codigo": 746
},
{
"id": 90,
"nome": "747 - Banco Rabobank International Brasil S.A.",
"codigo": 747
},
{
"id": 91,
"nome": "748 - Banco Cooperativo Sicredi S.A.",
"codigo": 748
},
{
"id": 92,
"nome": "751 - Scotiabank Brasil S.A. Banco Múltiplo",
"codigo": 751
},
{
"id": 93,
"nome": "752 - Banco BNP Paribas Brasil S.A.",
"codigo": 752
},
{
"id": 94,
"nome": "755 - Bank of America Merrill Lynch Banco Múltiplo S.A.",
"codigo": 755
},
{
"id": 95,
"nome": "756 - Banco Cooperativo do Brasil S.A. - BANCOOB",
"codigo": 756
},
{
"id": 96,
"nome": "779 - Banco Intermedium S.A.",
"codigo": 779
}
]
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| id | Código de identificação do banco na base | |
| nome | Campo contendo o código e o nome do banco | |
| codigo | Código do banco |
Lista de Categorias
| categoria | Descrição |
|---|---|
| 1 | Atacado |
| 2 | Casas de Carne / Peixaria |
| 3 | Docerias / Confeitarias / Rotisserie |
| 4 | Feira livre |
| 5 | Hortifruit / Granjeiros |
| 6 | Lojas de Conveniência |
| 7 | Mercearia e Bebidas |
| 8 | Alimentação em geral |
| 9 | Bijouterias |
| 10 | Calçados / Bolsas / Malas |
| 11 | Cosméticos / Produtos de beleza |
| 12 | Lavanderia / Tinturaria |
| 13 | Magazines |
| 14 | Roupas masc., fem., inf., geral |
| 15 | Uniformes |
| 16 | ########################################### |
| 17 | Material de Construção |
| 18 | Computadores, Periféricos e Software |
| 19 | Papelaria, Material de Escritório |
| 20 | Banca de Jornal |
| 21 | Floricultura |
| 22 | Supermercado |
| 23 | Padaria |
| 24 | Posto de Combustível |
| 25 | Vestuário |
| 26 | Eletrônicos |
| 27 | Restaurante |
| 28 | Bar e Casa Noturna |
| 29 | Restaurante Fast Food |
| 30 | Farmácia, Drogaria |
| 31 | Livraria |
| 32 | Joalheria |
| 33 | Loja de Brinquedos |
| 34 | Hospital / Maternidade |
| 35 | Médico |
| 36 | Dentista |
| 37 | Óticas |
| 38 | Veterinário / Clínica veterinária |
| 39 | Saúde em geral |
| 40 | Centro de formação de condutores |
| 41 | Borracharia |
| 42 | Estacionamento |
| 43 | Lava rápido |
| 44 | Locadora de veículos |
| 45 | Pedágio |
| 46 | Táxi / Cia de táxi |
| 47 | Veículos em geral |
| 48 | Cia marítima |
| 49 | Agências turismo |
| 50 | Casa de câmbio |
| 51 | Cia ferrovia |
| 52 | Cia terrestre |
| 53 | Cinema |
| 54 | Clube |
| 55 | Hotel / Pousada / Motel / Flat |
| 56 | Turismo em geral |
| 57 | Academias em geral |
| 58 | Aluguel de quadras |
| 59 | Arte |
| 60 | Artigos música - Discos / CD / DVD |
| 61 | Artigos pesca / Caça / Camping |
| 62 | Personal Trainer |
| 63 | Pintura / Desenho |
| 64 | Produtos Eróticos (SEX SHOP) |
| 65 | Salão de Beleza |
| 66 | Tabacaria |
| 67 | Advogados / Escritório advocacia |
| 68 | Artesanato |
| 69 | Associações religiosas |
| 70 | Associações políticas |
| 71 | Cartório |
| 72 | Casa lotérica |
| 73 | Cia seguro |
| 74 | Despachante |
| 75 | Escritório contabilidade |
| 76 | ########################################### |
| 77 | Produtos importados |
| 78 | Provedor acesso internet |
| 79 | Recarga bilhete único / Celular |
| 80 | Serviços públicos |
| 81 | TV por assinatura |
| 82 | Venda em domicílio |
| 83 | Editora |
| 84 | Escola / Cursos em geral |
| 85 | Escola / Faculdade |
| 86 | Transporte escolar |
| 87 | Educação em geral |
| 88 | Adm. de condomínios |
| 89 | Empreiteiros / Arquitetos / Engenheiros |
| 90 | Imobiliárias / Construtoras / Incorporadoras |
| 91 | Clínicas e Institutos especializados |
| 92 | Artigos para animais / Petshop |
| 93 | Casa de Repouso |
| 94 | Fono / Nutricionista / Físio / Psicólogo |
| 95 | Cama / Mesa / Banho |
| 96 | Chaveiros |
| 97 | Concessionárias (Gás, Energia, Água) |
| 98 | Móveis em geral |
| 99 | Pizzaria |
| 100 | Tinta e Material de pintura |
| 101 | Moradia em geral |
| 102 | Lojas de Departamento |
| 103 | Profissionais Liberais |
| 104 | ########################################### |
| 105 | Outras atividades auxiliares dos serviços financeiros não especificado anteriormente |
| 106 | Desenvolvimento de software |
| 107 | ########################################### |
Tipos de Documentos
| categoria | Descrição |
|---|---|
| 1 | RG |
| 2 | CPF |
| 3 | CNPJ |
| 4 | Outros |
| 5 | Identificação |
| 6 | Comprovante de atividade |
| 7 | Comprovante de residência |
| 8 | Identificação de proprietário |
Webhook
Webhooks (callbacks) são uma forma de se registrar para receber informações úteis de uma URL específica de sua escolha. Você pode criar múltiplos webhooks!
Quando um evento desencadeia um webhook (por exemplo, uma transação foi aprovada com sucesso), tentaremos enviar essa notificação para o nó de extremidade que você especificou.
PARÂMETROS padrão
| Id | Descrição |
|---|---|
| url | URL para qual o Webhook foi enviado |
| type | Esse campo serve para informar qual é o webhook que está vindo |
| status | Esse campo serve para informar qual é o status do webhook |
| data | Local onde virão os dados do webhook |
| hook_id | ID do webhook que foi enviado |
Cadastrar webhook
Exemplo de requisição:
{
"url": "https://teste2lwebhook"
}
Requisição POST com objetos JSON para o seguinte URL:
https://api.zsystems.com.br/estabelecimentos/url-webhook
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"config": {
"id": 29964,
"estabelecimento_id": 1,
"tipo_configuracao_id": 13,
"slug": "url_webhook",
"valor": "https://teste2lwebhook",
"modified": "2022-05-04T14:59:35.285Z",
"created": "2022-05-04T14:59:35.285Z"
}
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| URL | URL para qual o Webhook foi enviado |
listar webhook
Exemplo de requisição:
{}
Requisição GET para o seguinte URL:
https://api.zsystems.com.br/estabelecimentos/url-webhook
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"urlWebhooks": [
{
"id": 29963,
"estabelecimento_id": 1,
"tipo_configuracao_id": 13,
"slug": "url_webhook",
"valor": "https://teste1lwebhook",
"created": "2022-05-04T14:59:29.000Z",
"modified": "2022-05-04T14:59:29.000Z",
"removed": null
},
{
"id": 29964,
"estabelecimento_id": 1,
"tipo_configuracao_id": 13,
"slug": "url_webhook",
"valor": "https://teste2lwebhook",
"created": "2022-05-04T14:59:35.000Z",
"modified": "2022-05-04T14:59:35.000Z",
"removed": null
}
]
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|
Remover webhook
Exemplo de requisição:
{}
Requisição DELETE com parâmetros na URL:
https://api.zsystems.com.br/estabelecimentos/url-webhook/{webhookId}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true
}
PARÂMETROS
| Id | Tipo | Descrição |
|---|---|---|
| Id | Código de identificação do webhook que deseja excluir |
Webhook quando um plano é criado
Webhook:
{
"url": "https://google.com.br",
"type": "plan",
"status": "created",
"data": {
"id": 15,
"name": "Teste 1",
"description": "Teste de Plano",
"frequency": "daily",
"interval": 1,
"amount": 10,
"setup_amount": 2,
"grace_period": "0",
"tolerance_period": 0,
"created": "2020-01-20T20:55:14.000Z",
"modified": "2020-01-20T20:55:14.000Z",
"removed": null
}
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador do plano, nesse caso 15; |
| name | Refere-se ao nome do plano, nesse caso “Teste 1”; |
| description | É a descrição do plano, nesse caso: “Teste de Plano”; |
| frequency | É a frequencia do plano, nesse caso é uma recorrencia diaria |
| interval | É o interval entre a próxima recorrencia, nesse caso está marcado como 1, então o plano será cobrado de 1 em 1 dia |
| amount | É o valor que será cobrado sempre que a recorrência ocorrer, nesse caso é R$ 0,10 |
| setup_amount | É o valor a ser cobrado no ato da adesão do plano, nesse caso o valor é R$ 0,02 |
| grace_period | É o período gratuito antes de realizer a primeira cobrança. |
Webhook quando um plano é atualizado
Webhook:
{
"url": "https://google.com.br",
"type": "plan",
"status": "updated",
"data": {
"id": 15,
"name": "Teste 12",
"description": "Teste de Plano",
"frequency": "daily",
"interval": 1,
"amount": 11,
"setup_amount": 2,
"grace_period": "0",
"tolerance_period": 0,
"created": "2020-01-20T20:55:14.000Z",
"modified": "2020-01-20T20:57:28.000Z",
"removed": null
}
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador do plano, nesse caso 15; |
| name | Refere-se ao nome do plano, nesse caso “Teste 1”; |
| description | É a descrição do plano, nesse caso: “Teste de Plano”; |
| frequency | É a frequencia do plano, nesse caso é uma recorrencia diaria |
| interval | É o interval entre a próxima recorrencia, nesse caso está marcado como 1, então o plano será cobrado de 1 em 1 dia |
| amount | É o valor que será cobrado sempre que a recorrência ocorrer, nesse caso é R$ 0,10 |
| setup_amount | É o valor a ser cobrado no ato da adesão do plano, nesse caso o valor é R$ 0,02 |
| grace_period | É o período gratuito antes de realizer a primeira cobrança. |
Webhook quando um plano é deletado
Webhook:
{
"url": "https://google.com.br",
"type": "plan",
"status": "deleted",
"data": {
"id": 15,
"name": "Teste 12",
"description": "Teste de Plano",
"frequency": "daily",
"interval": 1,
"amount": 11,
"setup_amount": 2,
"grace_period": "0",
"tolerance_period": 0,
"created": "2020-01-20T20:55:14.000Z",
"modified": "2020-01-20T21:07:31.684Z",
"removed": "2020-01-20T21:07:31.655Z"
}
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador do plano, nesse caso 15; |
| name | Refere-se ao nome do plano, nesse caso “Teste 1”; |
| description | É a descrição do plano, nesse caso: “Teste de Plano”; |
| frequency | É a frequencia do plano, nesse caso é uma recorrencia diaria |
| interval | É o interval entre a próxima recorrencia, nesse caso está marcado como 1, então o plano será cobrado de 1 em 1 dia |
| amount | É o valor que será cobrado sempre que a recorrência ocorrer, nesse caso é R$ 0,10 |
| setup_amount | É o valor a ser cobrado no ato da adesão do plano, nesse caso o valor é R$ 0,02 |
| grace_period | É o período gratuito antes de realizer a primeira cobrança. |
Webhook ao assinar um plano
Webhook:
{
"url": "https://google.com.br",
"type": "subscription",
"status": "created",
"data": {
"id": 4,
"plano_id": 17,
"cliente_id": 13572,
"ativo": 1,
"status_assinatura_id": 3,
"payment_method": "credit",
"due_date": "2020-01-23",
"due_since_date": "2020-01-22",
"expiration_date": null,
"suspended_at": null,
"amount": 1,
"currency": "BRL",
"created": "2020-01-22T20:43:22.000Z",
"modified": "2020-01-22T20:46:25.000Z",
"removed": null,
"plano": {
"id": 17,
"name": "Plano 001",
"description": "001",
"frequency": "daily",
"interval": 1,
"amount": 1,
"setup_amount": 0,
"grace_period": "0",
"tolerance_period": 0,
"created": "2020-01-22T17:03:15.000Z",
"modified": "2020-01-22T17:03:15.000Z"
},
"status_assinatura": {
"titulo": "Pago"
},
"cliente": {
"nome": "assinante",
"email": "assinante@zsystems.com.br",
"sexo": "M",
"data_nascimento": "1991-12-26",
"endereco": {
"logradouro": "Rua Assinante",
"numero": "124",
"complemento": "",
"cep": "03380235",
"cidade": "São Paulo",
"uf": "SP"
},
"clientes_documentos": [
{
"tipo_documento_id": 2,
"documento": "413222222222",
"tipo_documento": {
"titulo": "CPF",
"id": 2
}
}
],
"clientes_contatos": [
{
"contato": "1142141241",
"tipo_contato_id": 1,
"tipo_contato": {
"titulo": "Telefone",
"id": 1
}
},
{
"contato": "41414141241",
"tipo_contato_id": 2,
"tipo_contato": {
"titulo": "Celular",
"id": 2
}
}
]
}
},
"hook_id": 130
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador dessa assinatura. Nesse caso 4; |
| plano_id | Refere-se a qual plano essa assinatura pertence, nesse caso é ao plano 17; |
| ativo | Assinatura ativa ou suspensa? (1 ativo, 0 suspenso) |
| status_assinatura_id | Status a qual o plano se encontra no momento |
| payment_method | É o método de pagamento |
| due_date | É a data da próxima cobrança |
| due_since_date | É a data da primeira cobrança |
| expiration_date | É a data de expiração da assinatura |
| suspended_date | É a data que a assinatura foi suspensa |
| ID(Plano) | É o identificador do plano, Nesse caso 15; |
| name | Nome do plano; |
| description | Descrição do plano |
| frequency | Frequência na qual o plano será cobrado (diário, semanal, mensal, anual) |
| interval | É o intervalo entre a próxima recorrência. Nesse caso está marcado como 1, então o plano será cobrado de 1 em 1 dia |
| amount | É o valor que será cobrado sempre que a recorrência ocorrer |
| step_amount | É o valor a ser cobrado no ato da adesão do plano. |
| grace_period | É o período gratuito antes de realizar a primeira cobrança |
| titulo(Status_assinatura) | Titulo do status desta assinatura; |
| ID(Cliente) | É o identificador do cliente |
| nome | É o nome do cliente |
| É o e-mail do cliente | |
| sexo | é o sexo que o cliente definiu no ato do cadastro |
| data_nascimento | Data de nascimento do cliente |
| Endereco | Endereço do cliente |
| logradouro | Rua do cliente |
| numero | Número da residência |
| complemento | Complemento do endereço |
| cep | CEP da rua |
| cidade | Cidade |
| uf | Estado |
| clientes_documentos | Estado |
| documento | Número do documento |
| titulo(tipo_documento) | Titulo do documento (RG/CPF) |
| clientes_contatos | Telefones do cliente |
| tipo_contato_id | identificador do contato |
| contato | Número do contato |
| id(tipo_contato) | identificado do contato |
| titulo(tipo_contato) | Titulo do contato (celular/telefone) |
| hook_id | É o identificador do webhook |
Webhook ao atualizar uma assinatura
Webhook:
{
"url": "https://google.com.br",
"type": "subscription",
"status": "updated",
"data": {
"id": 4,
"plano_id": 17,
"cliente_id": 13572,
"ativo": 1,
"status_assinatura_id": 1,
"payment_method": "credit",
"due_date": "2020-01-24",
"due_since_date": "2020-01-22",
"expiration_date": null,
"suspended_at": null,
"amount": 1,
"currency": "BRL",
"created": "2020-01-22T20:43:22.000Z",
"modified": "2020-01-22T21:08:17.000Z",
"removed": null,
"plano": {
"id": 17,
"name": "Plano 001",
"description": "001",
"frequency": "daily",
"interval": 1,
"amount": 1,
"setup_amount": 0,
"grace_period": "0",
"tolerance_period": 0,
"created": "2020-01-22T17:03:15.000Z",
"modified": "2020-01-22T17:03:15.000Z"
},
"status_assinatura": {
"titulo": "Aguardando"
},
"cliente": {
"id": 13572,
"nome": "joao paulo",
"email": "teste@zsystems.com.br",
"sexo": "M",
"data_nascimento": "1991-12-26",
"endereco": {
"logradouro": "Rua 2222222",
"numero": "124",
"complemento": "",
"cep": "03380222",
"cidade": "São Paulo",
"uf": "SP"
},
"clientes_documentos": [
{
"tipo_documento_id": 2,
"documento": "41372222222",
"tipo_documento": {
"titulo": "CPF",
"id": 2
}
}
],
"clientes_contatos": [
{
"contato": "1142141241",
"tipo_contato_id": 1,
"tipo_contato": {
"titulo": "Telefone",
"id": 1
}
},
{
"contato": "41414141241",
"tipo_contato_id": 2,
"tipo_contato": {
"titulo": "Celular",
"id": 2
}
}
]
}
},
"hook_id": 131
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador dessa assinatura. Nesse caso 4; |
| plano_id | Refere-se a qual plano essa assinatura pertence, nesse caso é ao plano 17; |
| ativo | Assinatura ativa ou suspensa? (1 ativo, 0 suspenso) |
| status_assinatura_id | Status a qual o plano se encontra no momento |
| payment_method | É o método de pagamento |
| due_date | É a data da próxima cobrança |
| due_since_date | É a data da primeira cobrança |
| expiration_date | É a data de expiração da assinatura |
| suspended_date | É a data que a assinatura foi suspensa |
| ID(Plano) | É o identificador do plano, Nesse caso 15; |
| name | Nome do plano; |
| description | Descrição do plano |
| frequency | Frequência na qual o plano será cobrado (diário, semanal, mensal, anual) |
| interval | É o intervalo entre a próxima recorrência. Nesse caso está marcado como 1, então o plano será cobrado de 1 em 1 dia |
| amount | É o valor que será cobrado sempre que a recorrência ocorrer |
| step_amount | É o valor a ser cobrado no ato da adesão do plano. |
| grace_period | É o período gratuito antes de realizar a primeira cobrança |
| titulo(Status_assinatura) | Titulo do status desta assinatura; |
| ID(Cliente) | É o identificador do cliente |
| nome | É o nome do cliente |
| É o e-mail do cliente | |
| sexo | é o sexo que o cliente definiu no ato do cadastro |
| data_nascimento | Data de nascimento do cliente |
| Endereco | Endereço do cliente |
| logradouro | Rua do cliente |
| numero | Número da residência |
| complemento | Complemento do endereço |
| cep | CEP da rua |
| cidade | Cidade |
| uf | Estado |
| clientes_documentos | Estado |
| documento | Número do documento |
| titulo(tipo_documento) | Titulo do documento (RG/CPF) |
| clientes_contatos | Telefones do cliente |
| tipo_contato_id | identificador do contato |
| contato | Número do contato |
| id(tipo_contato) | identificado do contato |
| titulo(tipo_contato) | Titulo do contato (celular/telefone) |
Webhook ao Suspender uma assinatura
Webhook:
{
"url": "https://google.com.br",
"type": "subscription",
"status": "suspended",
"data": {
"id": 4,
"plano_id": 17,
"cliente_id": 13572,
"ativo": 0,
"status_assinatura_id": 4,
"payment_method": "credit",
"due_date": "2020-01-24",
"due_since_date": "2020-01-22",
"expiration_date": null,
"suspended_at": "2020-01-22T21:11:46.000Z",
"amount": 1,
"currency": "BRL",
"created": "2020-01-22T20:43:22.000Z",
"modified": "2020-01-22T21:11:56.000Z",
"removed": null,
"plano": {
"id": 17,
"name": "Plano 001",
"description": "001",
"frequency": "daily",
"interval": 1,
"amount": 1,
"setup_amount": 0,
"grace_period": "0",
"tolerance_period": 0,
"created": "2020-01-22T17:03:15.000Z",
"modified": "2020-01-22T17:03:15.000Z"
},
"status_assinatura": {
"titulo": "Atrasado"
},
"cliente": {
"id": 13572,
"nome": "joao paulo",
"email": "teste@zsystems.com.br",
"sexo": "M",
"data_nascimento": "1991-12-26",
"endereco": {
"logradouro": "Rua 2222222",
"numero": "124",
"complemento": "",
"cep": "03380222",
"cidade": "São Paulo",
"uf": "SP"
},
"clientes_documentos": [
{
"tipo_documento_id": 2,
"documento": "41372222222",
"tipo_documento": {
"titulo": "CPF",
"id": 2
}
}
],
"clientes_contatos": [
{
"contato": "1142141241",
"tipo_contato_id": 1,
"tipo_contato": {
"titulo": "Telefone",
"id": 1
}
},
{
"contato": "41414141241",
"tipo_contato_id": 2,
"tipo_contato": {
"titulo": "Celular",
"id": 2
}
}
]
}
},
"hook_id": 132
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador dessa assinatura. Nesse caso 4; |
| plano_id | Refere-se a qual plano essa assinatura pertence, nesse caso é ao plano 17; |
| ativo | Assinatura ativa ou suspensa? (1 ativo, 0 suspenso) |
| status_assinatura_id | Status a qual o plano se encontra no momento |
| payment_method | É o método de pagamento |
| due_date | É a data da próxima cobrança |
| due_since_date | É a data da primeira cobrança |
| expiration_date | É a data de expiração da assinatura |
| suspended_date | É a data que a assinatura foi suspensa |
| ID(Plano) | É o identificador do plano, Nesse caso 15; |
| name | Nome do plano; |
| description | Descrição do plano |
| frequency | Frequência na qual o plano será cobrado (diário, semanal, mensal, anual) |
| interval | É o intervalo entre a próxima recorrência. Nesse caso está marcado como 1, então o plano será cobrado de 1 em 1 dia |
| amount | É o valor que será cobrado sempre que a recorrência ocorrer |
| step_amount | É o valor a ser cobrado no ato da adesão do plano. |
| grace_period | É o período gratuito antes de realizar a primeira cobrança |
| titulo(Status_assinatura) | Titulo do status desta assinatura; |
| ID(Cliente) | É o identificador do cliente |
| nome | É o nome do cliente |
| É o e-mail do cliente | |
| sexo | é o sexo que o cliente definiu no ato do cadastro |
| data_nascimento | Data de nascimento do cliente |
| Endereco | Endereço do cliente |
| logradouro | Rua do cliente |
| numero | Número da residência |
| complemento | Complemento do endereço |
| cep | CEP da rua |
| cidade | Cidade |
| uf | Estado |
| clientes_documentos | Estado |
| documento | Número do documento |
| titulo(tipo_documento) | Titulo do documento (RG/CPF) |
| clientes_contatos | Telefones do cliente |
| tipo_contato_id | identificador do contato |
| contato | Número do contato |
| id(tipo_contato) | identificado do contato |
| titulo(tipo_contato) | Titulo do contato (celular/telefone) |
Webhook ao reativar uma assinatura
Webhook:
{
"url": "https://google.com.br",
"type": "subscription",
"status": "active",
"data": {
"id": 4,
"plano_id": 17,
"cliente_id": 13572,
"ativo": 1,
"status_assinatura_id": 1,
"payment_method": "credit",
"due_date": "2020-01-24",
"due_since_date": "2020-01-22",
"expiration_date": null,
"suspended_at": null,
"amount": 1,
"currency": "BRL",
"created": "2020-01-22T20:43:22.000Z",
"modified": "2020-01-22T21:15:09.000Z",
"removed": null,
"plano": {
"id": 17,
"name": "Plano 001",
"description": "001",
"frequency": "daily",
"interval": 1,
"amount": 1,
"setup_amount": 0,
"grace_period": "0",
"tolerance_period": 0,
"created": "2020-01-22T17:03:15.000Z",
"modified": "2020-01-22T17:03:15.000Z"
},
"status_assinatura": {
"titulo": "Aguardando"
},
"cliente": {
"id": 13572,
"nome": "joao paulo",
"email": "teste@zsystems.com.br",
"sexo": "M",
"data_nascimento": "1991-12-26",
"endereco": {
"logradouro": "Rua 2222222",
"numero": "124",
"complemento": "",
"cep": "03380222",
"cidade": "São Paulo",
"uf": "SP"
},
"clientes_documentos": [
{
"tipo_documento_id": 2,
"documento": "41372222222",
"tipo_documento": {
"titulo": "CPF",
"id": 2
}
}
],
"clientes_contatos": [
{
"contato": "1142141241",
"tipo_contato_id": 1,
"tipo_contato": {
"titulo": "Telefone",
"id": 1
}
},
{
"contato": "41414141241",
"tipo_contato_id": 2,
"tipo_contato": {
"titulo": "Celular",
"id": 2
}
}
]
}
},
"hook_id": 133
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador dessa assinatura. Nesse caso 4; |
| plano_id | Refere-se a qual plano essa assinatura pertence, nesse caso é ao plano 17; |
| ativo | Assinatura ativa ou suspensa? (1 ativo, 0 suspenso) |
| status_assinatura_id | Status a qual o plano se encontra no momento |
| payment_method | É o método de pagamento |
| due_date | É a data da próxima cobrança |
| due_since_date | É a data da primeira cobrança |
| expiration_date | É a data de expiração da assinatura |
| suspended_date | É a data que a assinatura foi suspensa |
| ID(Plano) | É o identificador do plano, Nesse caso 15; |
| name | Nome do plano; |
| description | Descrição do plano |
| frequency | Frequência na qual o plano será cobrado (diário, semanal, mensal, anual) |
| interval | É o intervalo entre a próxima recorrência. Nesse caso está marcado como 1, então o plano será cobrado de 1 em 1 dia |
| amount | É o valor que será cobrado sempre que a recorrência ocorrer |
| step_amount | É o valor a ser cobrado no ato da adesão do plano. |
| grace_period | É o período gratuito antes de realizar a primeira cobrança |
| titulo(Status_assinatura) | Titulo do status desta assinatura; |
| ID(Cliente) | É o identificador do cliente |
| nome | É o nome do cliente |
| É o e-mail do cliente | |
| sexo | é o sexo que o cliente definiu no ato do cadastro |
| data_nascimento | Data de nascimento do cliente |
| Endereco | Endereço do cliente |
| logradouro | Rua do cliente |
| numero | Número da residência |
| complemento | Complemento do endereço |
| cep | CEP da rua |
| cidade | Cidade |
| uf | Estado |
| clientes_documentos | Estado |
| documento | Número do documento |
| titulo(tipo_documento) | Titulo do documento (RG/CPF) |
| clientes_contatos | Telefones do cliente |
| tipo_contato_id | identificador do contato |
| contato | Número do contato |
| id(tipo_contato) | identificado do contato |
| titulo(tipo_contato) | Titulo do contato (celular/telefone) |
Webhook ao remover uma assinatura
Webhook:
{
"url": "https://google.com.br",
"type": "subscription",
"status": "deleted",
"data": {
"id": 4,
"plano_id": 17,
"cliente_id": 13572,
"ativo": 0,
"status_assinatura_id": 2,
"payment_method": "credit",
"due_date": "2020-01-24",
"due_since_date": "2020-01-22",
"expiration_date": null,
"suspended_at": null,
"amount": 1,
"currency": "BRL",
"created": "2020-01-22T20:43:22.000Z",
"modified": "2020-01-22T21:17:10.000Z",
"removed": "2020-01-22T21:17:03.000Z",
"plano": {
"id": 17,
"name": "Plano 001",
"description": "001",
"frequency": "daily",
"interval": 1,
"amount": 1,
"setup_amount": 0,
"grace_period": "0",
"tolerance_period": 0,
"created": "2020-01-22T17:03:15.000Z",
"modified": "2020-01-22T17:03:15.000Z"
},
"status_assinatura": {
"titulo": "Cancelado"
},
"cliente": {
"id": 13572,
"nome": "joao paulo",
"email": "teste@zsystems.com.br",
"sexo": "M",
"data_nascimento": "1991-12-26",
"endereco": {
"logradouro": "Rua 2222222",
"numero": "124",
"complemento": "",
"cep": "03380222",
"cidade": "São Paulo",
"uf": "SP"
},
"clientes_documentos": [
{
"tipo_documento_id": 2,
"documento": "41372222222",
"tipo_documento": {
"titulo": "CPF",
"id": 2
}
}
],
"clientes_contatos": [
{
"contato": "1142141241",
"tipo_contato_id": 1,
"tipo_contato": {
"titulo": "Telefone",
"id": 1
}
},
{
"contato": "41414141241",
"tipo_contato_id": 2,
"tipo_contato": {
"titulo": "Celular",
"id": 2
}
}
]
}
},
"hook_id": 134
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador dessa assinatura. Nesse caso 4; |
| plano_id | Refere-se a qual plano essa assinatura pertence, nesse caso é ao plano 17; |
| ativo | Assinatura ativa ou suspensa? (1 ativo, 0 suspenso) |
| status_assinatura_id | Status a qual o plano se encontra no momento |
| payment_method | É o método de pagamento |
| due_date | É a data da próxima cobrança |
| due_since_date | É a data da primeira cobrança |
| expiration_date | É a data de expiração da assinatura |
| suspended_date | É a data que a assinatura foi suspensa |
| ID(Plano) | É o identificador do plano, Nesse caso 15; |
| name | Nome do plano; |
| description | Descrição do plano |
| frequency | Frequência na qual o plano será cobrado (diário, semanal, mensal, anual) |
| interval | É o intervalo entre a próxima recorrência. Nesse caso está marcado como 1, então o plano será cobrado de 1 em 1 dia |
| amount | É o valor que será cobrado sempre que a recorrência ocorrer |
| step_amount | É o valor a ser cobrado no ato da adesão do plano. |
| grace_period | É o período gratuito antes de realizar a primeira cobrança |
| titulo(Status_assinatura) | Titulo do status desta assinatura; |
| ID(Cliente) | É o identificador do cliente |
| nome | É o nome do cliente |
| É o e-mail do cliente | |
| sexo | É o sexo que o cliente definiu no ato do cadastro |
| data_nascimento | Data de nascimento do cliente |
| Endereco | Endereço do cliente |
| logradouro | Rua do cliente |
| numero | Número da residência |
| complemento | Complemento do endereço |
| cep | CEP da rua |
| cidade | Cidade |
| uf | Estado |
| clientes_documentos | Estado |
| documento | Número do documento |
| titulo(tipo_documento) | Titulo do documento (RG/CPF) |
| clientes_contatos | Telefones do cliente |
| tipo_contato_id | identificador do contato |
| contato | Número do contato |
| id(tipo_contato) | identificado do contato |
| titulo(tipo_contato) | Titulo do contato (celular/telefone) |
Webhook quando uma assinatura é criada
Webhook:
{
"url": "https://google.com.br",
"type": "invoice",
"status": "created",
"data": {
"id": 17,
"assinatura_id": "5",
"plano_id": "17",
"amount": "2",
"paid_at": null,
"voided_at": null,
"retries": 0,
"max_retries": 3,
"status": "pending",
"date_invoice": "2020-01-29",
"assinatura": {
"id": 5,
"cliente_id": 14181,
"ativo": 1,
"status_assinatura_id": 1,
"due_date": "2020-01-29",
"due_since_date": "2020-01-24",
"expiration_date": "2020-01-29",
"amount": 2,
"suspended_at": null,
"removed": null,
"status_assinatura": {
"id": 1,
"titulo": "Aguardando"
},
"cliente": {
"id": 14181,
"nome": "Teste Assinatura",
"email": "integracao@zsystems.com.br"
}
},
"plano": {
"id": 17,
"name": "Plano 001",
"description": "001"
}
},
"hook_id": 398
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador dessa invoice (fatura) |
| assinatura_id | É o ID da assinatura que está fazendo o pagamento |
| plano_id | É o ID do plano |
| amount | é o valor que foi pago. |
| paid_at | Refere-se a data que foi pago. |
| retries | Quantidade de tentativas que teve até ocorrer o pagamento |
| max_retries | Quantidade máxima de retentativas |
| date_invoice | Data do pagamento |
| id(assinatura) | ID da assinatura |
| cliente_id | Id do cliente dessa assinatura |
| status_assinatura_id | status que a assinatura está. [ 1 => Aguardando, 2 => Cancelado, 3 => Pago, 4 => Atrasado , 5 => Suspenso ] |
| due_date | Data da próxima cobrança |
| due_since_date | Data da primeira cobrança |
| expiration_date | Data que a assinatura irá expirar |
| amount | Valor a ser cobrado na recorrência |
| suspended_at | Data que a assinatura foi suspensa |
| removed | Data que a assinatura foi removida |
| id(status_assinatura) | ID do status |
| titulo(status_assinatura) | titulo do status do pagamento |
Webhook quando a cobrança de uma assinatura retorna sucesso
Webhook:
{
"url": "https://google.com.br",
"type": "invoice",
"status": "paid",
"data": {
"id": 17,
"assinatura_id": "5",
"plano_id": "17",
"amount": "2",
"paid_at": null,
"voided_at": null,
"retries": 0,
"max_retries": 3,
"status": "paid",
"date_invoice": "2020-01-29",
"assinatura": {
"id": 5,
"cliente_id": 14181,
"ativo": 1,
"status_assinatura_id": 3,
"due_date": "2020-02-13",
"due_since_date": "2020-01-24",
"expiration_date": "2020-01-29",
"amount": 2,
"suspended_at": null,
"removed": null,
"status_assinatura": {
"id": 3,
"titulo": "Pago"
},
"cliente": {
"id": 14181,
"nome": "Teste Assinatura",
"email": "integracao@zsystems.com.br"
},
"plano": {
"id": 17,
"name": "Plano 001",
"description": "001"
}
}
},
"hook_id": 811
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador dessa invoice (fatura) |
| assinatura_id | É o ID da assinatura que está fazendo o pagamento |
| plano_id | É o ID do plano |
| amount | é o valor que foi pago. |
| paid_at | Refere-se a data que foi pago. |
| retries | Quantidade de tentativas que teve até ocorrer o pagamento |
| max_retries | Quantidade máxima de retentativas |
| date_invoice | Data do pagamento |
| id(assinatura) | ID da assinatura |
| cliente_id | Id do cliente dessa assinatura |
| status_assinatura_id | status que a assinatura está. [ 1 => Aguardando, 2 => Cancelado, 3 => Pago, 4 => Atrasado , 5 => Suspenso ] |
| due_date | Data da próxima cobrança |
| due_since_date | Data da primeira cobrança |
| expiration_date | Data que a assinatura irá expirar |
| amount | Valor a ser cobrado na recorrência |
| suspended_at | Data que a assinatura foi suspensa |
| removed | Data que a assinatura foi removida |
| id(status_assinatura) | ID do status |
| titulo(status_assinatura) | titulo do status do pagamento |
Webhook quando uma assinatura(fatura) não foi paga
Webhook:
{
"url": "https://google.com.br",
"type": "invoice",
"status": "overdue",
"data": {
"id": 9,
"assinatura_id": "3",
"plano_id": "17",
"amount": "5",
"paid_at": null,
"voided_at": null,
"retries": 3,
"max_retries": 3,
"status": "failed",
"date_invoice": "2020-01-24",
"assinatura": {
"id": 3,
"cliente_id": 13246,
"ativo": 1,
"status_assinatura_id": 5,
"due_date": "2020-01-24",
"due_since_date": null,
"expiration_date": null,
"amount": 5,
"suspended_at": null,
"removed": null,
"status_assinatura": {
"id": 5,
"titulo": "Suspenso"
},
"cliente": {
"id": 13246,
"nome": "fdsa fdsfas",
"email": "fdsafda@gmail.com"
},
"plano": {
"id": 17,
"name": "Plano 001",
"description": "001"
}
}
},
"hook_id": 217
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador dessa invoice (fatura) |
| assinatura_id | É o ID da assinatura que está fazendo o pagamento |
| plano_id | É o ID do plano |
| amount | é o valor que foi pago. |
| paid_at | Refere-se a data que foi pago. |
| retries | Quantidade de tentativas que teve até ocorrer o pagamento |
| max_retries | Quantidade máxima de retentativas |
| date_invoice | Data do pagamento |
| id(assinatura) | ID da assinatura |
| cliente_id | Id do cliente dessa assinatura |
| status_assinatura_id | status que a assinatura está. [ 1 => Aguardando, 2 => Cancelado, 3 => Pago, 4 => Atrasado , 5 => Suspenso ] |
| due_date | Data da próxima cobrança |
| due_since_date | Data da primeira cobrança |
| expiration_date | Data que a assinatura irá expirar |
| amount | Valor a ser cobrado na recorrência |
| suspended_at | Data que a assinatura foi suspensa |
| removed | Data que a assinatura foi removida |
| id(status_assinatura) | ID do status |
| titulo(status_assinatura) | titulo do status do pagamento |
Webhook quando uma assinatura(fatura) não foi paga
Webhook:
{
"url": "https://google.com.br",
"type": "invoice",
"status": "refunded",
"data": {
"id": 15,
"assinatura_id": "5",
"plano_id": "17",
"amount": "1",
"paid_at": "2020-01-27T03:13:33.000Z",
"voided_at": "2020-01-28T15:45:33.000Z",
"retries": 0,
"max_retries": 3,
"status": "void",
"date_invoice": "2020-01-27",
"assinatura": {
"id": 5,
"cliente_id": 14181,
"ativo": 1,
"status_assinatura_id": 1,
"due_date": "2020-01-29",
"due_since_date": "2020-01-24",
"expiration_date": "2020-01-29",
"amount": 2,
"suspended_at": null,
"removed": null,
"status_assinatura": {
"id": 1,
"titulo": "Aguardando"
},
"cliente": {
"id": 14181,
"nome": "Teste Assinatura",
"email": "integracao@zsystems.com.br"
},
"plano": {
"id": 17,
"name": "Plano 001",
"description": "001"
}
}
},
"hook_id": 269
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador dessa invoice (fatura) |
| assinatura_id | É o ID da assinatura que está fazendo o pagamento |
| plano_id | É o ID do plano |
| amount | é o valor que foi pago. |
| paid_at | Refere-se a data que foi pago. |
| retries | Quantidade de tentativas que teve até ocorrer o pagamento |
| max_retries | Quantidade máxima de retentativas |
| date_invoice | Data do pagamento |
| id(assinatura) | ID da assinatura |
| cliente_id | Id do cliente dessa assinatura |
| status_assinatura_id | status que a assinatura está. [ 1 => Aguardando, 2 => Cancelado, 3 => Pago, 4 => Atrasado , 5 => Suspenso ] |
| due_date | Data da próxima cobrança |
| due_since_date | Data da primeira cobrança |
| expiration_date | Data que a assinatura irá expirar |
| amount | Valor a ser cobrado na recorrência |
| suspended_at | Data que a assinatura foi suspensa |
| removed | Data que a assinatura foi removida |
| id(status_assinatura) | ID do status |
| titulo(status_assinatura) | titulo do status do pagamento |
Webhook quando é realizada uma venda
Webhook:
{
"url": "https://google.com.br",
"type": "receivable",
"status": "created",
"data": {
"id": 15404,
"tipo_pagamento_id": 3,
"status_pagamento_id": 1,
"pedido_id": 15433,
"valor": "5.00",
"taxa": "0.18",
"data_recebimento": "2020-02-24T00:00:00.000Z",
"valor_recebido": "4.82",
"data_pagamento": null,
"status_pagamento": {
"id": 1,
"titulo": "Pendente"
},
"pedido": {
"id": 15433,
"status_pedido_id": 2,
"pos_identification_number": null,
"splitted": false,
"created": "2020-01-24T18:07:37.000Z",
"modified": "2020-01-24T18:07:42.000Z",
"status_pedido": {
"id": 2,
"titulo": "Aprovado"
}
},
"tipo_pagamento": {
"id": 3,
"titulo": "Cartão de Crédito"
}
},
"hook_id": 207
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador do pagamento |
| tipo_pagamento_id | Qual é o tipo de pagamento? [ 1 => Boleto, 2 => Débito, 3 => Crédito ] |
| status_pagamento_id | Qual status esse pagamento está? [ 1 => Pendente, 2 => Pago, 3 => Cancelado, 4 => Estornado] |
| pedido_id | A qual pedido esse pagamento pertence |
| valor | É o valor esperado no ato do pagamento |
| taxa | Caso tenha alguma taxa será apresentado nesse campo |
| data_recebimento | Data de vencimento |
| valor_recebido | Valor que foi recebido no ato do pagamento |
| data_pagamento | Data qual foi pago |
| id(tipo_pagamento) | ID do tipo de pagamento |
| titulo(tipo_pagamento) | titulo do tipo de pagamento |
| status_pagamento | |
| id (status_pagamento) | ID do status |
| titulo | titulo do status do pagamento |
| pedido | |
| ID (pedido ) | É o identificador do 'pagamento'; |
| status_pedido_id | Qual é o tipo desse pedido? [ 1 => Pendente, 2 => Aprovado, 3 => Falhado, 4 => Cancelado, 5 => Parcialmente Pago, 6 => Estornado, 7 => Em Processamento] |
| pos_identification_id | identificador da máquina POS |
| status_pedido | |
| ID | É o ID do status |
| titulo | Titulo do status |
Webhook quando um recebivel é pago
Webhook:
{
"url": "https://google.com.br",
"type": "receivable",
"status": "paid",
"data": {
"id": 12618,
"tipo_pagamento_id": 3,
"status_pagamento_id": 2,
"pedido_id": 12970,
"valor": "10.00",
"taxa": "0.34",
"data_recebimento": "2020-01-20T03:00:00.000Z",
"valor_recebido": "9.57",
"data_pagamento": "2020-01-20T03:00:00.000Z",
"status_pagamento": {
"id": 2,
"titulo": "Pago"
},
"pedido": {
"id": 12970,
"status_pedido_id": 4,
"pos_identification_number": "20dd1d6edf144472
9363a6ec1f14c723",
"splitted": true,
"created": "2020-01-17T14:27:33.000Z",
"modified": "2020-01-20T13:15:16.000Z",
"status_pedido": {
"id": 2,
"titulo": "Aprovado"
}
},
"tipo_pagamento": {
"id": 3,
"titulo": "Cartão de Crédito"
}
},
"hook_id": 208
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador do pagamento |
| tipo_pagamento_id | Qual é o tipo de pagamento? [ 1 => Boleto, 2 => Débito, 3 => Crédito ] |
| status_pagamento_id | Qual status esse pagamento está? [ 1 => Pendente, 2 => Pago, 3 => Cancelado, 4 => Estornado] |
| pedido_id | A qual pedido esse pagamento pertence |
| valor | É o valor esperado no ato do pagamento |
| taxa | Caso tenha alguma taxa será apresentado nesse campo |
| data_recebimento | Data de vencimento |
| valor_recebido | Valor que foi recebido no ato do pagamento |
| data_pagamento | Data qual foi pago |
| id(tipo_pagamento) | ID do tipo de pagamento |
| titulo(tipo_pagamento) | titulo do tipo de pagamento |
| status_pagamento | |
| id (status_pagamento) | ID do status |
| titulo | titulo do status do pagamento |
| pedido | |
| ID (pedido ) | É o identificador do 'pagamento'; |
| status_pedido_id | Qual é o tipo desse pedido? [ 1 => Pendente, 2 => Aprovado, 3 => Falhado, 4 => Cancelado, 5 => Parcialmente Pago, 6 => Estornado, 7 => Em Processamento] |
| pos_identification_id | identificador da máquina POS |
| status_pedido | |
| ID | É o ID do status |
| titulo | Titulo do status |
Webhook quando um recebivel é cancelado
Webhook:
{
"url": "https://google.com.br",
"type": "receivable",
"status": "canceled",
"data": {
"id": 15366,
"tipo_pagamento_id": 3,
"status_pagamento_id": 3,
"pedido_id": 15398,
"valor": "0.06",
"taxa": "0.00",
"data_recebimento": "2020-02-24T00:00:00.000Z",
"valor_recebido": "0.06",
"data_pagamento": null,
"status_pagamento": {
"id": 3,
"titulo": "Cancelado"
},
"pedido": {
"id": 15398,
"status_pedido_id": 4,
"pos_identification_number": null,
"splitted": false,
"created": "2020-01-24T16:26:05.000Z",
"modified": "2020-01-24T16:29:40.000Z",
"status_pedido": {
"id": 4,
"titulo": "Cancelado"
}
},
"tipo_pagamento": {
"id": 3,
"titulo": "Cartão de Crédito"
}
},
"hook_id": 210
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador do pagamento |
| tipo_pagamento_id | Qual é o tipo de pagamento? [ 1 => Boleto, 2 => Débito, 3 => Crédito ] |
| status_pagamento_id | Qual status esse pagamento está? [ 1 => Pendente, 2 => Pago, 3 => Cancelado, 4 => Estornado] |
| pedido_id | A qual pedido esse pagamento pertence |
| valor | É o valor esperado no ato do pagamento |
| taxa | Caso tenha alguma taxa será apresentado nesse campo |
| data_recebimento | Data de vencimento |
| valor_recebido | Valor que foi recebido no ato do pagamento |
| data_pagamento | Data qual foi pago |
| id(tipo_pagamento) | ID do tipo de pagamento |
| titulo(tipo_pagamento) | titulo do tipo de pagamento |
| status_pagamento | |
| id (status_pagamento) | ID do status |
| titulo | titulo do status do pagamento |
| pedido | |
| ID (pedido ) | É o identificador do 'pagamento'; |
| status_pedido_id | Qual é o tipo desse pedido? [ 1 => Pendente, 2 => Aprovado, 3 => Falhado, 4 => Cancelado, 5 => Parcialmente Pago, 6 => Estornado, 7 => Em Processamento] |
| pos_identification_id | identificador da máquina POS |
| status_pedido | |
| ID | É o ID do status |
| titulo | Titulo do status |
Webhook quando um recebivel é estornado
Webhook:
"url": "https://google.com.br",
"type": "receivable",
"status": "refunded",
"data": {
"id": 12411,
"tipo_pagamento_id": 3,
"status_pagamento_id": 4,
"pedido_id": 12777,
"valor": "1.00",
"taxa": "0.00",
"data_recebimento": "2020-01-17T03:00:00.000Z",
"valor_recebido": "0.01",
"data_pagamento": null,
"status_pagamento": {
"id": 4,
"titulo": "Estornado"
},
"pedido": {
"id": 12777,
"status_pedido_id": 4,
"pos_identification_number": "20dd1d6edf14
44729363a6ec1f14c723",
"splitted": true,
"created": "2020-01-16T21:19:06.000Z",
"modified": "2020-01-17T17:35:16.000Z",
"status_pedido": {
"id": 4,
"titulo": "Cancelado"
}
},
"tipo_pagamento": {
"id": 3,
"titulo": "Cartão de Crédito"
}
},
"hook_id": 211
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador do pagamento |
| tipo_pagamento_id | Qual é o tipo de pagamento? [ 1 => Boleto, 2 => Débito, 3 => Crédito ] |
| status_pagamento_id | Qual status esse pagamento está? [ 1 => Pendente, 2 => Pago, 3 => Cancelado, 4 => Estornado] |
| pedido_id | A qual pedido esse pagamento pertence |
| valor | É o valor esperado no ato do pagamento |
| taxa | Caso tenha alguma taxa será apresentado nesse campo |
| data_recebimento | Data de vencimento |
| valor_recebido | Valor que foi recebido no ato do pagamento |
| data_pagamento | Data qual foi pago |
| id(tipo_pagamento) | ID do tipo de pagamento |
| titulo(tipo_pagamento) | titulo do tipo de pagamento |
| status_pagamento | |
| id (status_pagamento) | ID do status |
| titulo | titulo do status do pagamento |
| pedido | |
| ID (pedido ) | É o identificador do 'pagamento'; |
| status_pedido_id | Qual é o tipo desse pedido? [ 1 => Pendente, 2 => Aprovado, 3 => Falhado, 4 => Cancelado, 5 => Parcialmente Pago, 6 => Estornado, 7 => Em Processamento] |
| pos_identification_id | identificador da máquina POS |
| status_pedido | |
| ID | É o ID do status |
| titulo | Titulo do status |
Webhook ao criar uma venda no boleto
Webhook:
{
"url": "https://google.com.br",
"type": "transaction",
"status": "created",
"data": {
"id": 15362,
"status_pedido_id": 1,
"pos_identification_number": null,
"created": "2020-01-24T15:37:35.000Z",
"modified": "2020-01-24T15:37:36.000Z",
"removed": null,
"status_pedido": {
"id": 1,
"titulo": "Pendente"
},
"pedidos_produtos": [
{
"id": 185,
"pedido_id": 15362,
"valor_unitario": "10.02",
"quantidade": 1
}
],
"pagamentos": [
{
"id": 15331,
"tipo_pagamento_id": 1,
"status_pagamento_id": 1,
"pedido_id": 15362,
"valor": "10.02",
"taxa": "0.00",
"data_recebimento": "2020-01-29T00:00:00.000Z",
"valor_recebido": "0.00",
"data_pagamento": null,
"tipo_pagamento": {
"id": 1,
"titulo": "Boleto"
},
"status_pagamento": {
"id": 1,
"titulo": "Pendente"
}
}
]
},
"hook_id": 192
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador desse 'pedido'; |
| status_pedido_id | ID do status atual do pedido. |
| pos_identification_id | identificador da máquina POS |
| (status_pedido) | |
| Id(status_pedido) | É o ID desse status; |
| titulo (status_pedido) | Titulo do status |
| ID(pedidos_produtos) | identificador do produto; |
| valor_unitario | Preço do produto; |
| quantidade | Quantidade deste produto. |
| ID(pagamentos) | É o identificador do pagamento |
| tipo_pagamento_id | Qual é o tipo de pagamento? [ 1 => Boleto, 2 => Débito, 3 => Crédito ] |
| status_pagamento_id | Qual status esse pagamento está? [ 1 => Pendente, 2 => Pago, 3 => Cancelado, 4 => Estornado] |
| pedido_id | A qual pedido esse pagamento pertence |
| valor | É o valor esperado no ato do pagamento |
| taxa | Caso tenha alguma taxa será apresentado nesse campo |
| data_recebimento | Data de vencimento |
| valor_recebido | Valor que foi recebido no ato do pagamento |
| data_pagamento | Data qual foi pago. |
| id(tipo_pagamento ) | ID do tipo de pagamento |
| titulo (tipo_pagamento ) | titulo do tipo de pagamento |
| Id (status_pagamento) | ID do status |
| titulo (status_pagamento) | titulo do status do pagamento |
Webhook quando uma transação no cartão de credito é bem sucedida
Webhook:
{
"url": "https://google.com.br",
"type": "transaction",
"status": "succeeded",
"data": {
"id": 15398,
"status_pedido_id": 2,
"pos_identification_number": null,
"created": "2020-01-24T16:26:05.000Z",
"modified": "2020-01-24T16:26:12.000Z",
"removed": null,
"status_pedido": {
"id": 2,
"titulo": "Aprovado"
},
"pedidos_produtos": [
{
"id": 189,
"pedido_id": 15398,
"valor_unitario": "0.06",
"quantidade": 1
}
],
"pagamentos": [
{
"id": 15366,
"tipo_pagamento_id": 3,
"status_pagamento_id": 1,
"pedido_id": 15398,
"valor": "0.06",
"multa": "0.00",
"taxa": "0.00",
"data_recebimento": "2020-02-24T00:00:00.000Z",
"valor_recebido": "0.06",
"data_pagamento": null,
"tipo_pagamento": {
"id": 3,
"titulo": "Cartão de Crédito"
},
"status_pagamento": {
"id": 1,
"titulo": "Pendente"
}
}
]
},
"hook_id": 195
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador desse 'pedido'; |
| status_pedido_id | ID do status atual do pedido. |
| pos_identification_id | identificador da máquina POS |
| (status_pedido) | |
| Id(status_pedido) | É o ID desse status; |
| titulo (status_pedido) | Titulo do status |
| ID(pedidos_produtos) | identificador do produto; |
| valor_unitario | Preço do produto; |
| quantidade | Quantidade deste produto. |
| ID(pagamentos) | É o identificador do pagamento |
| tipo_pagamento_id | Qual é o tipo de pagamento? [ 1 => Boleto, 2 => Débito, 3 => Crédito ] |
| status_pagamento_id | Qual status esse pagamento está? [ 1 => Pendente, 2 => Pago, 3 => Cancelado, 4 => Estornado] |
| pedido_id | A qual pedido esse pagamento pertence |
| valor | É o valor esperado no ato do pagamento |
| taxa | Caso tenha alguma taxa será apresentado nesse campo |
| data_recebimento | Data de vencimento |
| valor_recebido | Valor que foi recebido no ato do pagamento |
| data_pagamento | Data qual foi pago. |
| id(tipo_pagamento ) | ID do tipo de pagamento |
| titulo (tipo_pagamento ) | titulo do tipo de pagamento |
| Id (status_pagamento) | ID do status |
| titulo (status_pagamento) | titulo do status do pagamento |
Webhook quando uma transação no cartão de crédito falha
Webhook:
{
"url": "https://google.com.br",
"type": "transaction",
"status": "failed",
"data": {
"id": 15393,
"status_pedido_id": 3,
"pos_identification_number": null,
"created": "2020-01-24T16:22:22.000Z",
"modified": "2020-01-24T16:22:26.000Z",
"removed": null,
"status_pedido": {
"id": 3,
"titulo": "Falhado"
},
"pedidos_produtos": [
{
"id": 187,
"pedido_id": 15393,
"valor_unitario": "1.24",
"quantidade": 1
}
],
"pagamentos": [
{
"id": 15362,
"tipo_pagamento_id": 3,
"status_pagamento_id": 3,
"pedido_id": 15393,
"valor": "1.24",
"multa": "0.00",
"taxa": "0.00",
"data_recebimento": "2020-01-24T16:22:26.000Z",
"valor_recebido": "0.00",
"data_pagamento": null,
"tipo_pagamento": {
"id": 3,
"titulo": "Cartão de Crédito"
},
"status_pagamento": {
"id": 3,
"titulo": "Cancelado"
}
}
]
},
"hook_id": 193
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador desse 'pedido'; |
| status_pedido_id | ID do status atual do pedido. |
| pos_identification_id | identificador da máquina POS |
| (status_pedido) | |
| Id(status_pedido) | É o ID desse status; |
| titulo (status_pedido) | Titulo do status |
| ID(pedidos_produtos) | identificador do produto; |
| valor_unitario | Preço do produto; |
| quantidade | Quantidade deste produto. |
| ID(pagamentos) | É o identificador do pagamento |
| tipo_pagamento_id | Qual é o tipo de pagamento? [ 1 => Boleto, 2 => Débito, 3 => Crédito ] |
| status_pagamento_id | Qual status esse pagamento está? [ 1 => Pendente, 2 => Pago, 3 => Cancelado, 4 => Estornado] |
| pedido_id | A qual pedido esse pagamento pertence |
| valor | É o valor esperado no ato do pagamento |
| taxa | Caso tenha alguma taxa será apresentado nesse campo |
| data_recebimento | Data de vencimento |
| valor_recebido | Valor que foi recebido no ato do pagamento |
| data_pagamento | Data qual foi pago. |
| id(tipo_pagamento ) | ID do tipo de pagamento |
| titulo (tipo_pagamento ) | titulo do tipo de pagamento |
| Id (status_pagamento) | ID do status |
| titulo (status_pagamento) | titulo do status do pagamento |
Webhook quando uma transação foi cancelada
Webhook:
{
"url": "https://google.com.br",
"type": "transaction",
"status": "canceled",
"data": {
"id": 15398,
"status_pedido_id": 4,
"pos_identification_number": null,
"created": "2020-01-24T16:26:05.000Z",
"modified": "2020-01-24T16:29:40.000Z",
"removed": null,
"status_pedido": {
"id": 4,
"titulo": "Cancelado"
},
"pedidos_produtos": [
{
"id": 189,
"pedido_id": 15398,
"valor_unitario": "0.06",
"quantidade": 1
}
],
"pagamentos": [
{
"id": 15366,
"tipo_pagamento_id": 3,
"status_pagamento_id": 3,
"pedido_id": 15398,
"valor": "0.06",
"multa": "0.00",
"taxa": "0.00",
"data_recebimento": "2020-02-24T00:00:00.000Z",
"valor_recebido": "0.06",
"data_pagamento": null,
"tipo_pagamento": {
"id": 3,
"titulo": "Cartão de Crédito"
},
"status_pagamento": {
"id": 3,
"titulo": "Cancelado"
}
}
]
},
"hook_id": 198
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador desse 'pedido'; |
| status_pedido_id | ID do status atual do pedido. |
| pos_identification_id | identificador da máquina POS |
| (status_pedido) | |
| Id(status_pedido) | É o ID desse status; |
| titulo (status_pedido) | Titulo do status |
| ID(pedidos_produtos) | identificador do produto; |
| valor_unitario | Preço do produto; |
| quantidade | Quantidade deste produto. |
| ID(pagamentos) | É o identificador do pagamento |
| tipo_pagamento_id | Qual é o tipo de pagamento? [ 1 => Boleto, 2 => Débito, 3 => Crédito ] |
| status_pagamento_id | Qual status esse pagamento está? [ 1 => Pendente, 2 => Pago, 3 => Cancelado, 4 => Estornado] |
| pedido_id | A qual pedido esse pagamento pertence |
| valor | É o valor esperado no ato do pagamento |
| taxa | Caso tenha alguma taxa será apresentado nesse campo |
| data_recebimento | Data de vencimento |
| valor_recebido | Valor que foi recebido no ato do pagamento |
| data_pagamento | Data qual foi pago. |
| id(tipo_pagamento ) | ID do tipo de pagamento |
| titulo (tipo_pagamento ) | titulo do tipo de pagamento |
| Id (status_pagamento) | ID do status |
| titulo (status_pagamento) | titulo do status do pagamento |
Webhook quando uma transação foi estornada
Webhook:
{
"url": "https://google.com.br",
"type": "transaction",
"status": "void",
"data": {
"id": 15398,
"status_pedido_id": 4,
"pos_identification_number": null,
"created": "2020-01-24T16:26:05.000Z",
"modified": "2020-01-24T16:29:40.000Z",
"removed": null,
"status_pedido": {
"id": 4,
"titulo": "Cancelado"
},
"pedidos_produtos": [
{
"id": 189,
"pedido_id": 15398,
"valor_unitario": "0.06",
"quantidade": 1
}
],
"pagamentos": [
{
"id": 15366,
"tipo_pagamento_id": 3,
"status_pagamento_id": 3,
"pedido_id": 15398,
"valor": "0.06",
"multa": "0.00",
"taxa": "0.00",
"data_recebimento": "2020-02-24T00:00:00.000Z",
"valor_recebido": "0.06",
"data_pagamento": null,
"tipo_pagamento": {
"id": 3,
"titulo": "Cartão de Crédito"
},
"status_pagamento": {
"id": 3,
"titulo": "Cancelado"
}
}
]
},
"hook_id": 197
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador desse 'pedido'; |
| status_pedido_id | ID do status atual do pedido. |
| pos_identification_id | identificador da máquina POS |
| (status_pedido) | |
| Id(status_pedido) | É o ID desse status; |
| titulo (status_pedido) | Titulo do status |
| ID(pedidos_produtos) | identificador do produto; |
| valor_unitario | Preço do produto; |
| quantidade | Quantidade deste produto. |
| ID(pagamentos) | É o identificador do pagamento |
| tipo_pagamento_id | Qual é o tipo de pagamento? [ 1 => Boleto, 2 => Débito, 3 => Crédito ] |
| status_pagamento_id | Qual status esse pagamento está? [ 1 => Pendente, 2 => Pago, 3 => Cancelado, 4 => Estornado] |
| pedido_id | A qual pedido esse pagamento pertence |
| valor | É o valor esperado no ato do pagamento |
| taxa | Caso tenha alguma taxa será apresentado nesse campo |
| data_recebimento | Data de vencimento |
| valor_recebido | Valor que foi recebido no ato do pagamento |
| data_pagamento | Data qual foi pago. |
| id(tipo_pagamento ) | ID do tipo de pagamento |
| titulo (tipo_pagamento ) | titulo do tipo de pagamento |
| Id (status_pagamento) | ID do status |
| titulo (status_pagamento) | titulo do status do pagamento |
Webhook quando uma transferência é programada
Webhook:
{
"url": "https://google.com.br",
"type": "transfer",
"status": "created",
"data": {
"id": 198,
"tipo_transferencia_id": 3,
"status_transferencia_id": 1,
"from_estabelecimento_id": 131,
"to_estabelecimento_id": null,
"conta_bancaria_id": 44,
"valor": "2.07",
"descricao": "Transferência Automática",
"created": "2020-01-28T17:31:35.000Z",
"modified": "2020-01-28T18:14:10.000Z",
"removed": null,
"conta_bancaria": {
"id": 44,
"nome_titular": "Integração ZSystems",
"agencia": "000",
"conta": "00000",
"documento": "12345678901",
"banco": {
"nome": "Banco Bradesco S.A.",
"codigo": 237
}
},
"FromEstabelecimento": {
"nome_fantasia": "Integração ZSystems"
},
"status_transferencia": {
"titulo": "Nova"
},
"tipo_transferencia": {
"titulo": "Automática"
}
},
"hook_id": 12
}
PARÂMETROS
| Id | Descrição |
|---|---|
| ID | É o identificador dessa “transferência”; |
| tipo_transferencia_id | Qual é o tipo da transferência? [ 3 => ‘Automática`, 2 => `Conta Bancaria` , 1 => ‘Conta digital’] |
| status_transferencia_id | Qual é o status dessa transferência? [ 1 => Nova, 2 => Pendente, 3 => Sucesso, 4 => Falha] |
| to_estabelecimento_id | Para qual estabelecimento está indo? |
| conta_bacaria_id | Para qual conta bancária está indo? |
| valor | Refere-se ao valor da transferência |
| descricao | Descrição da transferência |
| conta_bancaria | |
| ID | É o identificador da conta bancária |
| nome_titular | Titular da conta |
| agencia | Agência da conta |
| conta | Número da conta |
| documento | CPF do titular |
| nome | Nome do banco que está recebendo |
| codigo | Código do banco que está recebendo |
| Nome_fantasia(FromEstabelecimento) | De qual estabelecimento o dinheiro está saindo |
| nome_fantasia (ToEstabelecimento) | Para qual estabelecimento está indo |
| titulo (status_transferencia) | Titulo do status da transferencia |
| titulo(tipo_transferencia ) | Tipo de transferência que está ocorrendo. |