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 integracao@zspay.com.br para solicitar seu Token API.

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",
  "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",
  "estabelecimentoId": "158",
  "logo": (binary),
  "documentos[]": (binary),
  "documentosAtividade[]": (binary),
  "documentosResidencia[]": (binary),
}
                

Requisição POST para o seguinte URL como objetos JSON:
https://api.zsystems.com.br/estabelecimentos
header: ContentType 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
      }
    }
}
                

Parametros

Id Tipo Descrição
tipoEstabelecimentoID 1 = Pessoa fisica
2 = Pessoa Jurídica
identificadorPlano Código de identificação do plano
nome Nulo
nomeComprovante Nome a ser impresso nos comprovantes
email E-mail
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 Logadouro 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 Logadouro 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
email E-mail do proprietário
celular Celular do proprietário
dataNascimento Data de nascimento do proprietário
cpf CPF do proprietário
logradouro Logadouro 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
estabelecimentoId Código do estabelecimento vinculado
logo Logo da empresa
documentos[] Documentos de identificação da pessoa física (RG / CPF / CNH)
Arquivos devem ser enviados para a API via FormData
documentosAtividade[] Comprovante de atividade da pessoa física
Arquivos devem ser enviados para a API via FormData
documentosResidencia[] Comprovante de endereço da pessoa física
Arquivos devem ser enviados para a API via FormData
outrosDocumentos[] Outros documentos que a pessoa física deseja incluir no cadastro
Arquivos devem ser enviados para a API via FormData

Criar estabelecimento para pessoa jurídica


Exemplo de requisição:

{
  "tipoEstabelecimentoId": "2",
  "nome": "",
  "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",
  "estabelecimentoId": "158",
  "logo": (binary),
  "documentos[]": (binary),
  "documentosProprietario[]": (binary),
  "documentosAtividade[]": (binary),
  "documentosResidencia[]": (binary),
}
                

Requisição POST para o seguinte URL como objetos JSON:
https://api.zsystems.com.br/estabelecimentos
header: ContentType 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
      }
    }
  }
                

Parametros

Id Tipo Descrição
tipoEstabelecimentoID 1 = Pessoa fisica
2 = Pessoa Jurídica
identificadorPlano Código de identificação do plano
nome Nulo
nomeComprovante Nome a ser impresso nos comprovantes
email 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 Logadouro 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 Logadouro 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
email E-mail do proprietário
celular Celular do proprietário
dataNascimento Data de nascimento do proprietário
cpf CPF do proprietário
logradouro Logadouro 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
estabelecimentoId Código do estabelecimento vinculado
logo Logo do estabelecimento
documentos[] Documentos de identificação da empresa
Arquivos devem ser enviados para a API via FormData
documentosProprietario[] Documentos de identificação do proprietário (RG / CPF / CNH)
Arquivos devem ser enviados para a API via FormData
documentosAtividade[] Comprovante de atividade econômica da empresa
Arquivos devem ser enviados para a API via FormData
documentosResidencia[] Comprovante de endereço da empresa
Arquivos devem ser enviados para a API via FormData
outrosDocumentos[] Outros documentos que a empresa deseja incluir no cadastro
Arquivos devem ser enviados para a API via FormData

Listar Estabelecimentos


Exemplo de requisição:

{
page: 0
limit: 2
filters: {"omni":"","parentId":null}
}

                

Requisição GET para o seguinte URL como objetos JSON:
https://api.zsystems.com.br/estabelecimentos/filhos
header: ContentType application/json
authorization Bearer 'Token API'


Converter parâmentros 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
    }
  ]
}

                

Parametros

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 para o seguinte URL como objetos JSON:
https://api.zsystems.com.br/estabelecimentos/{idEstabelecimento}/token
header: ContentType application/json
authorization Bearer 'Token API'



Exemplo de resultado :

{
  "success": true,
  "token": "a4bd2bfeaec0445dc6233d2ccca662777ae45268"
}

                

Parametros

Id Tipo Descrição
idEstabelecimento Código de identificação do estabelecimento

Consultar Saldo


Exemplo de requisição:

{ }

                

Requisição GET para o seguinte URL como objetos JSON:
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"
  }
}
                

Parametros

Id Tipo Descrição
idEstabelecimento Código de identificação do estabelecimento

Consultar estabelecimento por documento


Exemplo de requisição:

{ }

                

Requisição GET para o seguinte URL como objetos JSON:
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,
    "zoop_seller_id": "8f644a7e82dd4766a53644c92c7cc270",
    "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"
    }
  }
}

                

Parametros

Id Tipo Descrição
documento Número do documento do estabelecimento a ser consultado

