Introdução
API Endpoint
https://apidash.1pay.com.br/
Sandbox Endpoint
https://devapi.1pay.com.br/
A API OnePay 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 OnePay fornece uma interface para os aplicativos interagirem com a plataforma, enviando e recebendo dados como objetos JSON (JavaScript Object Notation)
Para usar a API REST da Onepay, você precisa de um Token API. Entre em contato com ti.adm@1pay.com.br para solicitar seu Token API.
A seguir, disponibilizamos uma Collection com todas as chamadas presentes nessa documentação. Link para as chamadas de API.
Para poder abrir a Collection, será necessário utilizar a ferramenta Postman. Para realizar o download da ferramenta Postman, clique aqui.
Estabelecimentos
Os estabelecimentos representam pessoas ou empresas dentro do seu marketplace. Normalmente, os estabelecimentos oferecem uma variedade de mercadorias novas, usadas, remodeladas e colecionáveis on-line (cartão não presente) ou em lojas (cartão-presente). Você pode vincular seus cartões de crédito, cartões de débito, vouchers, contas bancárias e fazer transferências, transações (ou seja, débitos), reembolsos e muito mais...
Criar estabelecimento para pessoa física
Exemplo de requisição:
{
"tipoEstabelecimentoId": 1,
"nome":"João Paulo2",
"email":"teste2@1pay.com.br",
"celular":"00999998888",
"dataNascimento":"1993-12-16",
"cpf":"00000000000",
"categoria": "5",
"nomeComprovante":"Nome fantasia",
"endereco":{
"logradouro":"Rua Souza Lima",
"numero":"124",
"cep":"03380-200",
"cidade":"São Paulo",
"estado":"SP",
"complemento":""
},
"contaBancaria":{
"bancoId": "xx",
"agencia": "0001",
"conta": "5555",
"nomeTitular": "João Paulo2",
"tipoContaBancaria": "1"
},
"identificadorPlano": "standard"
}
Requisição POST para o seguinte URL como objetos JSON:
https://apidash.1pay.com.br/estabelecimentos/pre-cadastrar
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"estabelecimento":{
"id":304,
"tipo_estabelecimento_id":1,
"status_estabelecimento_id":1,
"categoria_estabelecimento_id":1,
"endereco_id":710,
"razao_social":"",
"nome_fantasia":"João Paulo2",
"ativo":0,
"data_nascimento":"1993-12-16T00:00:00.000Z",
"created":"2020-02-07T22:22:29.000Z",
"modified":"2020-02-07T22:22:29.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":710,
"logradouro":"Rua Souza Lima",
"numero":"124",
"complemento":"",
"cep":"03380200",
"cidade":"São Paulo",
"uf":"SP",
"lat":null,
"long":null,
"created":"2020-02-07T22:22:29.000Z",
"modified":"2020-02-07T22:22:29.000Z",
"removed":null
}
}
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| tipoEstabelecimentoID* | 1 | 2 | 1 = Pessoa fisica 2 = Pessoa Jurídica |
| nome* | string | Nome da pessoa física |
| email* | string | Email da pessoa física |
| celular* | string | Número de celular da pessoa física |
| dataNascimento* | string | Data de nascimento da pessoa física |
| cpf* | string | CPF da pessoa física |
| endereco.cep* | string | CEP do ponto de venda |
| endereco.numero* | string | Número do ponto de venda |
| endereco.logradouro* | string | Logradouro do ponto de venda |
| endereco.cidade* | string | Cidade do ponto de venda |
| endereco.estado* | string | Estado do ponto de venda |
| endereco.complemento | string | Complemento do ponto de venda |
| endereco.bairro | string | Bairro do ponto de venda |
| nomeComprovante | string | Nome do comprovante de endereço |
| categoria* | string | Categoria do estabelecimento |
| identificadorPlano* | string | Identificador do plano |
| qtdPOS | string | Quantidade de POS |
| faturamentoEstimado | string | Faturamento estimado |
| observacao | string | Observação sobre o estabelecimento |
| enderecoPOS.cep | string | CEP do ponto de venda |
| enderecoPOS.numero | string | Número do ponto de venda |
| enderecoPOS.logradouro | string | Logradouro do ponto de venda |
| enderecoPOS.cidade | string | Cidade do ponto de venda |
| enderecoPOS.estado | string | Estado do ponto de venda |
| enderecoPOS.complemento | string | Complemento do ponto de venda |
| enderecoPOS.bairro | string | Bairro do ponto de venda |
| contaBancaria.tipoContaBancaria* | "1" | "2" | "1" = Conta Corrente "2" = Conta Poupança |
| contaBancaria.nomeTitular* | string | Nome do titular da conta bancária |
| contaBancaria.bancoId* | string | ID do banco |
| contaBancaria.agencia* | string | Agência bancária |
| contaBancaria.conta* | string | Número da conta bancária |
| documentos* | File[] | Array de arquivos com documentos pessoais |
| documentosAtividades* | File[] | Array de arquivos com documentos que comprovam atividade |
| documentosResidencia* | File[] | Array de arquivos com documentos que comprovam residência |
| outrosDocumentos* | File[] | Array de arquivos com outros documentos |
Criar estabelecimento para pessoa jurídica
Exemplo de requisição:
{
"tipoEstabelecimentoId": "2",
"razaoSocial": "Teste LTDA",
"nomeFantasia": "Teste Empresa Fake",
"cnpj": "00000000000000",
"telefone": "00999998888"
"email": "teste@1pay.com.br",
"celular": "00999997777",
"endereco": {
"logradouro": "Rua pereira santos",
"numero": "421",
"cidade": "São Paulo",
"estado": "SP",
"cep": "03380000",
"complemento": ""
},
"nomeComprovante": "Empresa Teste",
"categoria": "27",
"proprietario": {
"nome": "Pedro Soua Paulo",
"email": "proprietario@gmail.com",
"celular": "(00) 99999-8888",
"dataNascimento": "25/02/1990",
"cpf": "000.000.000-00",
"endereco": {
"logradouro": "Rua pereira santos",
"numero": "124",
"cidade": "São Paulo",
"estado": "SP",
"cep": "03380000",
"complemento": ""
}
},
"contaBancaria":{
"bancoId": "55",
"agencia": "0001",
"conta": "5555",
"nomeTitular": "Pedro Soua Paulo",
"tipoContaBancaria": "1"
},
}
Requisição POST para o seguinte URL como objetos JSON:
https://apidash.1pay.com.br/estabelecimentos/pre-cadastrar
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"estabelecimento": {
"id": 306,
"tipo_estabelecimento_id": 2,
"status_estabelecimento_id": 1,
"categoria_estabelecimento_id": 1,
"endereco_id": 718,
"razao_social": " Teste LTDA",
"nome_fantasia": "Teste Empresa Fake",
"ativo": 0,
"data_nascimento": null,
"created": "2020-02-07T22:52:54.000Z",
"modified": "2020-02-07T22:52:54.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": 718,
"logradouro": "Rua pereira santos",
"numero": "421",
"complemento": "",
"cep": "03380000",
"cidade": "São Paulo",
"uf": "SP",
"lat": null,
"long": null,
"created": "2020-02-07T22:52:54.000Z",
"modified": "2020-02-07T22:52:54.000Z",
"removed": null
}
}
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| tipoEstabelecimentoId* | 1 | 2 | ID do tipo de estabelecimento |
| razaoSocial* | string | Razao Social da pessoa jurídica |
| nomeFantasia* | string | nome Fantasia da pessoa jurídica |
| email* | string | Email da pessoa jurídica |
| celular* | string | Número de celular da pessoa jurídica |
| telefone* | string | Número de telefone da pessoa jurídica |
| cnpj* | string | CNPJ da pessoa jurídica |
| proprietario.nome* | string | Nome do proprietario |
| proprietario.email* | string | Email do proprietario |
| proprietario.celular* | string | Número de celular do proprietario |
| proprietario.dataNascimento* | string | Data de nascimento do proprietario |
| proprietario.cpf* | string | CPF do proprietario |
| proprietario.endereco.cep* | string | CEP do proprietario |
| proprietario.endereco.numero* | string | Número do proprietario |
| proprietario.endereco.logradouro* | string | Logradouro do proprietario |
| proprietario.endereco.cidade* | string | Cidade do proprietario |
| proprietario.endereco.estado* | string | Estado do proprietario |
| proprietario.endereco.complemento | string | Complemento do proprietario |
| proprietario.endereco.bairro | string | Bairro do proprietario |
| endereco.cep* | string | CEP do ponto de venda |
| endereco.numero* | string | Número do ponto de venda |
| endereco.logradouro* | string | Logradouro do ponto de venda |
| endereco.cidade* | string | Cidade do ponto de venda |
| endereco.estado* | string | Estado do ponto de venda |
| endereco.complemento | string | Complemento do ponto de venda |
| endereco.bairro | string | Bairro do ponto de venda |
| nomeComprovante | string | Nome do comprovante de endereço |
| categoria* | string | Categoria do estabelecimento |
| identificadorPlano* | string | Identificador do plano |
| qtdPOS | string | Quantidade de POS |
| faturamentoEstimado | string | Faturamento estimado |
| observacao | string | Observação sobre o estabelecimento |
| enderecoPOS.cep | string | CEP do ponto de venda |
| enderecoPOS.numero | string | Número do ponto de venda |
| enderecoPOS.logradouro | string | Logradouro do ponto de venda |
| enderecoPOS.cidade | string | Cidade do ponto de venda |
| enderecoPOS.estado | string | Estado do ponto de venda |
| enderecoPOS.complemento | string | Complemento do ponto de venda |
| enderecoPOS.bairro | string | Bairro do ponto de venda |
| contaBancaria.tipoContaBancaria* | "1" | "2" | "1" = Conta Corrente "2" = Conta Poupança |
| contaBancaria.nomeTitular* | string | Nome do titular da conta bancária |
| contaBancaria.bancoId* | string | ID do banco |
| contaBancaria.agencia* | string | Agência bancária |
| contaBancaria.conta* | string | Número da conta bancária |
| documentos* | File[] | Array de arquivos com documentos pessoais |
| documentosAtividades* | File[] | Array de arquivos com documentos que comprovam atividade |
| documentosResidencia* | File[] | Array de arquivos com documentos que comprovam residência |
| documentosProprietario* | File[] | Array de arquivos com documentos do proprietário |
| outrosDocumentos* | File[] | Array de arquivos com outros documentos |
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://apidash.1pay.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 | int | Número de páginas |
| limit | int | Define a quantidade de estabelecimentos a serem exibidos por página |
| omni | string | Campo utilizado como ferramenta de pesquisa |
| parentId | int | Identifica a qual estabelecimento está vinculado |
Consultar Token
Exemplo de requisição:
{ }
Requisição GET para o seguinte URL como objetos JSON:
https://apidash.1pay.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 | int | Código de identificação do estabelecimento |
Consultar Saldo
Exemplo de requisição:
{ }
Requisição GET para o seguinte URL como objetos JSON:
https://apidash.1pay.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 | int | 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://apidash.1pay.com.br/estabelecimentos/por_documento/{documento}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"estabelecimento": {
"id": 12696,
"tipo_estabelecimento_id": 1,
"status_estabelecimento_id": 1,
"logo_id": null,
"nome_fantasia": "Teste doc",
"razao_social": "",
"ativo": 0,
"arquivo": null,
"tipo_estabelecimento": {
"id": 1,
"titulo": "Pessoa Física"
},
"estabelecimentos_contatos": [
{
"id": 32804,
"tipo_contato_id": 3,
"contato": "ks.bonini@gmail.com"
}
],
"estabelecimentos_documentos": [
{
"id": 56413,
"tipo_documento_id": 2,
"documento": "35856667875"
}
],
"status_estabelecimento": {
"id": 1,
"titulo": "Aguardando Aprovação"
}
}
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| id_documento | int | 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://apidash.1pay.com.br/estabelecimentos/{idEstabelecimento}/habilitar
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| idEstabelecimento | int | Código de identificação do estabelecimento |
Desabilitar estabelecimento
Exemplo de requisição:
{ }
Requisição DELETE para o seguinte URL como objetos JSON:
https://apidash.1pay.com.br/estabelecimentos/{idEstabelecimento}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| idEstabelecimento | int | 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 OnePay 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.
Banco ID
Valores predefinidos para o campo bancoId. Use o ID
| ID | Código - Nome do Banco | |
|---|---|---|
| 1 | 001 - Banco do Brasil S.A. | |
| 2 | 003 - Banco da Amazônia S.A. | |
| 3 | 004 - Banco do Nordeste do Brasil S.A. | |
| 4 | 012 - Banco Standard de Investimentos S.A. | |
| 5 | 021 - BANESTES S.A. Banco do Estado do Espírito Santo | |
| 6 | 024 - Banco BANDEPE S.A. | |
| 7 | 025 - Banco Alfa S.A. | |
| 8 | 029 - Banco Banerj S.A. | |
| 9 | 031 - Banco Beg S.A. | |
| 10 | 033 - Banco Santander (Brasil) S.A. | |
| 11 | 037 - Banco do Estado do Pará S.A. | |
| 12 | 040 - Banco Cargill S.A. | |
| 13 | 041 - Banco do Estado do Rio Grande do Sul S.A. | |
| 14 | 045 - Banco Opportunity S.A. | |
| 15 | 047 - Banco do Estado de Sergipe S.A. | |
| 16 | 062 - Hipercard Banco Múltiplo S.A. | |
| 17 | 063 - Banco Ibi S.A. Banco Múltiplo | |
| 18 | 064 - Goldman Sachs do Brasil Banco Múltiplo S.A. | |
| 19 | 065 - Banco AndBank (Brasil) S.A. | |
| 20 | 069 - BPN Brasil Banco Múltiplo S.A. | |
| 21 | 070 - BRB - Banco de Brasília S.A. | |
| 22 | 073 - BB Banco Popular do Brasil S.A. | |
| 23 | 074 - Banco J. Safra S.A. | |
| 24 | 075 - Banco ABN AMRO S.A. | |
| 25 | 077 - Banco Inter | |
| 26 | 078 - BES Investimento do Brasil S.A.-Banco de Investimento | |
| 27 | 090 - UNICRED MUTUO | |
| 28 | 095 - Banco Confidence de Câmbio S.A. | |
| 29 | 096 - Banco BM&FBOVESPA de Serviços de Liquidação e Custódia S.A | |
| 30 | 104 - Caixa Econômica Federal | |
| 31 | 107 - Banco BBM S.A. | |
| 32 | 109 - Banco Zoop | |
| 33 | 119 - Banco Western Union do Brasil S.A. | |
| 34 | 125 - Brasil Plural S.A. - Banco Múltiplo | |
| 35 | 136 - UNICRED | |
| 36 | 208 - Banco BTG Pactual S.A. | |
| 37 | 212 - Banco Original S.A. | |
| 38 | 214 - Banco Dibens S.A. | |
| 39 | 215 - Banco Comercial e de Investimento Sudameris S.A. | |
| 40 | 217 - Banco John Deere S.A. | |
| 41 | 218 - Banco Bonsucesso S.A. | |
| 42 | 222 - Banco Credit Agricole Brasil S.A. | |
| 43 | 224 - Banco Fibra S.A. | |
| 44 | 233 - Banco Cifra S.A. | |
| 45 | 237 - Banco Bradesco S.A. | |
| 46 | 248 - Banco Boavista Interatlântico S.A. | |
| 47 | 249 - Banco Investcred Unibanco S.A. | |
| 48 | 250 - BCV - Banco de Crédito e Varejo S.A. | |
| 49 | 254 - Paraná Banco S.A. | |
| 50 | 260 - Nu Bank | |
| 51 | 263 - Banco Cacique S.A. | |
| 52 | 265 - Banco Fator S.A. | |
| 53 | 318 - Banco BMG S.A. | |
| 54 | 320 - Banco Industrial e Comercial S.A. | |
| 55 | 341 - Itaú Unibanco S.A. | |
| 56 | 356 - Banco Real S.A. | |
| 57 | 366 - Banco Société Générale Brasil S.A. | |
| 58 | 370 - Banco Mizuho do Brasil S.A. | |
| 59 | 376 - Banco J. P. Morgan S.A. | |
| 60 | 389 - Banco Mercantil do Brasil S.A. | |
| 61 | 399 - HSBC Bank Brasil S.A. - Banco Múltiplo | |
| 62 | 409 - UNIBANCO - União de Bancos Brasileiros S.A. | |
| 63 | 422 - Banco Safra S.A. | |
| 64 | 456 - Banco de Tokyo-Mitsubishi UFJ Brasil S.A. | |
| 65 | 464 - Banco Sumitomo Mitsui Brasileiro S.A. | |
| 66 | 477 - Citibank S.A. | |
| 67 | 487 - Deutsche Bank S.A. - Banco Alemão | |
| 68 | 488 - JPMorgan Chase Bank | |
| 69 | 492 - ING Bank N.V. | |
| 70 | 505 - Banco Credit Suisse (Brasil) S.A. | |
| 71 | 600 - Banco Luso Brasileiro S.A. | |
| 72 | 604 - Banco Industrial do Brasil S.A. | |
| 73 | 610 - Banco VR S.A. | |
| 74 | 611 - Banco Paulista S.A. | |
| 75 | 612 - Banco Guanabara S.A. | |
| 76 | 623 - Banco PAN S.A. | |
| 77 | 626 - Banco Ficsa S.A. | |
| 78 | 633 - Banco Rendimento S.A. | |
| 79 | 634 - Banco Triângulo S.A. | |
| 80 | 641 - Banco Alvorada S.A. | |
| 81 | 643 - Banco Pine S.A. | |
| 82 | 653 - Banco Indusval S.A. | |
| 83 | 655 - Banco Votorantim S.A. | |
| 84 | 707 - Banco Daycoval S.A. | |
| 85 | 719 - Banif-Banco Internacional do Funchal (Brasil)S.A. | |
| 86 | 739 - Banco Cetelem S.A. | |
| 87 | 740 - Banco Barclays S.A. | |
| 88 | 745 - Banco Citibank S.A. | |
| 89 | 746 - Banco Modal S.A. | |
| 90 | 747 - Banco Rabobank International Brasil S.A. | |
| 91 | 748 - Banco Cooperativo Sicredi S.A. | |
| 92 | 751 - Scotiabank Brasil S.A. Banco Múltiplo | |
| 93 | 752 - Banco BNP Paribas Brasil S.A. | |
| 94 | 755 - Bank of America Merrill Lynch Banco Múltiplo S.A. | |
| 95 | 756 - Banco Cooperativo do Brasil S.A. - BANCOOB | |
| 96 | 779 - Banco Intermedium S.A. | |
| 97 | 336 - Banco C6 Bank | |
| 98 | 290 - Pagseguro Internet S.A | |
| 99 | 144 - BEXS BANCO DE CAMBIO S.A. | |
| 100 | 085 - COOP CENTRAL AILOS | |
| 101 | 735 - Banco Pottencial S.A. | |
| 102 | 084 - CC UNIPRIME NORTE DO PARANA | |
| 103 | 237 - Banco Next | |
| 104 | 197 - Stone Pagamentos | |
| 105 | 323 - Mercado Pago | |
| 106 | 036 - Banco Bradesco BBI S.A. | |
| 107 | 630 - Banco Intercap | |
| 108 | 133 - Banco Cresol | |
| 109 | 184 - Banco Itaú BBA S.A. | |
| 110 | 273 - Ccr De São Miguel Do Oeste | |
| 111 | 10001 - Zoop BPP - Brasil Pré Pago | |
| 112 | 280 - Banco AVISTA S.A CFI | |
| 113 | 332 - Acesso Soluções de Pagamento S.A. | |
| 114 | 403 - CORA SCD S.A. | |
| 115 | 121 - BANCO AGIBANK S.A. | |
| 116 | 159 - CASA CREDITO S.A | |
| 118 | 014 - Natixis Brasil S.A. Banco Múltiplo | |
| 119 | 018 - Banco Tricury S.A. | |
| 120 | 019 - Banco Azteca do Brasil S.A. | |
| 121 | 039 - Banco do Estado do Piauí S.A. - BEP | |
| 122 | 044 - Banco BVA S.A. | |
| 123 | 066 - Banco Morgan Stanley S.A. | |
| 124 | 072 - Banco Rural Mais S.A. | |
| 125 | 076 - Banco KDB S.A. | |
| 126 | 079 - Banco Original do Agronegócio S.A. | |
| 127 | 081 - Concórdia Banco S.A. | |
| 128 | 082 - Banco Topázio S.A. | |
| 129 | 083 - Banco da China Brasil S.A. | |
| 130 | 086 - OBOE Crédito Financiamento e Investimento S.A. | |
| 131 | 087 - Cooperativa Unicred Central Santa Catarina | |
| 132 | 088 - Banco Randon S.A. | |
| 133 | 089 - Cooperativa de Crédito Rural da Região de Mogiana | |
| 134 | 091 - Unicred Central do Rio Grande do Sul | |
| 135 | 092 - Brickell S.A. Crédito, financiamento e Investimento | |
| 136 | 093 - Pólocred SCM | |
| 137 | 093 - PÓLOCRED SCMEPP LTDA | |
| 138 | 094 - Banco Petra S.A. | |
| 139 | 097 - Cooperativa Central de Crédito Noroeste Brasileiro Ltda. | |
| 140 | 098 - CREDIALIANÇA COOPERATIVA DE CRÉDITO RURAL | |
| 141 | 099 - Cooperativa Central de Economia e Credito Mutuo das Unicreds | |
| 142 | 10003 - SmartMEI BPP | |
| 143 | 10004 - HUB CARD S.A | |
| 144 | 10005 - CDT | |
| 145 | 10006 - Dock | |
| 146 | 114 - Central das Coop. de Economia e Crédito Mutuo do Est. do ES | |
| 147 | 122 - Banco BERJ S.A. | |
| 148 | 130 - Caruana SCFI | |
| 149 | 168 - HSBC Finance (Brasil) S.A. - Banco Múltiplo | |
| 150 | 172 - Albatross Corretora | |
| 151 | 191 - Nova Futura CTVM LTDA | |
| 152 | 204 - Banco Bradesco Cartões S.A. | |
| 153 | 213 - Banco Arbi S.A. | |
| 154 | 2246 - Zoop Instituição de Pagamentos | |
| 155 | 225 - Banco Brascan S.A. | |
| 156 | 229 - Banco Cruzeiro do Sul S.A. | |
| 157 | 230 - Unicard Banco Múltiplo S.A. | |
| 158 | 241 - Banco Clássico S.A. | |
| 159 | 243 - Banco Máxima S.A. | |
| 160 | 246 - Banco ABC Brasil S.A. | |
| 161 | 266 - Banco Cédula S.A. | |
| 162 | 274 - MONEY PLUS SOCIEDADE DE CRÉDITO AO MICROEMPREENDEDOR E A EMPRESA DE PEQUENO PORTE | |
| 163 | 300 - Banco de La Nacion Argentina | |
| 164 | 301 - BPP Instituição de Pagamento | |
| 165 | 301 - BPP Instituição de Pagamento S.A. | |
| 166 | 329 - QI Sociedade de Crédito Direto S.A. | |
| 167 | 335 - Banco Digio S.A. | |
| 168 | 348 - Banco XP S.A. | |
| 169 | 363 - SOCOPA SC PAULISTA S.A. | |
| 170 | 364 - GERENCIANET PAGTOS BRASIL LTDA | |
| 171 | 382 - FIDÚCIA SOCIEDADE DE CRÉDITO AO MICROEMPREENDEDOR E À EMPRESA DE PEQUENO PORTE L | |
| 172 | 383 - JUNO | |
| 173 | 394 - Banco Bradesco Financiamentos S.A. | |
| 174 | 394 - Banco Finasa BMC S.A. | |
| 175 | 396 - HUB PAGAMENTOS S.A. | |
| 176 | 412 - Banco Capital S.A. | |
| 177 | 453 - Banco Rural S.A. | |
| 178 | 473 - Banco Caixa Geral - Brasil S.A. | |
| 179 | 479 - Banco ItaúBank S.A | |
| 180 | 494 - Banco de La Republica Oriental del Uruguay | |
| 181 | 495 - Banco de La Provincia de Buenos Aires | |
| 182 | 613 - Banco Pecúnia S.A. | |
| 183 | 637 - Banco Sofisa S.A. | |
| 184 | 638 - Banco Prosper S.A. | |
| 185 | 652 - Itaú Unibanco Holding S.A. | |
| 186 | 654 - Banco A.J.Renner S.A. | |
| 187 | 712 - Banco Ourinvest S.A. | |
| 188 | 721 - Banco Credibel S.A. | |
| 189 | 724 - Banco Porto Seguro S.A. | |
| 190 | 734 - Banco Gerdau S.A. | |
| 191 | 738 - Banco Morada S.A. | |
| 192 | 741 - Banco Ribeirão Preto S.A. | |
| 193 | 743 - Banco Semear S.A. | |
| 194 | 744 - BankBoston N.A. | |
| 195 | 749 - Banco Simples S.A. | |
| 196 | 753 - NBC Bank Brasil S.A. - Banco Múltiplo | |
| 197 | 757 - Banco KEB do Brasil S.A. | |
| 198 | 999 - ZPT International Bank | |
| 199 | 9991 - Conductor FlexAssists | |
| 200 | 9992 - Conductor Alpha Card | |
| 201 | 380 - PICPAY INSTITUIÇÃO DE PAGAMENTO S.A. | |
| 202 | 324 - CARTOS SCD S.A | |
| 203 | 529 - PINBANK BRASIL INSTITUIÇÃO DE PAGAMENTO S.A. | |
| 204 | 461 - ASAAS GESTÃO FINANCEIRA INSTITUIÇÃO DE PAGAMENTO SA | |
| 205 | 536 - NEON PAGAMENTOS S.A. | |
| 207 | 542 - CLOUDWALK INSTITUIÇÃO DE PAGAMENTO E SERVICOS LTDS |
| Id | Tipo | Descrição |
|---|---|---|
| tipoContaBancaria | Int | 1 = Conta Corrente 2 = Poupança |
| nomeTitular | string | Nome do titular da conta |
| bancoId | int | Id predefinida do banco |
| agencia | string | Agência da conta bancária |
| conta | string | 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://apidash.1pay.com.br/estabelecimentos/contas_bancarias
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success":true,
"contasBancarias":[
{
"id":27,
"tipoContaBancaria":1,
"nomeTitular":"1pay Software de Gestão",
"agencia":"000",
"conta":"000000",
"banco":"Itaú Unibanco S.A.",
"ativo":true
},
{
"id":28,
"tipoContaBancaria":1,
"nomeTitular":"1pay Software de Gestão",
"agencia":"0000",
"conta":"000000000",
"banco":"Banco Santander (Brasil) S.A.",
"ativo":false
}
]
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| id_contas_bancarias | int | id da conta bancária |
Selecionar conta bancária
Exemplo de requisição:
{ }
Requisição PUT como objetos JSON para o seguinte URL:
https://apidash.1pay.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_contas_bancarias | int | id 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://apidash.1pay.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 | int | 1 = Conta Digital 2 = Conta Bancária |
| valor | float | 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 | int | Caso seja tipoTransferencia = 1 informe o id do estabelecimento para que seja realizada a transferência |
| contaBancariaId | int | Caso seja tipoTransferencia = 2 informe o id da contaBancaria para que seja realizada a transferência |
| senha | string | 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 | string | Descrever para que conste em seu extrato |
| agendadoPara | date-time | 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://apidash.1pay.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": "1pay 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 1pay",
"documento": "000000000000",
"email": "integracao@1pay.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": "1pay 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 1pay",
"documento": "00000000000",
"email": "integracao@1pay.com.br"
},
"to": {
"nome": null,
"documento": null,
"email": null
}
}
]
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| tipoTransferenciaId | int | 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://apidash.1pay.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 | int | Id da trasnferência que foi agendado anteriormente e que deseja deletar |
calculadora de Taxas
Nessa sessão vamos comentar um pouco sobre a Calculadora de taxas. A calculadora de taxa verifica e calcula todas as suas taxas , de maneira assertiva e rápida.
listar Taxas
Exemplo de Requisição
{}
Requisição GET como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/calculators/fees
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"taxaSplit": {
"amount": 0,
"percentage": 0
},
"taxaBoleto": 0,
"taxaTotal": {
"American Express": {
"credit": {
"1": 2.89,
"2": 3.29,
"3": 3.29,
"4": 3.29,
"5": 3.29,
"6": 3.29,
"7": 3.69,
"8": 3.69,
"9": 3.69,
"10": 3.69,
"11": 3.69,
"12": 3.69
}
},
"Aura": {
"credit": {
"1": 2.29,
"2": 2.89,
"3": 2.89,
"4": 2.89,
"5": 2.89,
"6": 2.89,
"7": 3.49,
"8": 3.49,
"9": 3.49,
"10": 3.49,
"11": 3.49,
"12": 3.49
},
"debit": {
"1": 1.29
}
},
"Banescard": {
"credit": {
"1": 2.29,
"2": 2.89,
"3": 2.89,
"4": 2.89,
"5": 2.89,
"6": 2.89,
"7": 3.49,
"8": 3.49,
"9": 3.49,
"10": 3.49,
"11": 3.49,
"12": 3.49
},
"debit": {
"1": 1.29
}
},
"Diners Club": {
"credit": {
"1": 2.29,
"2": 2.89,
"3": 2.89,
"4": 2.89,
"5": 2.89,
"6": 2.89,
"7": 3.49,
"8": 3.49,
"9": 3.49,
"10": 3.49,
"11": 3.49,
"12": 3.49
},
"debit": {
"1": 1.29
}
},
"Discover": {
"credit": {
"1": 2.29,
"2": 2.89,
"3": 2.89,
"4": 2.89,
"5": 2.89,
"6": 2.89,
"7": 3.49,
"8": 3.49,
"9": 3.49,
"10": 3.49,
"11": 3.49,
"12": 3.49
},
"debit": {
"1": 1.29
}
},
"Elo": {
"credit": {
"1": 2.89,
"2": 3.29,
"3": 3.29,
"4": 3.29,
"5": 3.29,
"6": 3.29,
"7": 3.69,
"8": 3.69,
"9": 3.69,
"10": 3.69,
"11": 3.69,
"12": 3.69
},
"debit": {
"1": 1.99
}
},
"Hipercard": {
"credit": {
"1": 2.89,
"2": 3.29,
"3": 3.29,
"4": 3.29,
"5": 3.29,
"6": 3.29,
"7": 3.69,
"8": 3.69,
"9": 3.69,
"10": 3.69,
"11": 3.69,
"12": 3.69
},
"debit": {
"1": 1.99
}
},
"Hiper": {
"credit": {
"1": 2.89,
"2": 3.29,
"3": 3.29,
"4": 3.29,
"5": 3.29,
"6": 3.29,
"7": 3.69,
"8": 3.69,
"9": 3.69,
"10": 3.69,
"11": 3.69,
"12": 3.69
},
"debit": {
"1": 1.99
}
},
"JCB": {
"credit": {
"1": 2.29,
"2": 2.89,
"3": 2.89,
"4": 2.89,
"5": 2.89,
"6": 2.89,
"7": 3.49,
"8": 3.49,
"9": 3.49,
"10": 3.49,
"11": 3.49,
"12": 3.49
},
"debit": {
"1": 1.29
}
},
"MasterCard": {
"credit": {
"1": 2.29,
"2": 2.89,
"3": 2.89,
"4": 2.89,
"5": 2.89,
"6": 2.89,
"7": 3.49,
"8": 3.49,
"9": 3.49,
"10": 3.49,
"11": 3.49,
"12": 3.49
},
"debit": {
"1": 1.29
}
},
"Visa": {
"credit": {
"1": 2.29,
"2": 2.89,
"3": 2.89,
"4": 2.89,
"5": 2.89,
"6": 2.89,
"7": 3.49,
"8": 3.49,
"9": 3.49,
"10": 3.49,
"11": 3.49,
"12": 3.49
},
"debit": {
"1": 1.29
}
},
"others": {
"boleto": {
"1": 2.9
}
}
}
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| id_calculators_fees | int | Codigo das suas Taxas |
Calcular Taxas
Exemplo de Requisição
{
"valor": 200
}
Requisição POST como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/calculators/valorFinal
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de Resultado
{
"success": true,
"valor": 200,
"valorFinal": {
"American Express": {
"credit": {
"1": 205.95,
"2": 206.8,
"3": 206.8,
"4": 206.8,
"5": 206.8,
"6": 206.8,
"7": 207.66,
"8": 207.66,
"9": 207.66,
"10": 207.66,
"11": 207.66,
"12": 207.66
}
},
"Aura": {
"credit": {
"1": 204.69,
"2": 205.95,
"3": 205.95,
"4": 205.95,
"5": 205.95,
"6": 205.95,
"7": 207.23,
"8": 207.23,
"9": 207.23,
"10": 207.23,
"11": 207.23,
"12": 207.23
},
"debit": {
"1": 202.61
}
},
"Banescard": {
"credit": {
"1": 204.69,
"2": 205.95,
"3": 205.95,
"4": 205.95,
"5": 205.95,
"6": 205.95,
"7": 207.23,
"8": 207.23,
"9": 207.23,
"10": 207.23,
"11": 207.23,
"12": 207.23
},
"debit": {
"1": 202.61
}
},
"Diners Club": {
"credit": {
"1": 204.69,
"2": 205.95,
"3": 205.95,
"4": 205.95,
"5": 205.95,
"6": 205.95,
"7": 207.23,
"8": 207.23,
"9": 207.23,
"10": 207.23,
"11": 207.23,
"12": 207.23
},
"debit": {
"1": 202.61
}
},
"Discover": {
"credit": {
"1": 204.69,
"2": 205.95,
"3": 205.95,
"4": 205.95,
"5": 205.95,
"6": 205.95,
"7": 207.23,
"8": 207.23,
"9": 207.23,
"10": 207.23,
"11": 207.23,
"12": 207.23
},
"debit": {
"1": 202.61
}
},
"Elo": {
"credit": {
"1": 205.95,
"2": 206.8,
"3": 206.8,
"4": 206.8,
"5": 206.8,
"6": 206.8,
"7": 207.66,
"8": 207.66,
"9": 207.66,
"10": 207.66,
"11": 207.66,
"12": 207.66
},
"debit": {
"1": 204.06
}
},
"Hipercard": {
"credit": {
"1": 205.95,
"2": 206.8,
"3": 206.8,
"4": 206.8,
"5": 206.8,
"6": 206.8,
"7": 207.66,
"8": 207.66,
"9": 207.66,
"10": 207.66,
"11": 207.66,
"12": 207.66
},
"debit": {
"1": 204.06
}
},
"Hiper": {
"credit": {
"1": 205.95,
"2": 206.8,
"3": 206.8,
"4": 206.8,
"5": 206.8,
"6": 206.8,
"7": 207.66,
"8": 207.66,
"9": 207.66,
"10": 207.66,
"11": 207.66,
"12": 207.66
},
"debit": {
"1": 204.06
}
},
"JCB": {
"credit": {
"1": 204.69,
"2": 205.95,
"3": 205.95,
"4": 205.95,
"5": 205.95,
"6": 205.95,
"7": 207.23,
"8": 207.23,
"9": 207.23,
"10": 207.23,
"11": 207.23,
"12": 207.23
},
"debit": {
"1": 202.61
}
},
"MasterCard": {
"credit": {
"1": 204.69,
"2": 205.95,
"3": 205.95,
"4": 205.95,
"5": 205.95,
"6": 205.95,
"7": 207.23,
"8": 207.23,
"9": 207.23,
"10": 207.23,
"11": 207.23,
"12": 207.23
},
"debit": {
"1": 202.61
}
},
"Visa": {
"credit": {
"1": 204.69,
"2": 205.95,
"3": 205.95,
"4": 205.95,
"5": 205.95,
"6": 205.95,
"7": 207.23,
"8": 207.23,
"9": 207.23,
"10": 207.23,
"11": 207.23,
"12": 207.23
},
"debit": {
"1": 202.61
}
},
"outros": {
"boleto": 202.9
}
}
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| id_Valor | int | Codigo das suas Taxas |
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.
Consultar Cliente
Exemplo de requisição:
{ }
Requisição GET como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/clientes/{idCliente}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"cliente": {
"id": 20735480,
"nome": "nome teste",
"email": "teste@example.com",
"sexo": "",
"data_nascimento": "2000-05-20",
"endereco": {
"id": 371144,
"logradouro": "Rua Exemplo",
"numero": "123",
"complemento": "",
"cep": "12345678",
"cidade": "Exemplópolis",
"uf": "DF"
},
"clientes_contatos": [
{
"id": 264660,
"tipo_contato_id": 2,
"nome": "testinho teste",
"contato": "5511999999999"
}
],
"clientes_documentos": [
{
"id": 319372,
"tipo_documento_id": 2,
"documento": "81912980070",
"arquivo": null
}
]
}
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| idCliente | int | Código de identificação do cliente que deseja consultar |
Criar um novo cliente
Exemplo de requisição:
{
"nome": "João Paulo",
"documento": "00000000000",
"dataNascimento": "1993-12-16",
"email": "teste2@1pay.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://apidash.1pay.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@1pay.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 | string | Nome do cliente / Razão Social |
| documento | int | CPF ou CNPJ do cliente |
| dataNascimento | date | Data de nascimento do cliente, caso o documento seja CPF |
| string | E-mail do cliente | |
| celular | int | Número celular do cliente |
| sexo | string | M = Masculino F = Feminino |
| logradouro | string | Rua ou Avenida do endereço |
| numero | int | Número do endereço |
| cep | string | Código postal do endereço |
| cidade | string | Cidade do endereço |
| estado | string | Código ISO 3166-2 para o estado, com duas letras |
| complemento | string | 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://apidash.1pay.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 | int | Número do cartão |
| titular | string | Nome impresso no cartão |
| codigoSeguranca | int | Código de segurança ou CVV do cartão |
| validade | string | 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://apidash.1pay.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 | int | Código de identificação do estabelecimento |
| nome | string | Nome do usuário |
| string | E-mail do usuário | |
| data de nascimento | date | Data de nascimento do usuário |
| sexo | string | Sexo do usuário |
| grupoId | int |
1 = Administrador 2 = Gerencial 3 = Básico 4 = Financeiro 5 = Representante 7 = Backoffice 7 = Representante básico |
| parentId | string | Identifica a qual estabelecimento está vinculado | id | int | Não faço ideia |
| tipoDocumento | int |
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 | int | Número do documento |
| tipoContato | int |
1 = Fixo 2 = Celular |
| valorContato | int | Número do telefone |
| logradouro | string | Logadouro do endereço do usuário |
| numero | int | Numero do endereço |
| cep | string | Código Postal do endereço do usuário |
| Cidade | string | Nome da cidade |
| estado | string | Código ISO 3166-2 para o estado, com duas letras da empresa |
| complemento | string | Complemento do endereço do usuário |
| bairro | string | 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://apidash.1pay.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 | int | 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://apidash.1pay.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 | string | Nome do usuário |
| string | E-mail do usuário | |
| data de nascimento | date | Data de nascimento do usuário |
| sexo | string | Sexo do usuário |
| grupoId | int |
1 = Administrador 2 = Gerencial 3 = Básico 4 = Financeiro 5 = Representante 7 = Backoffice 7 = Representante básico |
| parentId | int | Identifica a qual estabelecimento está vinculado |
| tipoContato | int |
1 = Fixo 2 = Celular |
| valorContato | int | Número do telefone |
| logradouro | string | Logadouro do endereço da empresa |
| numero | int | Número do endereço |
| cep | string | Código Postal do endereço da empresa |
| cidade | string | Nome da cidade |
| estado | string | Código ISO 3166-2 para o estado, com duas letras da empresa |
| complemento | string | Complemento do endereço do usuário |
| bairro | string | Bairro do endereço do usuário |
| usuarioId | int | Código de identificação do usuário |
Alterar senha do usuário
Exemplo de requisição:
{
"new":"1pay123",
"confirm":"1pay123"
}
Requisição PUT como objetos JSON para o seguinte URL:
http://apidash.1pay.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 | string | Nova senha do usuário |
| confirm | string | Confirmação da nova senha |
Excluir usuário
Exemplo de requisição:
{ }
Requisição DELETE como objetos JSON para o seguinte URL:
https://apidash.1pay.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 | int | 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,
"pedido_venda": "cod1234",
"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@1pay.com.br",
"celular": "00999998888"
},
"endereco": {
"logradouro": "Rua Bartolomeu Sabino de Melo",
"numero": "124",
"cep": "03380-200",
"cidade": "São Paulo",
"estado": "SP",
"complemento": ""
}
}
Exemplo de requisição Splits:
{
"cpfcnpj": "54360386036",
"valor": 5.00,
"tipoSplit": 1
}
Requisição POST como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/vendas
header: ContentType application/json
authorization Bearer 'Token API'
splits: (opcional)
Exemplo de resultado Split:
{
"success": true,
"message": "Venda por Boleto Bancário",
"tipo_pedido_id": 1,
"pedido_venda": 5555,
"status_pedido_id": 1,
"splitted": false,
"id": 99855,
"valor_bruto": 100,
"valor_liquido": 99.95,
"usuario_id": 3321,
"cliente_id": 445566,
"estabelecimento_id": 101112,
"modified": "2023-12-12T12:00:00.000Z",
"created": "2023-12-12T12:00:00.000Z",
"url_pagamento":"",
"splits": [
{
"id": 12345,
"zoopSplitID": "MOCKED_ID_75ae64164cce40ab9798c92c491",
"tipoSplit": "Valor Absoluto",
"valor": "5.00",
"estabelecimentoRecebeSplit":
{
"nomeFantasia": "Teste LTDA",
"razaoSocial": "Teste LTDA fake"
}
},
{
"id": 12346,
"zoopSplitID": "MOCKED_ID_75ae64164cce40ab9798c92c337",
"tipoSplit": "Percentagem",
"percentagem": "8.88",
"estabelecimentoRecebeSplit": {
"nomeFantasia": "Teste 2",
"razaoSocial": "Teste LTDA fake 2"
}
}
]
}
}
Exemplo de resultado :
{
"success": true,
"pedido": {
"tipo_pedido_id": 1,
"marketplace_id": null,
"status_pedido_id": "1",
"valor_bruto": 0,
"valor_liquido": 0,
"tipo_pagamento": null,
"bandeira": null,
"parcelas": null,
"markup": null,
"capture_mode": null,
"splitted": false,
"oculto": false,
"splitted_link": false,
"taxed": false,
"antecipado": false,
"msg_erro": null,
"id": 2401,
"usuario_id": 107,
"cliente_id": 6370195,
"estabelecimento_id": 1569,
"referencia": "",
"sales_order": "cod1234",
"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."
}O máximo de splits que podem ocorrer numa transação são 20, caso haja split já configurado, esse número será levado em consideração aos 20 totais.
ex: EC já possui 1 split configurado, o máximo será 19 splits na transação.
Parametros Splits
| Id | Tipo | Descrição |
|---|---|---|
| cpfcnpj | string | Identificar o estabelecimento que receberá o split |
| valor | int | valor a ser splitado - valor em percentagem ou valor absoluto. Se o valor for absoluto, usar em centavos. |
| tipoSplit | int | 1: split por valor absoluto. 2: split por percentual. |
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| tipoPagamentoId | int | 1 = Boleto 2 = Débito(Não implementado) 3 = Cartão de crédito 5 = Pix (Id 5) |
| valor | float | 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 | int | Quantidade de parcelas da compra no cartão |
| pedido_venda | string | Número do pedido de venda no estabelecimento |
| titular | string | Nome do titular do cartão |
| numero | int | Número do cartão |
| codigoSeguranca | int | Código de Segurança ou CVV do cartão |
| validade | string | Mês e ano em que o cartão expira sua validade |
| nome | string | Nome do cliente |
| cpf | int | CPF do cliente |
| dataNascimento | date | Data de nascimento do cliente |
| string | E-mail do cliente | |
| celular | int | Número celular do cliente |
| logradouro | string | Rua ou Avenida do endereço |
| numero | int | Número do endereço |
| cep | string | Código postal do endereço |
| cidade | string | Cidade do endereço |
| estado | string | Código ISO 3166-2 para o estado, com duas letras |
| complemento | string | 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,
"pedido_venda": "cod1234",
"cartao": {
"titular": "João Paulo",
"numero": "5234233381847212",
"codigoSeguranca": "069",
"validade": "02/2025"
},
"clienteId":1568
}
Exemplo de requisição Splits:
{
"cpfcnpj": "54360386036",
"valor": 5.00,
"tipoSplit": 1
}
Requisição POST como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/vendas
header: ContentType application/json
authorization Bearer 'Token API'
splits: (opcional)
Exemplo de resultado Split:
{
"success": true,
"message": "Venda por Boleto Bancário",
"tipo_pedido_id": 1,
"pedido_venda": 5555,
"status_pedido_id": 1,
"splitted": false,
"id": 99855,
"valor_bruto": 100,
"valor_liquido": 99.95,
"usuario_id": 3321,
"cliente_id": 445566,
"estabelecimento_id": 101112,
"modified": "2023-12-12T12:00:00.000Z",
"created": "2023-12-12T12:00:00.000Z",
"url_pagamento":"",
"splits": [
{
"id": 12345,
"zoopSplitID": "MOCKED_ID_75ae64164cce40ab9798c92c491",
"tipoSplit": "Valor Absoluto",
"valor": "5.00",
"estabelecimentoRecebeSplit":
{
"nomeFantasia": "Teste LTDA",
"razaoSocial": "Teste LTDA fake"
}
},
{
"id": 12346,
"zoopSplitID": "MOCKED_ID_75ae64164cce40ab9798c92c337",
"tipoSplit": "Percentagem",
"percentagem": "8.88",
"estabelecimentoRecebeSplit": {
"nomeFantasia": "Teste 2",
"razaoSocial": "Teste LTDA fake 2"
}
}
]
}
}
Exemplo de resultado :
{
"success":true,
"pedido":{
"tipo_pedido_id":1,
"status_pedido_id":"1",
"splitted":false,
"id":2401,
"usuario_id":107,
"pedido_venda": "cod1234",
"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."
}O máximo de splits que podem ocorrer numa transação são 20, caso haja split já configurado, esse número será levado em consideração aos 20 totais.
ex: EC já possui 1 split configurado, o máximo será 19 splits na transação.
Parametros Splits
| Id | Tipo | Descrição |
|---|---|---|
| cpfcnpj | string | Identificar o estabelecimento que receberá o split |
| valor | int | valor a ser splitado - valor em percentagem ou valor absoluto. Se o valor for absoluto, usar em centavos. |
| tipoSplit | int | 1: split por valor absoluto. 2: split por percentual. |
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| tipoPagamentoId | int | 1 = Boleto 2 = Débito(Não implementado) 3 = Cartão de crédito 5 = Pix (Id 5) |
| valor | float | 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 | int | Quantidade de parcelas da compra no cartão |
| titular | string | Nome do titular do cartão |
| numero | int | Número do cartão |
| codigoSeguranca | int | Código de Segurança ou CVV do cartão |
| validade | string | Mês e ano em que o cartão expira sua validade |
| clienteId | int | 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,
"pedido_venda": "cod1234",
"clienteId": 17194,
"cartaoId": 123456
}
Exemplo de requisição Splits:
{
"cpfcnpj": "54360386036",
"valor": 5.00,
"tipoSplit": 1
}
Requisição POST como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/vendas
header: ContentType application/json
authorization Bearer 'Token API'
splits: (opcional)
Exemplo de resultado Split:
{
"success": true,
"message": "Venda por Boleto Bancário",
"tipo_pedido_id": 1,
"pedido_venda": 5555,
"status_pedido_id": 1,
"splitted": false,
"id": 99855,
"valor_bruto": 100,
"valor_liquido": 99.95,
"usuario_id": 3321,
"cliente_id": 445566,
"estabelecimento_id": 101112,
"modified": "2023-12-12T12:00:00.000Z",
"created": "2023-12-12T12:00:00.000Z",
"url_pagamento":"",
"splits": [
{
"id": 12345,
"zoopSplitID": "MOCKED_ID_75ae64164cce40ab9798c92c491",
"tipoSplit": "Valor Absoluto",
"valor": "5.00",
"estabelecimentoRecebeSplit":
{
"nomeFantasia": "Teste LTDA",
"razaoSocial": "Teste LTDA fake"
}
},
{
"id": 12346,
"zoopSplitID": "MOCKED_ID_75ae64164cce40ab9798c92c337",
"tipoSplit": "Percentagem",
"percentagem": "8.88",
"estabelecimentoRecebeSplit": {
"nomeFantasia": "Teste 2",
"razaoSocial": "Teste LTDA fake 2"
}
}
]
}
}
Exemplo de resultado :
{
"success": true,
"pedido": {
"tipo_pedido_id": 1,
"status_pedido_id": "1",
"splitted": false,
"taxed": false,
"id": 18731,
"pedido_venda": "cod1234",
"cliente_id": 17194,
"modified": "2020-02-04T21:56:20.225Z",
"created": "2020-02-04T21:56:20.225Z",
"cartaoId": 123456
}
}O máximo de splits que podem ocorrer numa transação são 20, caso haja split já configurado, esse número será levado em consideração aos 20 totais.
ex: EC já possui 1 split configurado, o máximo será 19 splits na transação.
Parametros Splits
| Id | Tipo | Descrição |
|---|---|---|
| cpfcnpj | string | Identificar o estabelecimento que receberá o split |
| valor | int | valor a ser splitado - valor em percentagem ou valor absoluto. Se o valor for absoluto, usar em centavos. |
| tipoSplit | int | 1: split por valor absoluto. 2: split por percentual. |
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| tipoPagamentoId | int | 1 = Boleto 2 = Débito(Não implementado) 3 = Cartão de crédito 5 = Pix (Id 5) |
| valor | float | 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 | int | Quantidade de parcelas da compra no cartão |
| pedido_venda | string | Número do pedido de venda no estabelecimento |
| clienteId | int | Identificador do cliente já cadastrado |
| cartaoId | int | 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://apidash.1pay.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 | int | Identificação do pedido já criado |
Nova venda via boleto
Exemplo de requisição:
{
"tipoPagamentoId": 1,
"valor": 5.00,
"pedido_venda": "cod1234",
"dataVencimento": "2019-12-09",
"descricao": "teste de pagamento",
"cliente": {
"nome": "João Paulo",
"cpf": "00000000000",
"dataNascimento": "2001-06-14",
"email": "teste2@1pay.com.br",
"celular": "00999998888"
},
"endereco": {
"logradouro": "Rua Bartolomeu Sabino de Melo",
"numero": "124",
"cep": "03380-200",
"cidade": "São Paulo",
"estado": "SP",
"complemento": ""
}
}
{
"cpfcnpj": "54360386036",
"valor": 5.00,
"tipoSplit": 1
}
Requisição POST como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/vendas
header: ContentType application/json
authorization Bearer 'Token API'
O valor mínimo do boleto é R$ 5,00
splits: (opcional)
Exemplo de resultado Split:
{
"success": true,
"message": "Venda por Boleto Bancário",
"tipo_pedido_id": 1,
"pedido_venda": 5555,
"status_pedido_id": 1,
"splitted": false,
"id": 99855,
"valor_bruto": 100,
"valor_liquido": 99.95,
"usuario_id": 3321,
"cliente_id": 445566,
"estabelecimento_id": 101112,
"modified": "2023-12-12T12:00:00.000Z",
"created": "2023-12-12T12:00:00.000Z",
"url_pagamento":"",
"splits": [
{
"id": 12345,
"zoopSplitID": "MOCKED_ID_75ae64164cce40ab9798c92c491",
"tipoSplit": "Valor Absoluto",
"valor": "5.00",
"estabelecimentoRecebeSplit":
{
"nomeFantasia": "Teste LTDA",
"razaoSocial": "Teste LTDA fake"
}
},
{
"id": 12346,
"zoopSplitID": "MOCKED_ID_75ae64164cce40ab9798c92c337",
"tipoSplit": "Percentagem",
"percentagem": "8.88",
"estabelecimentoRecebeSplit": {
"nomeFantasia": "Teste 2",
"razaoSocial": "Teste LTDA fake 2"
}
}
]
}
}
Exemplo de resultado :
{
"success": true,
"pedido": {
"tipo_pedido_id": 1,
"pedido_venda": "cod1234",
"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"
}
}
O máximo de splits que podem ocorrer numa transação são 20, caso haja split já configurado, esse número será levado em consideração aos 20 totais.
ex: EC já possui 1 split configurado, o máximo será 19 splits na transação.
Parametros Splits
| Id | Tipo | Descrição |
|---|---|---|
| cpfcnpj | string | Identificar o estabelecimento que receberá o split |
| valor | int | valor a ser splitado - valor em percentagem ou valor absoluto. Se o valor for absoluto, usar em centavos. |
| tipoSplit | int | 1: split por valor absoluto. 2: split por percentual. |
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| tipoPagamentoId | int | 1 = Boleto 2 = Débito(Não implementado) 3 = Cartão de crédito 5 = Pix (Id 5) |
| valor | float | 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 | date | Data que o boleto irá vencer |
| descricao | string | Descição da transação |
| pedido_venda | string | Número do pedido de venda no estabelecimento |
| nome | string | Nome do cliente |
| cpf | int | CPF do cliente |
| dataNascimento | date | Data de nascimento do cliente |
| string | E-mail do cliente | |
| celular | int | Número celular do cliente |
| logradouro | string | Rua ou Avenida do endereço |
| numero | int | Número do endereço |
| cep | string | Código postal do endereço |
| cidade | string | Cidade do endereço |
| estado | string | Código ISO 3166-2 para o estado, com duas letras |
| complemento | string | 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",
"pedido_venda": "cod1234",
"clienteId":1568
}
{
"cpfcnpj": "54360386036",
"valor": 5.00,
"tipoSplit": 1
}
Requisição POST como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/vendas
header: ContentType application/json
authorization Bearer 'Token API'
O valor mínimo do boleto é R$ 5,00
splits: (opcional)
Exemplo de resultado Split:
{
"success": true,
"message": "Venda por Boleto Bancário",
"tipo_pedido_id": 1,
"pedido_venda": 5555,
"status_pedido_id": 1,
"splitted": false,
"id": 99855,
"valor_bruto": 100,
"valor_liquido": 99.95,
"usuario_id": 3321,
"cliente_id": 445566,
"estabelecimento_id": 101112,
"modified": "2023-12-12T12:00:00.000Z",
"created": "2023-12-12T12:00:00.000Z",
"url_pagamento":"",
"splits": [
{
"id": 12345,
"zoopSplitID": "MOCKED_ID_75ae64164cce40ab9798c92c491",
"tipoSplit": "Valor Absoluto",
"valor": "5.00",
"estabelecimentoRecebeSplit":
{
"nomeFantasia": "Teste LTDA",
"razaoSocial": "Teste LTDA fake"
}
},
{
"id": 12346,
"zoopSplitID": "MOCKED_ID_75ae64164cce40ab9798c92c337",
"tipoSplit": "Percentagem",
"percentagem": "8.88",
"estabelecimentoRecebeSplit": {
"nomeFantasia": "Teste 2",
"razaoSocial": "Teste LTDA fake 2"
}
}
]
}
}
Exemplo de resultado :
{
"success": true,
"pedido": {
"tipo_pedido_id": 1,
"status_pedido_id": "1",
"splitted": false,
"id": 2416,
"usuario_id": 107,
"pedido_venda": "cod1234",
"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"
}
}
O máximo de splits que podem ocorrer numa transação são 20, caso haja split já configurado, esse número será levado em consideração aos 20 totais.
ex: EC já possui 1 split configurado, o máximo será 19 splits na transação.
Parametros Splits
| Id | Tipo | Descrição |
|---|---|---|
| cpfcnpj | string | Identificar o estabelecimento que receberá o split |
| valor | int | valor a ser splitado - valor em percentagem ou valor absoluto. Se o valor for absoluto, usar em centavos. |
| tipoSplit | int | 1: split por valor absoluto. 2: split por percentual. |
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| tipoPagamentoId | int | 1 = Boleto 2 = Débito(Não implementado) 3 = Cartão de crédito 5 = Pix (Id 5) |
| valor | float | 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 | date | Data que o boleto irá vencer |
| descricao | string | Descição da transação |
| pedido_venda | string | Número do pedido de venda no estabelecimento |
| clienteId | int | 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://apidash.1pay.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@1pay.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 | float | 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 | int | Identificador do cartão já cadastrado |
| clienteId | int | 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://apidash.1pay.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@1pay.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 | float | 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 | int | Identificador do cartão já cadastrado |
| clienteId | int | Identificador do cliente já cadastrado |
Configurar Split manualmente por porcentagem
Exemplo de requisição:
{
"pedidoId": 20220,
"percentual": 90,
"estabelecimentoId": 132
}
Requisição POST como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/vendas/split
header: ContentType application/json
authorization Bearer 'Token API'
Após executar essa ação a regra de split já foi inserida e ao executar o end-point de captura o valor irá seguir a regra definida, nesse caso:
O percentual = 90 refere-se a 90% do valor total vá para o estabelecimentoId 132 e 10% fica com o estabelecimento.
Exemplo de resultado :
{
"success": true,
"message": "Operação efetuada com sucesso",
"pedido": {
"id": 20220,
"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@1pay.com.br"
},
"status_pedido": {
"id": 8,
"titulo": "Pré Autorizado"
},
"pedidos_produtos": [
{
"id": 430,
"pedido_id": 20220,
"valor_unitario": "1.00",
"quantidade": 1
}
],
"pagamentos": [
{
"id": 20562,
"tipo_pagamento_id": 3,
"status_pagamento_id": 5,
"pedido_id": 20220,
"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 |
|---|---|---|
| pedidoId | int | Identificador do pedido de pré captura |
| percentual | float | Percentual do valor que será repassado para o outro estabelecimento |
| estabelecimentoId | string | Identificador do estabelecimento que será feito o repasse do split |
Configurar Split manualmente por valor
Exemplo de requisição:
{
"pedidoId": 2098114,
"amount": 350,
"estabelecimentoId": 9831
}
Requisição POST como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/vendas/split
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Operação realizada com sucesso",
"pedido": {
"id": 2098114,
"parent_id": null,
"tipo_pedido_id": 1,
"cliente_id": 1924145,
"estabelecimento_id": 158,
"status_pedido_id": 2,
"cliente": {
"id": 1924145,
"nome": "César Mateus Lorenzo Teixeira",
"email": "cesarmateuslorenzoteixeira_@lynce.com.br"
},
"status_pedido": {
"id": 2,
"titulo": "Aprovado"
},
"pedidos_produtos": [
{
"id": 4621,
"pedido_id": 2098114,
"valor_unitario": "390.00",
"quantidade": 1
}
],
"pagamentos": [
{
"id": 6885248,
"tipo_pagamento_id": 3,
"status_pagamento_id": 1,
"pedido_id": 2098114,
"valor": "130.00",
"taxa": "5.18",
"data_recebimento": "2020-10-18T03:00:00.000Z",
"valor_recebido": "124.82",
"data_pagamento": null,
"tipo_pagamento": {
"id": 3,
"titulo": "Cartão de Crédito"
},
"status_pagamento": {
"id": 1,
"titulo": "Pendente"
}
},
{
"id": 6885252,
"tipo_pagamento_id": 3,
"status_pagamento_id": 1,
"pedido_id": 2098114,
"valor": "130.00",
"taxa": "5.19",
"data_recebimento": "2020-08-19T03:00:00.000Z",
"valor_recebido": "124.81",
"data_pagamento": null,
"tipo_pagamento": {
"id": 3,
"titulo": "Cartão de Crédito"
},
"status_pagamento": {
"id": 1,
"titulo": "Pendente"
}
},
{
"id": 6885255,
"tipo_pagamento_id": 3,
"status_pagamento_id": 1,
"pedido_id": 2098114,
"valor": "130.00",
"taxa": "5.19",
"data_recebimento": "2020-09-18T03:00:00.000Z",
"valor_recebido": "124.81",
"data_pagamento": null,
"tipo_pagamento": {
"id": 3,
"titulo": "Cartão de Crédito"
},
"status_pagamento": {
"id": 1,
"titulo": "Pendente"
}
}
]
}
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| pedidoId | int | Identificador do pedido de pré captura |
| amount | float | Valor que será repassado para o outro estabelecimento |
| estabelecimentoId | string | Identificador do estabelecimento que será feito o repasse do split |
Verificar as informações de uma venda
Exemplo de requisição:
{ }Requisição GET como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/vendas/{pedidoId}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Venda",
"venda": {
"id": 2416,
"pedido_venda": null,
"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@1pay.com.br",
"clientes_documentos": [
{
"documento": "00000000000"
}
]
},
"estabelecimento": {
"id": 131,
"nome_fantasia": "Integração 1pay",
"razao_social": "",
"arquivo": {
"url": "onepay-bucket.s3-sa-east-1.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 | int | Identificação do pedido já criado |
Listar vendas
Exemplo de requisição:
{
page: 1,
limit: 200,
filters: {
data_venda: {
de: '2023-05-11T12:42:09.505Z',
ate: '2023-05-12T12:42:09.505Z'
},
bandeira: 'mastercard',
formaPagamento: ['pix', 'boleto', 'debito', 'creditoVista', 'creditoParcelado']
}
}Requisição GET como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/vendas
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"message": "Vendas",
"paginas": 51247,
"quantidade": 10249354,
"vendas": [
{
"type": "date",
"date": "2023-05-11"
},
{
"id": 16525127,
"pedido_venda": null,
"type": "row",
"created": "2023-05-11T12:41:33.000Z",
"tipo_pagamento": "credit",
"bandeira": "mastercard",
"tipo_pagamento_id": 3,
"tipo_pagamento_titulo": "Crédito",
"tipoPagamento": null,
"valores": {
"total": "780.00",
"taxa": 18.87,
"liquido": 761.13,
"split": 0,
"planoTaxa": 0,
"split2": 0,
"markupEC": 0,
"taxaTotal": 18.87
},
"status": {
"id": 2,
"titulo": 2
},
"cliente": null,
"estabelecimento": {
"nome_fantasia": "OTICA FULANO",
"logo_id": null,
"marketplace_id": 8,
"estabelecimentos_documentos": [
{
"documento": "1234567890123"
}
]
},
"parcelas": 10,
"dataRecebimento": "2024-03-06T03:00:00.000Z",
"markup": 1.01,
"markupCalculado": "1.01",
"zoopTransactionId": "423534grfegdfg5345612q",
"planoVenda": "plano_std_onepay_sn_d30",
"representante": "JOHN DOE",
"msg_erro": null,
"pos_identification_number": "fdsfdsfsd23455235"
},
{
"id": 16525126,
"pedido_venda": null,
"type": "row",
"created": "2023-05-11T12:41:28.000Z",
"tipo_pagamento": "debit",
"bandeira": "mastercard",
"tipo_pagamento_id": 2,
"tipo_pagamento_titulo": "Débito",
"tipoPagamento": null,
"valores": {
"total": "122.34",
"taxa": 1.11,
"liquido": 121.23,
"split": 0,
"planoTaxa": 0,
"split2": 0,
"markupEC": 0,
"taxaTotal": 1.11
},
"status": {
"id": 2,
"titulo": 2
},
"cliente": null,
"estabelecimento": {
"nome_fantasia": "FULANO TELECOM",
"logo_id": null,
"marketplace_id": 8,
"estabelecimentos_documentos": [
{
"documento": "43534534534534"
}
]
},
"parcelas": 1,
"dataRecebimento": "2023-05-12T03:00:00.000Z",
"markup": 0.13,
"markupCalculado": "0.13",
"zoopTransactionId": "fdsfsdfds234234234",
"planoVenda": "plano_std_onepay_sn_d30",
"representante": "Marketing FOO",
"msg_erro": null,
"pos_identification_number": "dfsfdsfsd34534534"
}]
}Parametros
| Id | Tipo | Descrição |
|---|---|---|
| page | int | Número da página |
| limit | int | Quantidade de registros por página |
| filters | object | Objeto contendo campos para filtrar(ver exemplo) |
Links de Pagamentos
Pagar através de um link é um modelo que permite que o lojista envie um link para o cliente realizar o pagamento. O consumidor não precisa acessar a loja online, selecionar os produtos nem finalizar a compra.
Criar um link de pagamento sem juros e split
Exemplo de requisição:
{
"id":null,
"titulo":"Teste",
"descricao":"Teste",
"amount":15000,
"parcelamento_ate":1,
"meio_pagamento":3,
"data_expiracao":"2020-09-09T20:58:22.723Z",
"logo":true,
"split":false,
"token":null,
"nome_fantasia":"",
"juros":false,
"percentual":0,
"juros_a_partir":2
}
Requisição POST como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/pre_venda
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"preVenda": {
"ativo": true,
"id": 907,
"titulo": "Teste",
"descricao": "Teste",
"amount": 15000,
"parcelamento_ate": 1,
"data_expiracao": "2020-09-09T20:58:22.723Z",
"logo": true,
"token": "03212ae4da4a76e535fb7d79b6b74c2e40e956d6",
"juros": 0,
"juros_a_partir": 0,
"estabelecimento_id": 158,
"tipo_pagamento_id": 3,
"updatedAt": "2020-08-10T21:02:36.882Z",
"createdAt": "2020-08-10T21:02:36.882Z",
"estabelecimento": {
"id": 158,
"status_estabelecimento_id": 2,
"categoria_estabelecimento_id": 1,
"endereco_id": 247,
"logo_id": null,
"logo_boleto_id": null,
"razao_social": "Made Nova Madeiras Ltda",
"nome_fantasia": "Made Nova Madeiras Ltda",
"identificacao_fatura": "madepag",
"identificador_plano": null,
"observacao": null,
"ativo": 1,
"data_nascimento": null,
"mcc": null,
"data_desabilitado": null,
"termos_condicoes_aceito": false,
"termos_condicoes_aceito_data": null,
"termos_condicoes_aceito_usuario_id": null,
"created": "2019-12-19T14:04:00.000Z",
"modified": "2020-08-10T19:55:38.000Z",
"removed": null
}
}
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| id_pre_venda | int | Código de identificação do link de pagamento |
| titulo | string | Título do link de pagamento |
| descricao | string | Descrição do link de pagamento |
| amount | float | Valor da recorrência, ex.: 25 = R$ 0.25, 100 = R$ 1.00, 10000 = R$ 100.00 |
| parcelamento_ate | int | Define a quantidade de parcelas a serem pagas |
| meio_pagamento | int | Define a forma de pagamento |
| data_expiracao | date-time | Define a data de vencimento do link de pagamento |
| logo | boolean | Define se o logo do estabelecimento será exibido ou não |
| split | boolean | Define se o valor recebido do link de pagamento terá ou não configuração de split |
| token | string | Código de autenticação |
| nome_fantasia | string | Nome fantasia |
| juros | boolean | Define se serão cobrados juros nas vendas de cartão de crédito parcelado |
| percentual | float | Define o percentual de juros a ser cobrado nas vendas de cartão de crédito parcelado |
| juros_a_partir | int | Define a partir de qual parcela que os juros serão cobrados |
Criar um link de pagamento com juros
Exemplo de requisição:
{
"id": null,
"titulo": "Teste c/ juros",
"descricao": "Teste c/ juros",
"amount": 10000,
"parcelamento_ate": 3,
"meio_pagamento": 3,
"data_expiracao": "2020-09-16T20:44:20.000Z",
"logo": true,
"split": false,
"token": null,
"nome_fantasia": "",
"juros": true,
"percentual": "4,00",
"juros_a_partir": 2,
"splits": [
{
"estabelecimentoId": false,
"cpfcnpj": "",
"nome": "",
"email": "",
"value": 0,
"tipoSplit": 2,
"chargeProcessingFee": false
}
]
}
Requisição POST como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/pre_venda
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"preVenda": {
"ativo": true,
"id": 960,
"titulo": "Teste c/ juros",
"descricao": "Teste c/ juros",
"amount": 10000,
"parcelamento_ate": 3,
"data_expiracao": "2020-09-16T20:44:20.000Z",
"logo": true,
"token": "94393792dd92d9d0151530f51f48b79bb0070a01",
"juros": 4,
"juros_a_partir": 2,
"estabelecimento_id": 158,
"tipo_pagamento_id": 3,
"updatedAt": "2020-08-17T20:48:34.597Z",
"createdAt": "2020-08-17T20:48:34.597Z",
"estabelecimento": {
"id": 158,
"status_estabelecimento_id": 2,
"categoria_estabelecimento_id": 1,
"endereco_id": 247,
"logo_id": null,
"logo_boleto_id": null,
"razao_social": "Made Nova Madeiras Ltda",
"nome_fantasia": "Made Nova Madeiras Ltda",
"identificacao_fatura": "madepag",
"identificador_plano": null,
"observacao": null,
"ativo": 1,
"data_nascimento": null,
"mcc": null,
"data_desabilitado": null,
"termos_condicoes_aceito": false,
"termos_condicoes_aceito_data": null,
"termos_condicoes_aceito_usuario_id": null,
"created": "2019-12-19T14:04:00.000Z",
"modified": "2020-08-11T15:21:00.000Z",
"removed": null
}
}
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| id_pre_venda | int | Código de identificação do link de pagamento |
| titulo | string | Título do link de pagamento |
| descricao | string | Descrição do link de pagamento |
| amount | float | Valor da recorrência, ex.: 25 = R$ 0.25, 100 = R$ 1.00, 10000 = R$ 100.00 |
| parcelamento_ate | int | Define a quantidade de parcelas a serem pagas |
| meio_pagamento | int | Define a forma de pagamento |
| data_expiracao | date-time | Define a data de vencimento do link de pagamento |
| logo | boolean | Define se o logo do estabelecimento será exibido ou não |
| split | boolean | Define se o valor recebido do link de pagamento terá ou não configuração de split |
| token | string | Código de autenticação |
| nome_fantasia | string | Nome fantasia |
| juros | boolean | Define se serão cobrados juros nas vendas de cartão de crédito parcelado |
| percentual | float | Define o percentual de juros a ser cobrado nas vendas de cartão de crédito parcelado |
| juros_a_partir | int | Define a partir de qual parcela que os juros serão cobrados |
| estabelecimentoId | boolean | Código de identificação do estabelecimento que receberá Split |
| cpfcnpj | int | Número do documento do estabelecimento que receberá Split |
| nome | string | Nome do estabelecimento que receberá Split |
| string | E-mail do estabelecimento que receberá Split | |
| value | float | Valor do Split a ser recebido em real ou porcentagem |
| tipoSplit | int |
1 = Real 2 = Percentual |
| chargeProcessingFee | boolean |
0 = Bruto 1 = Líquido |
Listar links de pagamentos
Exemplo de requisição:
{
"page": 1,
"limit": 2,
"filters": {"estabelecimentoId":null}
}
Requisição GET como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/pre_venda
header: ContentType application/json
authorization Bearer 'Token API'
Converter parâmetros de entrada de JSON para Query string para utilização na URL
Exemplo de resultado :
{
"success": true,
"paginas": 39,
"quantidade": 77,
"pre_vendas": [
{
"id": 956,
"estabelecimento_id": 158,
"tipo_pagamento_id": 3,
"juros_a_partir": 2,
"juros": 1.11,
"titulo": "Teste",
"descricao": "Teste",
"parcelamento_ate": 2,
"amount": "150000",
"token": "24a7fc64ef13dd255276e140e62a7658233ff077",
"pedido_id": null,
"data_expiracao": "2020-09-16T20:04:09.000Z",
"ativo": true,
"logo": true,
"createdAt": "2020-08-17T20:05:11.000Z",
"updatedAt": "2020-08-17T20:05:11.000Z",
"removedAt": null,
"estabelecimento": {
"nome_fantasia": "Made Nova Madeiras Ltda"
},
"pre_venda_pedidos": []
},
{
"id": 947,
"estabelecimento_id": 158,
"tipo_pagamento_id": 3,
"juros_a_partir": 0,
"juros": 0,
"titulo": "A - Compra de Ativo Digital",
"descricao": "50 unidades de TREEPS",
"parcelamento_ate": 5,
"amount": "3500",
"token": "fef220fe1c1d98555bf7eeeec20023540645510d",
"pedido_id": null,
"data_expiracao": "2020-09-15T18:42:10.000Z",
"ativo": true,
"logo": true,
"createdAt": "2020-08-16T18:42:52.000Z",
"updatedAt": "2020-08-16T18:42:52.000Z",
"removedAt": null,
"estabelecimento": {
"nome_fantasia": "Made Nova Madeiras Ltda"
},
"pre_venda_pedidos": []
}
]
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| page | int | Número de páginas |
| limit | int | Define a quantidade de links de pagamentos a serem exibidos por página |
| estabelecimentoId | int | Código de identificação do estabelecimento |
Consultar Link de pagamento
Exemplo de requisição:
{ }
Requisição GET como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/pre_venda/{id_pre_venda}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true,
"preVenda": {
"id": 906,
"estabelecimento_id": 158,
"tipo_pagamento_id": 3,
"juros_a_partir": 0,
"juros": 0,
"titulo": "Teste",
"descricao": "Teste",
"parcelamento_ate": 1,
"amount": "15000",
"token": "a7d941e702ccba9d8c7a9d04253d20eb6a8a0ad3",
"pedido_id": null,
"data_expiracao": "2020-09-09T20:58:22.000Z",
"ativo": true,
"logo": true,
"createdAt": "2020-08-10T20:58:57.000Z",
"updatedAt": "2020-08-10T20:58:57.000Z",
"removedAt": null,
"estabelecimento": {
"id": 158,
"nome_fantasia": "Made Nova Madeiras Ltda",
"razao_social": "Made Nova Madeiras Ltda"
},
"pre_venda_pedidos": []
}
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| id_pre_venda | int | Código de identificação do link de pagamento que deseja consultar |
Excluir link de pagamento
Exemplo de requisição:
{ }
Requisição DELETE como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/pre_venda/{id_pre_venda}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"success": true
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| id_pre_venda | int | Código de identificação do link de pagamento que deseja excluir |
Campanha de Vendas
A nossa Campanha de Vendas, permite que o cliente faça vários tipos de pagamentos (Boletos e Cartões de credito), facilitando para o consumidor que adquira seu patrimônio, da forma mais desejada.
Criar Campanha de Vendas
Exemplo de requisição:
{
"parcelamento_ate": 12,
"meio_pagamento": [
1,
3
],
"logo": true,
"titulo": "Teste Título",
"descricao": "Teste Descrição",
"data_expiracao": "2030-09-11T03:00:00.000Z",
"credit_card": true,
"amount": 10000,
"bank_slip": true,
"token":null,
"status": true,
"installments_payer": false
}
Requisição POST como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/sellingCampaign
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de Resultado
{
"success": true,
"sellingCampaign": {
"id": 134,
"name": "Teste Título",
"estabelecimento_id": 782,
"description": "Teste Descrição",
"token": "ccaa4ca564694a33a8193ff6c229e0a9",
"amount": 10000,
"logo": true,
"status": true,
"installments_payer": false,
"until": "2030-09-11T03:00:00.000Z",
"credit_card": true,
"bank_slip": true,
"installments": 12,
"modified": "2021-09-14T14:45:38.500Z",
"created": "2021-09-14T14:45:38.500Z"
}
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| id_campanha_de_vendas | int | Código de identificação do link de pagamento |
| parcelamento_ate | int | Define a quantidade de parcelas a serem pagas |
| meio_pagamento | string | Define a forma de pagamento |
| logo | boolean | Define se o logo do estabelecimento será exibido ou não |
| título | string | Título da Campanha de Vendas |
| Descrição | string | Descrição da Campanha de Vendas |
| data_expiracao | date-time | Define a data de vencimento da Campanha de Vendas |
| Amount | float | Valor da recorrência, ex.: 25 = R$ 0.25, 100 = R$ 1.00, 10000 = R$ 100.00 |
| split | boolean | Define se o valor recebido do link de pagamento terá ou não configuração de split |
| token | string | Código de autenticação |
| Status | string | Status da criação da campanha de vendas |
| installments_payer | boolean | Define a partir de qual parcela que os juros serão cobrados |
Consultar Campanha de Vendas
Exemplo de requisição:
{}
Requisição GET como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/sellingCampaign/{id_campanha_de_vendas}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de Resultado
{
"success": true,
"sellingCampaign": {
"id": 67,
"name": "OCULOS HAMMERHEAD",
"description": "ADULTO OU INFANTIL",
"token": "68d0a285251642d7890bcf4eb49b0159",
"amount": 6700,
"status": 1,
"until": "2021-12-31T03:00:00.000Z",
"credit_card": true,
"installments_payer": false,
"logo": true,
"bank_slip": false,
"installments": 2,
"created": "2021-04-28T14:50:58.000Z",
"modified": "2021-04-28T14:50:58.000Z",
"removed": null,
"estabelecimento_id": 12882,
"estabelecimento": {
"id": 12882,
"nome_fantasia": "ZERO GRAU NATAÇÃO",
"razao_social": "ESCOLA DE NATACAO CIRCUITO AQUATICO LTDA"
},
"selling_campaign_pedidos": []
}
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| id_campanha_de_vendas | int | Código de identificação do link de pagamento que deseja consultar |
Listar Campanha de Vendas
Exemplo de Requisição
{
"page": "1",
"limit": "1",
"filters": {
"estabelecimentoId": null
}
}
Requisição GET como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/sellingCampaign
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de Resultado
{
"success": true,
"sellingCampaign": [
{
"id": 113,
"name": "Jogo de Prato Raso",
"description": "",
"token": "0c7207727c094b088bffc2ad48226037",
"amount": 28000,
"status": 1,
"until": "2021-12-31T03:00:00.000Z",
"credit_card": true,
"installments_payer": true,
"logo": true,
"bank_slip": true,
"installments": 12,
"created": "2021-08-06T15:58:30.000Z",
"modified": "2021-08-06T15:58:30.000Z",
"removed": null,
"estabelecimento_id": 17082,
"estabelecimento": {
"nome_fantasia": "LUIS ROBERTO COSTA DIAS ",
"razao_social": "",
"estabelecimentos_documentos": [
{ "documento": "37763758848",
"tipo_documento_id": 2
}
]
},
"selling_campaign_pedidos": []
}
],
"paginas": 1,
"quantidade": 1
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| page | int | Número de páginas |
| limit | int | Define a quantidade de Campanha de Vendas a serem exibidos por página |
| estabelecimentoId | string | Código de identificação do estabelecimento |
Alterar Campanha de Vendas
Exemplo de requisição:
{
"name": "Título da Campanha de Vendas",
"description": "Texto de descrição",
"status": 1,
"logo": true,
"installments_payer": true,
"installments": "12",
"until": "2021-08-18T20:31:13.000Z",
"credit_card": true,
"bank_slip": true
}
Requisição PUT como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/sellingCampaign/{id_campanha_de_vendas}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de Resultado
{
"success": true,
"sellingCampaign": {
"id": 100,
"name": "Título da Campanha de Vendas",
"description": "Texto de descrição",
"token": "9a41a9ad0bba427f8ea26c1eaca6f4bf",
"amount": 1000,
"status": 1,
"until": "2021-08-18T20:31:13.000Z",
"credit_card": true,
"installments_payer": true,
"logo": true,
"bank_slip": true,
"installments": 12,
"created": "2021-07-19T20:31:54.000Z",
"modified": "2021-09-14T16:32:21.000Z",
"removed": null,
"estabelecimento_id": 782,
"estabelecimento": {
"id": 782,
"nome_fantasia": "ONE PAY INTERMEDIACOES EM PAGAMENTOS LTDA",
"razao_social": "ONE PAY INTERMEDIACOES EM PAGAMENTOS LTDA"
},
"selling_campaign_pedidos": [
{
"id": 122,
"pedido_id": 9862961,
"selling_campaign_id": 100,
"created": "2021-07-19T20:33:19.000Z",
"modified": "2021-07-19T20:33:19.000Z",
"removed": null,
"pedido": {
"id": 9862961,
"sales_order": null,
"tipo_pedido_id": 1,
"cliente_id": 6787323,
"status_pedido_id": 3,
"valor_bruto": "10.00",
"valor_liquido": "10.00",
"tipo_pagamento": "credit",
"bandeira": "mastercard",
"parcelas": 1,
"capture_mode": "manually_keyed",
"splitted": false,
"created": "2021-07-19T20:33:19.000Z",
"modified": "2021-07-19T22:19:26.000Z",
"removed": null
}
}
]
}
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| id_campanha_de_vendas | int | Código de identificação da Campanha de Vendas |
| nome | string | Nome da Campanha de Vendas |
| Descrição | string | Descrição da Campanha |
| Status | boolean | Descrição dos status da Campanha de vendas(0 para inativo, 1 para ativo) |
| Logo | boolean | Campo que define se exibir logo do estabelecimento na tela de adesão ou não |
| installments_payer | boolean | Conifrmação de pagamento das parcelas |
| Parcelas | string | Quantidades de Parcelas |
| until | date-time | Data de Expriração da campanha |
| credit_card | boolean | verificação do Cartão de Credíto |
| bank_slip | boolean | verificação dos Boletos |
Mudar Status da campanha de vendas
Exemplo de Requisição
{
"status": true
}
Requisição GET como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/Onepay/sellingCampaign{changeStatus_100}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de Resultado
{
"success": true,
"sellingCampaignResult": [
1
]
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| id_changeStatus | int | Código de identificação da campanha de vendas que deseja ver os status |
| Status | Boolean | Código de identificação da campanha de vendas que deseja ver os status |
Excluir Campanha de Vendas
Exemplo de Requisição
{}
Requisição DELETE como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/sellingCampaign/{id_campanha_de_vendas}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de Resultado
{
"success": true,
"message": "Campanha removida com sucesso"
}
Parametros
| Id | Tipo | Descrição |
|---|---|---|
| id_campanha_de_vendas | int | Código de identificação da campanha de vendas que deseja excluir |
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",
"interval": 1,
"logo": true,
"currency": "BRL",
"payment_methods": "credito"
}
Requisição POST como objetos JSON para o seguinte URL:
https://apidash.1pay.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 |
|---|---|---|
| PlanoId | int | Identificador do plano já cadastrado |
| name | string | Nome do plano. Ex.: Plano semanal |
| description | string | Descrição do plano, falando sobre os beneficios da assinatura |
| setup_amount | float | 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 | float | Valor da recorrência, ex.: 25 = R$ 0.25, 100 = R$ 1.00, 10000 = R$ 100.00 |
| grace_period | int | Período gratuito antes da primeira cobrança |
| tolerance_period | int | Período de tolerância quando o pagamento não ocorre |
| frequency | string | Frequencia na qual a recorrencia vai acontecer. Nesse campo pode receber 4 valores, sendo eles: ['daily', 'weekly', 'monthly', 'annualy'] |
| interval | string | 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 | boolean | Campo que define se exibir logo do estabelecimento na tela de adesão ou não |
| currency | string | Tipo de moeda a ser utilizado, no caso sempre BRL |
| payment_methods | string | Método de pagamento. Cartão de crédito ou boleto |
Visualizar planos cadastrados
Exemplo de requisição:
{ }
Requisição GET como objetos JSON para o seguinte URL:
https://apidash.1pay.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 1pay"
}
}
],
"paginas": 1,
"quantidade": 1
}Parametros
| Id | Tipo | Descrição |
|---|---|---|
| PlanoId | int | Identificador do plano já cadastrado |
Recuperar plano pelo identificador
Exemplo de requisição:
{ }
Requisição GET como objetos JSON para o seguinte URL:
https://apidash.1pay.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 | int | 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://apidash.1pay.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 | int | Identificador do plano já cadastrado |
| name | string | Nome do plano. Ex.: Plano semanal |
| description | string | Descrição do plano, falando sobre os beneficios da assinatura |
| setup_amount | float | 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 | float | Valor da recorrência, ex.: 25 = R$ 0.25, 100 = R$ 1.00, 10000 = R$ 100.00 |
| grace_period | int | Período gratuito antes da primeira cobrança |
| tolerance_period | int | Período de tolerância quando o pagamento não ocorre |
| frequency | string | Frequencia na qual a recorrencia vai acontecer. Nesse campo pode receber 4 valores, sendo eles: ['daily', 'weekly', 'monthly', 'annualy'] |
| interval | string | 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 | string | Tipo de moeda a ser utilizado, no caso sempre BRL |
| payment_methods | int | 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://apidash.1pay.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 | int | 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://apidash.1pay.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 | int | Número da página de listagem de planos |
| limit | int | Limite de planos por página |
| PlanoId | int | Identificador do plano já cadastrado |
| nome | string | Título do plano |
| valor | int | 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@1pay.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://apidash.1pay.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 | int | Identificação do plano já cadastrado |
| expiration_date | date | Quando expira a assinatura, se não houver data de expiração favor remover |
| nome | string | Nome do cliente ou Razão Social |
| string | E-mail do cliente | |
| cpf ou cnpj | int | CPF ou CNPJ cliente, se enviar o CPF, não enviar CNPJ e vice-versa |
| dataNascimento | date | Data de nascimento do cliente |
| telefone | int | Número telefone fixo do cliente |
| celular | int | Número celular do cliente |
| logradouro | string | Rua ou Avenida do endereço |
| numero | int | Número do endereço |
| cep | string | Código postal do endereço |
| cidade | string | Cidade do endereço |
| estado | string | Código ISO 3166-2 para o estado, com duas letras |
| complemento | string | Complemento do endereço |
| titular | string | Nome do titular do cartão |
| numero | int | Número do cartão |
| codigoSeguranca | int | Código de Segurança ou CVV do cartão |
| validade | string | Mês e ano em que o cartão expira sua validade |
Visualizar detalhes de uma assinatura
Exemplo de requisição:
{}Requisição GET como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/planos/assinatura/{PlanoId}
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 1pay",
"razao_social": ""
}
},
"cliente": {
"id": 202,
"nome": "João Paulo",
"data_nascimento": "1991-10-10",
"email": "teste2@1pay.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": 2,
"created": "2019-11-26T21:21:51.000Z",
"modified": "2019-11-26T21:21:51.000Z",
"removed": null
}
]
}
}
}Parametros
| Id | Tipo | Descrição |
|---|---|---|
| PlanoId | int | Identificação da assinatura já cadastrada |
Alterar data da próxima recorrência
Exemplo de requisição:
{
"due_date":’2019-11-28’,
}Requisição PUT como objetos JSON para o seguinte URL:
https://apidash.1pay.com.br/planos/{PlanoId}
header: ContentType application/json
authorization Bearer 'Token API'
Exemplo de resultado :
{
"id": 90,
"plano_id": 42,
"ativo": 1,
"status_assinatura_id": 1,
"payment_method": "credit",
"due_date": "2019-11-28",
"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,
"description": "Plano com cobrança recorrente anualmente",
"frequency": "monthly",
"grace_period": "0",
"interval": 1,
"setup_amount": 25,
"tolerance_period": 0
},
"cliente": {
"id": 202,
"nome": "Jose Alves Pereira Santos",
"data_nascimento": "1991-10-10",
"email": "email@josealves.com.br",
"sexo": "M",
"ativo": true
}
}Parametros
| Id | Tipo | Descrição |
|---|---|---|
| PlanoId | int | Identificação da assinatura já cadastrada |
| due_date | 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://apidash.1pay.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 | int | 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://apidash.1pay.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 | int | Identificação da assinatura já cadastrada |
Remover uma assinatura
Exemplo de requisição:
{}Requisição DELETE como objetos JSON para o seguinte URL:
https://apidash.1pay.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 | int | 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://apidash.1pay.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 | int | 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://apidash.1pay.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_PlanoId | int | 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://apidash.1pay.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_bancos | Int | Código de identificação do banco na base |
| nome | string | Campo contendo o código e o nome do banco |
| codigo | int | 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@1pay.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 |
| É 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@1pay.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 |
| É 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@1pay.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 |
| É 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@1pay.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 |
| É 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@1pay.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 |
| É 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@1pay.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@1pay.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@1pay.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,
"sales_order": "cod1234",
"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'; |
| sales_order | Número do pedido de venda no estabelecimento |
| 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,
"sales_order": "cod1234",
"pos_identification_number": "20dd1d6edf1444729363a6ec1f14c723",
"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'; |
| sales_order | Número do pedido de venda no estabelecimento |
| 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,
"sales_order": "cod1234",
"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'; |
| sales_order | Número do pedido de venda no estabelecimento |
| 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,
"sales_order": "cod1234",
"pos_identification_number": "20dd1d6edf1444729363a6ec1f14c723",
"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'; |
| sales_order | Número do pedido de venda no estabelecimento |
| 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,
"sales_order": "cod1234",
"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] |
| sales_order | Número do pedido de venda no estabelecimento |
| 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,
"sales_order": "cod1234",
"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. |
| sales_order | Número do pedido de venda no estabelecimento |
| 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,
"sales_order": "cod1234",
"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] |
| sales_order | Número do pedido de venda no estabelecimento |
| 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,
"sales_order": "cod1234",
"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] |
| sales_order | Número do pedido de venda no estabelecimento |
| 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,
"sales_order": "cod1234",
"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] |
| sales_order | Número do pedido de venda no estabelecimento |
| 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 1pay",
"agencia": "000",
"conta": "00000",
"documento": "12345678901",
"banco": {
"nome": "Banco Bradesco S.A.",
"codigo": 237
}
},
"FromEstabelecimento": {
"nome_fantasia": "Integração 1pay"
},
"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. |