Habilitar estabelecimento


Exemplo de requisição:

{ }

                

Requisição POST para o seguinte URL como objetos JSON:
https://api.zsystems.com.br/estabelecimentos/{idEstabelecimento}/habilitar
header: ContentType application/json
authorization Bearer 'Token API'




Exemplo de resultado :

{
  "success": true
}

                

Parametros

Id Tipo Descrição
idEstabelecimento Código de identificação do estabelecimento

Desabilitar estabelecimento


Exemplo de requisição:

{ }

                

Requisição DELETE para o seguinte URL como objetos JSON:
https://api.zsystems.com.br/estabelecimentos/{idEstabelecimento}
header: ContentType application/json
authorization Bearer 'Token API'




Exemplo de resultado :

{
  "success": true
}

                

Parametros

Id Tipo Descrição
idEstabelecimento Código de identificação do estabelecimento
 

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 como 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"
   }
}
                

Parametros

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 como 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,
   "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
      }
   ]
}
                

Parametros

Id Tipo Descrição
id id da conta bancária

Selecionar conta bancária


Exemplo de requisição:

{ }
                

Requisição PUT como objetos JSON para o seguinte URL:
https://api.zsystems.com.br/estabelecimentos/contas_bancarias/{id}/ativar
header: ContentType application/json
authorization Bearer 'Token API'



Exemplo de resultado :

{
   "success":true
}
                

Parametros

Id Tipo Descrição
id id da conta bancária

Remover uma conta bancária


Exemplo de requisição:

{ }
                

Requisição DELETE como objetos JSON para o seguinte 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",
}

Parametros

Id Tipo Descrição
EstabelecimentoId Código de identificação do estabelecimento
ContaBancariaId Código de identificação da conta bancária
 

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 como 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"
   }
}
                

Parametros

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 agendadas


Exemplo de requisição:
 
{ }
                

Requisição GET como objetos JSON para o seguinte 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
      }
    }
  ]
}
                

Parametros

Id Tipo Descrição
tipoTransferenciaId 1 = Conta Digital
2 = Conta Bancária

Remover transferências agendadas


Exemplo de requisição:

{ }
                

Requisição DELETE como objetos JSON para o seguinte 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."
}
                

Parametros

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 como 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
    }
  }
}
                

Parametros

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
email 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 como 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"
  }
}
                

Parametros

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
 

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,
        "parentId": null
    },
    "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 como 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"
    }
}

                

Parametros

Id Tipo Descrição
estabelecimentoId Código de identificação do estabelecimento
nome Nome do usuário
email 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
id Não faço ideia
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 Logadouro do endereço do usuário
numero Numero 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 como objetos JSON para o seguinte 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"
      }
    ]
  }
}

                

Parametros

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 como 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
      }
    ]
  }
}
                

Parametros

Id Tipo Descrição
nome Nome do usuário
email 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 Logadouro 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

Alterar senha do usuário


Exemplo de requisição:

{
    "new":"zsystem123",
    "confirm":"zsystem123"
}

                

Requisição PUT como objetos JSON para o seguinte URL:
http://api.zsystems.com.br/usuarios/{usuarioId}/alterar-senha
header: ContentType application/json
authorization Bearer 'Token API'



Exemplo de resultado :

{
  "success": true,
  "message": "Operação realizada com sucesso."
}

                

Parametros

Id Tipo Descrição
new Nova senha do usuário
confirm Confirmação da nova senha

Excluir usuário


Exemplo de requisição:

{ }

                

Requisição DELETE como objetos JSON para o seguinte 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!"
}

                

Parametros

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:

{
  "tipoPagamentoId": 3,
  "valor": 500.00,
  "parcelas": 4,
  "cartao": {
    "titular": "João Paulo",
    "numero": "5234233381847212",
    "codigoSeguranca": "069",
    "validade": "02/2025"
  },
  "cliente": {
    "nome": "João paulo ",
    "cpf": "00000000000",
    "dataNascimento": "1993-01-12",
    "email": "teste2@zsystems.com.br",
    "celular": "00999998888"
  },
  "endereco": {
    "logradouro": "Rua Bartolomeu Sabino de Melo",
    "numero": "124",
    "cep": "03380-200",
    "cidade": "São Paulo",
    "estado": "SP",
    "complemento": ""
  }
}

Requisição POST como 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":{
 "tipo_pedido_id":1,
 "status_pedido_id":"1",
 "splitted":false,
 "id":2401,
 "usuario_id":107,
 "cliente_id":1569,
 "estabelecimento_id":131,
 "modified":"2019-12-04T16:10:34.153Z",
 "created":"2019-12-04T16:10:34.153Z",
"cartaoId": 12345
 }
}

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."
}

Parametros

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
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
email 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

Nova venda via cartão de crédito com cliente já definido


Exemplo de requisição:

{
  "tipoPagamentoId": 3,
  "valor": 500.00,
  "parcelas": 4,
  "cartao": {
    "titular": "João Paulo",
    "numero": "5234233381847212",
    "codigoSeguranca": "069",
    "validade": "02/2025"
  },
  "clienteId":1568
}

Requisição POST como 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":{
 "tipo_pedido_id":1,
 "status_pedido_id":"1",
 "splitted":false,
 "id":2401,
 "usuario_id":107,
 "cliente_id":1568,
 "estabelecimento_id":131,
 "modified":"2019-12-04T16:10:34.153Z",
 "created":"2019-12-04T16:10:34.153Z",
"cartaoId": 12345
 }
}

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."
}

Parametros

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
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
clienteId Identificador do cliente já cadastrado

Nova venda via cartão de crédito e cliente já definidos


Exemplo de requisição:

{
  "tipoPagamentoId": 3,
  "valor": 10.5,
  "parcelas": 1,
  "clienteId": 17194,
  "cartaoId": 123456
}

Requisição POST como 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": {
    "tipo_pedido_id": 1,
    "status_pedido_id": "1",
    "splitted": false,
    "taxed": false,
    "id": 18731,
    "cliente_id": 17194,
    "modified": "2020-02-04T21:56:20.225Z",
    "created": "2020-02-04T21:56:20.225Z",
    "cartaoId": 123456
  }
}

Parametros

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
parcelas Quantidade de parcelas da compra no cartão
clienteId Identificador do cliente já cadastrado
cartaoId Identificador do cartão já cadastrado

Estornar venda via cartão de crédito


Exemplo de requisição:

{ }

Requisição POST como 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."
}

Parametros

Id Tipo Descrição
PedidoId Identificação do pedido já criado

Nova venda via boleto


Exemplo de requisição:

{
  "tipoPagamentoId": 1,
  "valor": 5.00,
  "dataVencimento": "2019-12-09",
  "descricao": "teste de pagamento",
  "cliente": {
    "nome": "João Paulo",
    "cpf": "00000000000",
    "dataNascimento": "2001-06-14",
    "email": "teste2@zsystems.com.br",
    "celular": "00999998888"
  },
  "endereco": {
    "logradouro": "Rua Bartolomeu Sabino de Melo",
    "numero": "124",
    "cep": "03380-200",
    "cidade": "São Paulo",
    "estado": "SP",
    "complemento": ""
  }
}
                

Requisição POST como 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": {
    "tipo_pedido_id": 1,
    "status_pedido_id": "1",
    "splitted": false,
    "id": 2416,
    "usuario_id": 107,
    "cliente_id": 1568,
    "estabelecimento_id": 131,
    "modified": "2019-12-04T16:43:47.812Z",
    "created": "2019-12-04T16:43:47.812Z",
    "urlBoleto": "https://api-boletoproduction.s3.amazona
    ws.com/e16ddd5d975edfbdd1ecad06868f34e4/e16ddd5d975ed
    fbdd1ecad06868f34e4/e16ddd5d975edfbdd1ecad0.html"
  }
}
                

Parametros

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
dataVencimento Data que o boleto irá vencer
descricao Descição da transação
nome Nome do cliente
cpf CPF do cliente
dataNascimento Data de nascimento do cliente
email 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

Nova venda via boleto com cliente já definido


Exemplo de requisição:

{
  "tipoPagamentoId": 1,
  "valor": 5.00,
  "dataVencimento": "2019-12-09",
  "descricao": "teste de pagamento",
  "clienteId":1568
}
                

Requisição POST como 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": {
    "tipo_pedido_id": 1,
    "status_pedido_id": "1",
    "splitted": false,
    "id": 2416,
    "usuario_id": 107,
    "cliente_id": 1568,
    "estabelecimento_id": 131,
    "modified": "2019-12-04T16:43:47.812Z",
    "created": "2019-12-04T16:43:47.812Z",
    "urlBoleto": "https://api-boletoproduction.s3.amazona
    ws.com/e16ddd5d975edfbdd1ecad06868f34e4/e16ddd5d975ed
    fbdd1ecad06868f34e4/e16ddd5d975edfbdd1ecad0.html"
  }
}
                

Parametros

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
dataVencimento Data que o boleto irá vencer
descricao Descição da transação
clienteId Identificador do cliente já cadastrado

Nova pré captura via cartão de credito


Exemplo de requisição:

{
 "valor":1.00,
 "cartaoId": 1234,
 "clienteId":17188
}

Requisição POST como 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"
        }
      }
    ]
  }
}

Parametros

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

Executar venda da pré captura via cartão de credito


Exemplo de requisição:

{
  "pedidoId": 20212
}

Requisição POST como 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": []
  }
}

Parametros

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 como objetos JSON para o seguinte URL:
https://api.zsystems.com.br/vendas/{pedidoId}
header: ContentType application/json
authorization Bearer 'Token API'



Exemplo de resultado :

{
  "success": true,
  "message": "Venda",
  "venda": {
    "id": 2416,
    "created": "2019-12-04T16:43:47.000Z",
    "tipoPagamento": {
      "id": 1,
      "titulo": "Boleto",
      "cartaoCredito": null,
      "boleto": {
        "id": 25,
        "url": "https://api-boletoproduction.s3.amazonaw
        s.com/e1d5d0ce1f3946b68afab278f6b392b4/68a049190
        bb04d97aee3ae7ea3aceb2e/5de7e24455065a15068f3a1d
        .html"
      }
    },
    "valores": {
      "total": 5,
      "taxa": 0,
      "splits": 0,
      "liquido": 5
    },
    "status": {
      "id": 1,
      "titulo": "Pendente"
    },
    "cliente": {
      "nome": "João Paulo",
      "email": "teste2@zsystems.com.br",
      "clientes_documentos": [
        {
          "documento": "00000000000"
        }
      ]
    },
    "estabelecimento": {
      "id": 131,
      "nome_fantasia": "Integração Z-Systems",
      "razao_social": "",
      "arquivo": {
        "url": "https://z-systemsbucket.s3.amazonaws.
        com/files/estabelecimentos/logos/157445112.jpg"
      }
    },
    "produtos": [
      {
        "valorUnitario": "5.00",
        "quantidade": 1,
        "nome": "Venda Via API"
      }
    ],
    "pagamentos": [
      {
        "id": 1976,
        "valor": "5.00",
        "taxa": "0.00",
        "valorRecebido": "5.00",
        "tipoPagamento": {
          "id": 1,
          "titulo": "Boleto"
        },
        "statusPagamento": {
          "id": 1,
          "titulo": "Pendente"
        },
        "dataRecebimento": "2019-12-09T00:00:00.000Z",
        "parcela": 1,
        "pagamentoCartao": null,
        "pagamentoBoleto": {
          "id": 25,
          "url": "https://api-boletoproduction.s3.amazonaws
          .com/e1d5d0ce1f3946b68afab278f6b392b4/68a049190bb
          04d97aee3ae7ea3aceb2e/5de7e24455065a15068f3a1d.html"
        }
      }
    ],
    "pedidosFilhos": [],
    "splitParcela": "0.00"
  }
}

Parametros

Id Tipo Descrição
PedidoId Identificação do pedido já criado
 

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": "Plano Anual",
  "description": "Plano com cobrança recorrente anualmente",
  "setup_amount": 25,
  "amount": 125,
  "grace_period": 0,
  "tolerance_period": 0,
  "frequency": "monthly",
  "zoop_plano_id": null,
  "interval": 1,
  "logo": true
  "currency": "BRL",
  "payment_methods": "credito",
  "plan_expiration_date": "2022-09-30T03:00:00.000Z",
  "has_expiration": true,
  "expire_subscriptions": true,
  "subscription_duration": "12"
}
                

Requisição POST como 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":42
}

Parametros

Id Tipo Descrição
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']
zoop_plano_id Código de identificação do plano zoop
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 como 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",
  "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 como 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 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
  }
}

Parametros

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 como 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
  }
}

Parametros

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 como 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":42
}

Parametros

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 como objetos JSON para o seguinte URL:
http://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": 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
}

Parametros

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 como 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"
  }
}

Parametros

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
email 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 como objetos JSON para o seguinte URL:
http://api-homologacao.zsystems.com.br/planos/assinaturas
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,
          "zoop_seller_id": "476cf826cf1d43d2a48c35307e6cb4c6",
          "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,
          "zoop_seller_id": "476cf826cf1d43d2a48c35307e6cb4c6",
          "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,
          "zoop_seller_id": "476cf826cf1d43d2a48c35307e6cb4c6",
          "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
}
    

Parametros

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 como 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": 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
        }
      ]
    }
  }
}

Parametros

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 como 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
      }
    }
  }
}

Parametros

Id Tipo Descrição
AssinaturaId Identificação da assinatura já cadastrada
due_date Data da próxima recorrência

Suspender uma assinatura


Exemplo de requisição:

{
  "assinatura_id": 90
}

Requisição POST como 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"
}

Parametros

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 como 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"
}

Parametros

Id Tipo Descrição
assinatura_id Identificação da assinatura já cadastrada

Remover uma assinatura


Exemplo de requisição:

{}

Requisição DELETE como 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"
}

Parametros

Id Tipo Descrição
PlanoId Identificação da assinatura já cadastrada

Recuperar pagamentos de uma assinatura


Exemplo de requisição:

{}

Requisição GET como objetos JSON para o seguinte URL:
https://api.zsystems.com.br/planos/assinatura/{PlanoId}/faturas
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",
  "faturas": [
    {
      "id": 842,
      "assinatura_id": 86,
      "pedido_id": 136,
      "expiration_date": null,
      "amount": "1",
      "currency": "BRL",
      "paid_at": "2019-11-25T03:13:17.000Z",
      "date_invoice": "2019-11-25",
      "voided_at": "2019-11-26T15:14:44.000Z",
      "retries": 0,
      "max_retries": 3,
      "status": "void",
      "created": "2019-11-26T14:26:45.000Z",
      "modified": "2019-11-26T15:15:11.000Z",
      "removed": null
    },
    {
      "id": 841,
      "assinatura_id": 86,
      "pedido_id": 135,
      "expiration_date": null,
      "amount": "1",
      "currency": "BRL",
      "paid_at": "2019-11-24T03:13:34.000Z",
      "date_invoice": "2019-11-24",
      "voided_at": null,
      "retries": 0,
      "max_retries": 3,
      "status": "paid",
      "created": "2019-11-26T14:26:42.000Z",
      "modified": "2019-11-26T14:26:42.000Z",
      "removed": null
    },
    {
      "id": 839,
      "assinatura_id": 86,
      "pedido_id": 133,
      "expiration_date": null,
      "amount": "1",
      "currency": "BRL",
      "paid_at": "2019-11-22T03:13:30.000Z",
      "date_invoice": "2019-11-22",
      "voided_at": null,
      "retries": 3,
      "max_retries": 3,
      "status": "failed",
      "created": "2019-11-26T14:26:35.000Z",
      "modified": "2019-11-26T14:26:35.000Z",
      "removed": null
    },
    {
      "id": 838,
      "assinatura_id": 86,
      "pedido_id": 132,
      "expiration_date": null,
      "amount": "1",
      "currency": "BRL",
      "paid_at": "2019-11-21T03:18:33.000Z",
      "date_invoice": "2019-11-21",
      "voided_at": null,
      "retries": 0,
      "max_retries": 3,
      "status": "paid",
      "created": "2019-11-26T14:26:30.000Z",
      "modified": "2019-11-26T14:26:30.000Z",
      "removed": null
    },
    {
      "id": 836,
      "assinatura_id": 86,
      "pedido_id": 130,
      "expiration_date": null,
      "amount": "1",
      "currency": "BRL",
      "paid_at": "2019-11-19T03:13:25.000Z",
      "date_invoice": "2019-11-19",
      "voided_at": null,
      "retries": 0,
      "max_retries": 3,
      "status": "paid",
      "created": "2019-11-26T14:26:23.000Z",
      "modified": "2019-11-26T14:26:23.000Z",
      "removed": null
    }
  ]
}

Parametros

Id Tipo Descrição
PlanoId Identificação da assinatura já cadastrada

Estornar uma fatura


Exemplo de requisição:

{
  "id": 841
}

Requisição POST como objetos JSON para o seguinte URL:
https://api.zsystems.com.br/planos/assinatura/{PlanoId}/faturas
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",
}

Parametros

Id Tipo Descrição
id Identificação da fatura para estorno
 

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 como objetos JSON 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
    }
  ]
}
                

Parametros

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.



Parametros 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

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
  }
}
                

Parametros

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
  }
}
                

Parametros

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"
  }
}
                

Parametros

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
}
                

Parametros

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
email É 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
}
                

Parametros

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
email É 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
}
                

Parametros

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
email É 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
}
                

Parametros

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
email É 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
}
                

Parametros

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
email É 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
}
                

Parametros

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
}
                

Parametros

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
}
                

Parametros

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
}
                

Parametros

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
}
                

Parametros

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
}
                

Parametros

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
}
                

Parametros

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
}

                

Parametros

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
}
                

Parametros

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
}
                

Parametros

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
}
                

Parametros

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
}
                

Parametros

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
}

                

Parametros

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
}

                

Parametros

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.