ContaPay Docs
version
v1
baseUri
https://api.contapay.me/v1/
protocols
HTTPS
Bem vindo
A API ContaPay está organizada com o estilo arquitetural REST (Representational State Transfer). Estruturamos a API de maneira que os recursos oferecidos pela ContaPay pudessem ser utilizados de maneira simples e fácil.
Nossa API possui utiliza os códigos de resposta HTTP para indicar os erros e sucessos das requisições. O JSON é retornado por todas as respostas da API, incluindo erros. Isso facilita a identificação do problema ocorrido e consequentemente possibilita maior velocidade na correção de requisições incompatíveis com a API ContaPay.
Recursos
A API ContaPay possui 6 recursos disponíveis. Veja a seguir uma breve descrição de cada um. Você pode ver a descrição completa de cada recurso, estrutura e exemplos na aba Resources .
Clients
O recurso
/clients
possui dois métodos, o
GET
e o
POST
.
O método
GET
, quando requisitado, retorna um array JSON de objetos. Cada objeto representa um cliente e seus atributos os dados deste. Por método
POST
é possível cadastrar um cliente.
O recurso
/clients
possui ainda um sub-recurso denominado
/{clientId}
. Este disponibiliza através dos métodos
GET
,
PUT
e
DELETE
maneiras de manipular diretamente um cliente por meio de seu ID.
Billings
O recurso
/billings
possui dois métodos, o
GET
e o
POST
.
O método
GET
, quando requisitado, retorna um array JSON de cobranças. Cada objeto representa uma cobrança e seus atributos os dados desta. Por método
POST
é possível cadastrar uma cobrança.
O recurso
/billings
possui ainda um sub-recurso denominado
/{billingId}
. Este disponibiliza através dos métodos
GET
,
PUT
e
DELETE
maneiras de manipular diretamente uma cobrança por meio de seu ID.
Emails
O recurso
/emails/{invoiceId}
permite que seja reenviado para o cliente um boleto via método
PUT
. A API ContaPay identificará o cliente por meio do ID do boleto informado, o
{billingId}
.
Transfer
O recurso
/transfer
permite que seja realizada, via método
POST
, uma solicitação de saque.
Extract
O recurso
/extract
, quando solicitado pelo método
GET
, retorna o extrato financeiro de uma empresa em um determinado período de tempo por meio de um array JSON de objetos. Cada objeto representa um registro financeiro e seus atributos os dados deste.
Notifications
O recurso
/notifications/{invoiceId}
, quando solicitado pelo método
PUT
, retorna as notificações atribuídas ao envio do boleto com o ID informado.
Ambiente de testes
O ContaPay possui dois ambientes:
1) o ambiente de produção
APP: app.contapay.me
API: api.contapay.me
2) o ambiente de testes
Homologação: homologacao.contapay.me
Sandbox: sandbox.contapay.me
Para fazer requisições à API você precisa solicitar seu Secret Token no APP . Mas lembre-se: as requisições feitas pela API são consideradas válidas.
Para realizar testes você deve utilizar a Sandbox (que é a versão de testes da API) e o Homologação (que é o ambiente de testes do APP). As requisições realizadas por esse ambiente nunca serão consideradas válidas pelo ContaPay e ele só deve ser utilizado para testes de implantação do seu sistema.
Autenticação
Para conseguir fazer requisições à API você precisa:
- Ter uma conta no sistema ContaPay. Caso não tenha uma conta você precisará criar uma conta ContaPay .
- Um Secret Token .
- Um Acess Token .
O Secret Token e o Acess Token compõem o método de autenticação de chave dupla utilizado pela API ContaPay para oferecer maior segurança aos seus usuários. Veja a seguir como esses tokens podem ser gerados por você.
Secret Token
O Secret Token é uma chave privada que pode ser habilitada por você em seu perfil. Depois de gerada ela sempre será a mesma até que você gere uma nova chave. O Secret Token é necessário para gerar um Acess Token , logo, depois de ter seu Secret Token habilitado, você já está apto a gerar o Acess Token .
Como o nome já indica, o Secret Token é secreto e deve ser bem protegido. Preocupada com sua segurança, a ContaPay utiliza o algoritmo SHA256 para gerar seu Secret Token . Você também deve fazer a sua parte e manter o seu Secret Token em segredo, pois com ele é possível fazer operações em seu nome. Sendo assim, não compartilhe o mesmo em áreas públicas.
Para gerar um novo Secret Token :
- Faça login em sua conta ContaPay.
- Acesse a página de dados cadastrais, ou acesse este link para ser redirecionado(a) para lá.
- Procure a seção intitulada Chaves de API
- Clique no botão Criar chave
- Clique em Confirmar
Pronto! Você já possui um Secret Token e já pode gerar um Acess Token na API.
Acess Token
O Access Token é uma chave temporária necessária para autenticar cada requisição feita à API. Diferentemente do Secret Token , o Acess Token expira após um determinado período de tempo. Quando isso acontece não será mais possível realizar requisições à API por meio dessa chave expirada, o que torna necessária a geração de um novo Acess Token .
Para gerar um Access Token faça uma requisição do tipo POST ao endereço https://api.contapay.me/v1/authenticate com os parâmetros de cabeçalho e corpo a seguir:
Header
Campo | Valor |
Content-Type | application/json |
Body
Campo | Valor |
[email protected] | |
token | MeuSecretToken |
Como resposta a essa requisição será retornado um objeto JSON contendo o seu acess_token , o token_type e o expires_in , momento a partir do qual o acces_token não possuirá mais validade. O expires_in exibe, respectivamente, a data de expiração do acces_token no padrão americano: YYYY-MM-DD h:i:s. Veja o exemplo de resposta a seguir:
Exemplo de Acess Token |
{
|
Pronto! Você já possui um Secret Token e um Access Token , portanto, já pode utilizar os recursos disponíveis na API ContaPay.
Como utilizar o Acess Token para autenticar as minhas requisições?
A autenticação acontece por meio de dois parâmetros enviados no cabeçalho (header) de cada requisição realizada. Os primeiro parâmetro é o Authorization . A sua chave (token) deve ser enviada como valor desse parâmetro, precedida da palavra Bearer . O segundo parâmetro é o Content-Type . Como valor desse campo você apenas deve informar application/json
Veja o exemplo:
Campo | Valor |
Authorization |
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC8
xMjcuMC4wLjE6ODAwM1wvYXBpXC9sb2dpbiIsImlhdCI6MTUxODc4NTU2OCw iZXhwIjoxNTE4Nzg5MTY4LCJuYmYiOjE1MTg3ODU1NjgsImp0aSI6IkdKTXN 6VVhYRm1vU29aQ2QiLCJzdWIiOjEsInBydiI6ImY1N2I4YzQ1N2M0NTlhOTE 0MDRjMzhjYThlMWYzY2Y1ZDEyZGVkOGYifQ.gfgVq9zaEabY-CJU1mlodekx xPuP3006aNH11wN1bbA |
Content-Type | application/json |
Erros
Além das descrições dos erros apresentados em Json, o ContaPay retorna os códigos de resposta HTTP convencionais.
Código | Descrição |
---|---|
200 - OK | Tudo funcionou como o esperado. |
201 - Created | O pedido foi cumprido, resultando na criação de um novo recurso. |
400 - Bad Request | A solicitação não foi aceita, muitas vezes devido a falta de um parâmetro necessário. |
401 - Unauthorized | Chave de API não fornecida ou inválida. |
404 - Not found | Recurso inexistente. |
417 - Expectation Failed | O servidor não pode atender à requisição por indefinição ou definição incorreta do Content-Type no cabeçalho da requisição. |
422 - Unprocessable Entity | A requisição foi realizada, mas não pôde prosseguir devido a erros semânticos. |
500 - Internal Server Error | Uma mensagem de erro genérica, dada quando uma condição inesperada foi encontrada e nenhuma mensagem mais específica é adequada. |
/clients
Coleção de clientes pertencentes a uma empresa
/clients get
GET: /clients
Retorna todos os clientes pertencentes a uma empresa.
Header Parameters
Authorization
Utilize esse campo para enviar um token válido. Inicie o preenchimento do campo com o termo
Bearer
e em seguida o token.
Property | Value |
---|---|
required | true |
type | string |
examples |
Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
|
Content-Type
Neste campo apenas preencha
application/json
Property | Value |
---|---|
required | true |
type | string |
examples |
application/json
|
Possible Responses
200, 401, 404, 417, 500
/clients get
CURL EXAMPLE
curl -X GET "api.contapay.me/v1/clients" \
-H "Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6" \
-H "Content-Type: application/json"
REQUEST HEADERS
Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
Content-Type: application/json
RESPONSE BODY
[
{
"client_id": "678fdf60f09b909c910d95cc43d81a4660221760f463ffa63e2e51be41bc78b8",
"name": "John Doe",
"phone": "(88) 88888-8888",
"email": "[email protected]",
"person_id": "111.222.333-44",
"address": {
"zip_code": "88888-888",
"street": "RUA 88",
"number": "888 A",
"complement": "APTO 888",
"district": "Meu bairro"
}
},
{
"client_id": "bfea46db09aa46da5a6628ecd5d5fba31d9d50417f5178db9727d3676427e2df",
"name": "Richard Doe",
"phone": "(99) 99999-9999",
"email": "[email protected]",
"person_id": "222.333.444-55",
"address": {
"zip_code": "99999-999",
"street": "RUA 99",
"number": "999",
"complement": "APTO 999",
"district": "Meu bairro"
}
}
]
Type
{
"name": "type",
"displayName": "type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "array",
"items": {
"name": "items",
"displayName": "items",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "client_id",
"displayName": "client_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único do cliente. Gerado automaticamente pelo sistema.",
"key": "client_id"
},
{
"name": "name",
"displayName": "name",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Nome do cliente.",
"key": "name"
},
{
"name": "phone",
"displayName": "phone",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Número de telefone do cliente.",
"key": "phone"
},
{
"name": "email",
"displayName": "email",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "E-mail do cliente.",
"key": "email"
},
{
"name": "person_id",
"displayName": "person_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "CPF ou CNPJ do cliente.",
"key": "person_id"
},
{
"name": "address",
"displayName": "address",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"required": true,
"description": "Objeto JSON de endereço do cliente.",
"properties": [
{
"name": "zip_code",
"displayName": "zip_code",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "CEP do endereço do cliente.",
"key": "zip_code"
},
{
"name": "street",
"displayName": "street",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Nome da rua do cliente.",
"key": "street"
},
{
"name": "number",
"displayName": "number",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Número da casa do cliente.",
"key": "number"
},
{
"name": "complement",
"displayName": "complement",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Informação complementar ao endereço do cliente.",
"key": "complement"
},
{
"name": "district",
"displayName": "district",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Nome do bairro do cliente.",
"key": "district"
}
],
"key": "address"
}
]
}
}
/clients post
POST: /clients
Via método post é possível adicionar um cliente.
Header Parameters
Authorization
Utilize esse campo para enviar um token válido. Inicie o preenchimento do campo com o termo
Bearer
e em seguida o token.
Property | Value |
---|---|
required | true |
type | string |
examples |
Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
|
Content-Type
Neste campo apenas preencha
application/json
Property | Value |
---|---|
required | true |
type | string |
examples |
application/json
|
Possible Responses
200, 401, 404, 417, 422, 500
/clients post
CURL EXAMPLE
curl -X POST "api.contapay.me/v1/clients" \
-H "Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6" \
-H "Content-Type: application/json" \
-d @request_body
REQUEST HEADERS
Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
Content-Type: application/json
REQUEST BODY
{
"name": "John Doe",
"phone": "(88) 88888-8888",
"email": "[email protected]",
"person_id": "111.222.333-44",
"address": {
"zip_code": "88888-888",
"street": "RUA 88",
"number": "888",
"complement": "APTO 888",
"district": "Meu bairro",
"city": "Minha cidade",
"uf": "MG"
}
}
Type
{
"name": "type",
"displayName": "type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "name",
"displayName": "name",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Nome do cliente.",
"key": "name"
},
{
"name": "phone",
"displayName": "phone",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Número de telefone do cliente.",
"key": "phone"
},
{
"name": "email",
"displayName": "email",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "E-mail do cliente.",
"key": "email"
},
{
"name": "person_id",
"displayName": "person_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "CPF ou CNPJ do cliente.",
"key": "person_id"
},
{
"name": "address",
"displayName": "address",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"required": false,
"description": "Objeto JSON de endereço do cliente.",
"properties": [
{
"name": "zip_code",
"displayName": "zip_code",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": false,
"description": "CEP do endereço do cliente.",
"key": "zip_code"
},
{
"name": "street",
"displayName": "street",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": false,
"description": "Nome da rua do cliente.",
"key": "street"
},
{
"name": "number",
"displayName": "number",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": false,
"description": "Número da casa do cliente.",
"key": "number"
},
{
"name": "complement",
"displayName": "complement",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": false,
"description": "Informação complementar ao endereço do cliente.",
"key": "complement"
},
{
"name": "district",
"displayName": "district",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": false,
"description": "Nome do bairro do cliente.",
"key": "district"
},
{
"name": "city",
"displayName": "city",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": false,
"description": "Nome da cidade do cliente.",
"key": "city"
},
{
"name": "uf",
"displayName": "uf",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": false,
"description": "Nome do estado do cliente.",
"key": "uf"
}
],
"key": "address"
}
]
}
RESPONSE BODY
{
"client_id": "678fdf60f09b909c910d95cc43d81a4660221760f463ffa63e2e51be41bc78b8",
"name": "John Doe",
"phone": "(88) 88888-8888",
"email": "[email protected]",
"person_id": "111.222.333-44",
"address": {
"zip_code": "88888-888",
"street": "RUA 88",
"number": "888",
"complement": "APTO 888",
"district": "Meu bairro"
}
}
Type
{
"name": "type",
"displayName": "type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "client_id",
"displayName": "client_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único do cliente. Gerado automaticamente pelo sistema.",
"key": "client_id"
},
{
"name": "name",
"displayName": "name",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Nome do cliente.",
"key": "name"
},
{
"name": "phone",
"displayName": "phone",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Número de telefone do cliente.",
"key": "phone"
},
{
"name": "email",
"displayName": "email",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "E-mail do cliente.",
"key": "email"
},
{
"name": "person_id",
"displayName": "person_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "CPF ou CNPJ do cliente.",
"key": "person_id"
},
{
"name": "address",
"displayName": "address",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"required": true,
"description": "Objeto JSON de endereço do cliente.",
"properties": [
{
"name": "zip_code",
"displayName": "zip_code",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "CEP do endereço do cliente.",
"key": "zip_code"
},
{
"name": "street",
"displayName": "street",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Nome da rua do cliente.",
"key": "street"
},
{
"name": "number",
"displayName": "number",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Número da casa do cliente.",
"key": "number"
},
{
"name": "complement",
"displayName": "complement",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Informação complementar ao endereço do cliente.",
"key": "complement"
},
{
"name": "district",
"displayName": "district",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Nome do bairro do cliente.",
"key": "district"
}
],
"key": "address"
}
]
}
(clientId) representa o ID de um cliente. Deve ser passado via método GET.
/{clientId} get
GET: /clients/{clientId}
Retorna os dados de um cliente específico pertencente a uma empresa.
(clientId)
URI Parameters
clientId
Property | Value |
---|---|
required | true |
type | string |
Header Parameters
Authorization
Utilize esse campo para enviar um token válido. Inicie o preenchimento do campo com o termo
Bearer
e em seguida o token.
Property | Value |
---|---|
required | true |
type | string |
examples |
Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
|
Content-Type
Neste campo apenas preencha
application/json
Property | Value |
---|---|
required | true |
type | string |
examples |
application/json
|
Query Parameters
(clientId)
Identificador exlclusivo de um cliente (ID). Contém 64 caracteres alfanuméricos. Na URL substitua (clientId) pelo ID de um cliente antes de iniciar a requisição.
Property | Value |
---|---|
required | false |
type | string |
examples |
a0bd94956b9f42cde97b95b10ad65bbaf2a8d87142caf819e4c099ed75126d72
|
Possible Responses
200, 400, 401, 404, 417, 500
/{clientId} get
CURL EXAMPLE
curl -X GET "api.contapay.me/v1/clients/{clientId}?(clientId)=a0bd94956b9f42cde97b95b10ad65bbaf2a8d87142caf819e4c099ed75126d72" \
-H "Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6" \
-H "Content-Type: application/json"
REQUEST HEADERS
Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
Content-Type: application/json
RESPONSE BODY
{
"client_id": "678fdf60f09b909c910d95cc43d81a4660221760f463ffa63e2e51be41bc78b8",
"name": "John Doe",
"phone": "(88) 88888-8888",
"email": "[email protected]",
"person_id": "111.222.333-44",
"address": {
"zip_code": "88888-888",
"street": "RUA 88",
"number": "888",
"complement": "APTO 888",
"district": "Meu bairro"
}
}
Type
{
"name": "type",
"displayName": "type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "client_id",
"displayName": "client_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de um cliente",
"key": "client_id"
},
{
"name": "name",
"displayName": "name",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Nome do cliente.",
"key": "name"
},
{
"name": "phone",
"displayName": "phone",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Número de telefone do cliente.",
"key": "phone"
},
{
"name": "email",
"displayName": "email",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "E-mail do cliente.",
"key": "email"
},
{
"name": "person_id",
"displayName": "person_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "CPF ou CNPJ do cliente.",
"key": "person_id"
},
{
"name": "address",
"displayName": "address",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"required": true,
"description": "Objeto JSON de endereço do cliente.",
"properties": [
{
"name": "zip_code",
"displayName": "zip_code",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "CEP do endereço do cliente.",
"key": "zip_code"
},
{
"name": "street",
"displayName": "street",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Nome da rua do cliente.",
"key": "street"
},
{
"name": "number",
"displayName": "number",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Número da casa do cliente.",
"key": "number"
},
{
"name": "complement",
"displayName": "complement",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Informação complementar ao endereço do cliente.",
"key": "complement"
},
{
"name": "district",
"displayName": "district",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Nome do bairro do cliente.",
"key": "district"
}
],
"key": "address"
}
]
}
/{clientId} put
PUT: /clients/{clientId}
Atualiza os dados de um cliente específico pertencente a uma empresa.
URI Parameters
clientId
Property | Value |
---|---|
required | true |
type | string |
Header Parameters
Authorization
Utilize esse campo para enviar um token válido. Inicie o preenchimento do campo com o termo
Bearer
e em seguida o token.
Property | Value |
---|---|
required | true |
type | string |
examples |
Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
|
Content-Type
Neste campo apenas preencha
application/json
Property | Value |
---|---|
required | true |
type | string |
examples |
application/json
|
Query Parameters
(clientId)
Identificador exlclusivo de um cliente (ID). Contém 64 caracteres alfanuméricos. Na URL substitua (clientId) pelo ID de um cliente antes de iniciar a requisição.
Property | Value |
---|---|
required | false |
type | string |
examples |
a0bd94956b9f42cde97b95b10ad65bbaf2a8d87142caf819e4c099ed75126d72
|
Possible Responses
201, 400, 401, 404, 417, 422, 500
/{clientId} put
CURL EXAMPLE
curl -X PUT "api.contapay.me/v1/clients/{clientId}?(clientId)=a0bd94956b9f42cde97b95b10ad65bbaf2a8d87142caf819e4c099ed75126d72" \
-H "Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6" \
-H "Content-Type: application/json" \
-d @request_body
REQUEST HEADERS
Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
Content-Type: application/json
RESPONSE BODY
{
"client_id": "678fdf60f09b909c910d95cc43d81a4660221760f463ffa63e2e51be41bc78b8",
"name": "John Doe",
"phone": "(88) 88888-8888",
"email": "[email protected]",
"person_id": "111.222.333-44",
"address": {
"zip_code": "88888-888",
"street": "RUA 88",
"number": "888",
"complement": "APTO 888",
"district": "Meu bairro"
}
}
Type
{
"name": "type",
"displayName": "type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "client_id",
"displayName": "client_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de um cliente. Esse é gerado automaticamente pelo sistema.",
"key": "client_id"
},
{
"name": "name",
"displayName": "name",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Nome do cliente.",
"key": "name"
},
{
"name": "phone",
"displayName": "phone",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Número de telefone do cliente.",
"key": "phone"
},
{
"name": "email",
"displayName": "email",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "E-mail do cliente.",
"key": "email"
},
{
"name": "person_id",
"displayName": "person_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "CPF ou CNPJ do cliente.",
"key": "person_id"
},
{
"name": "address",
"displayName": "address",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"required": true,
"description": "Objeto JSON de endereço do cliente.",
"properties": [
{
"name": "zip_code",
"displayName": "zip_code",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "CEP do endereço do cliente.",
"key": "zip_code"
},
{
"name": "street",
"displayName": "street",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Nome da rua do cliente.",
"key": "street"
},
{
"name": "number",
"displayName": "number",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Número da casa do cliente.",
"key": "number"
},
{
"name": "complement",
"displayName": "complement",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Informação complementar ao endereço do cliente.",
"key": "complement"
},
{
"name": "district",
"displayName": "district",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Nome do bairro do cliente.",
"key": "district"
}
],
"key": "address"
}
]
}
/{clientId} delete
DELETE: /clients/{clientId}
Apaga os dados de um cliente específico pertencente a uma empresa.
URI Parameters
clientId
Property | Value |
---|---|
required | true |
type | string |
Header Parameters
Authorization
Utilize esse campo para enviar um token válido. Inicie o preenchimento do campo com o termo
Bearer
e em seguida o token.
Property | Value |
---|---|
required | true |
type | string |
examples |
Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
|
Content-Type
Neste campo apenas preencha
application/json
Property | Value |
---|---|
required | true |
type | string |
examples |
application/json
|
Query Parameters
(clientId)
Identificador exlclusivo de um cliente (ID). Contém 64 caracteres alfanuméricos. Na URL substitua (clientId) pelo ID de um cliente antes de iniciar a requisição.
Property | Value |
---|---|
required | false |
type | string |
examples |
a0bd94956b9f42cde97b95b10ad65bbaf2a8d87142caf819e4c099ed75126d72
|
Possible Responses
200, 400, 401, 404, 417, 500
/{clientId} delete
CURL EXAMPLE
curl -X DELETE "api.contapay.me/v1/clients/{clientId}?(clientId)=a0bd94956b9f42cde97b95b10ad65bbaf2a8d87142caf819e4c099ed75126d72" \
-H "Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6" \
-H "Content-Type: application/json"
REQUEST HEADERS
Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
Content-Type: application/json
RESPONSE BODY
{
"response": [
"O cliente foi excluído com sucesso."
]
}
Type
{
"name": "type",
"displayName": "type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "response",
"displayName": "response",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "array",
"required": true,
"description": "O cliente com o ID informado foi encontrado e excluído no sistema.",
"items": {
"name": "items",
"displayName": "items",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string"
},
"minItems": 1,
"maxItems": 1,
"key": "response"
}
]
}
/billings
Coleção de cobranças emitidas por uma empresa.
invoices
= Array de parcelas. Cada parcela contém as informações referentes a um boleto.
instructions
= Instruções geradas pelo sistema à respeito de juros, multa e desconto aplicados a um boleto. Essas instruções são geradas automaticamente pelo sistema e leva em consideração os valores previamente configurados pela empresa no sistema ContaPay.
demonstrative
= Mensagem personalizada que a empresa pode inserir no boleto.
/billings get
GET: /billings
Retorna todas as cobranças emitidas por uma empresa.
Header Parameters
Authorization
Utilize esse campo para enviar um token válido. Inicie o preenchimento do campo com o termo
Bearer
e em seguida o token.
Property | Value |
---|---|
required | true |
type | string |
examples |
Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
|
Content-Type
Neste campo apenas preencha
application/json
Property | Value |
---|---|
required | true |
type | string |
examples |
application/json
|
Possible Responses
200, 401, 404, 417, 500
/billings get
CURL EXAMPLE
curl -X GET "api.contapay.me/v1/billings" \
-H "Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6" \
-H "Content-Type: application/json"
REQUEST HEADERS
Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
Content-Type: application/json
RESPONSE BODY
[
{
"billing": "0341b5dd628e639abaa6a2a7affb6e8905dc4a0065309f69c67456473483c9dd",
"internal_code": "f0268",
"description": "Lorem Ipsum",
"client_id": "678fdf60f09b909c910d95cc43d81a4660221760f463ffa63e2e51be41bc78b8",
"installment": "1",
"amount": "50.00",
"created": {
"date": "2017-12-27 18:24:41.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"updated": {
"date": "2017-12-27 18:24:41.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"invoices": [
{
"invoice_id": "be322fb77d654ad524a7fc2d66e1dc74dde39e544b5a189ef09f5c8aafc6ab3b",
"billing_id": "0341b5dd628e639abaa6a2a7affb6e8905dc4a0065309f69c67456473483c9dd",
"client_id": "678fdf60f09b909c910d95cc43d81a4660221760f463ffa63e2e51be41bc78b8",
"document_number": 1696,
"installment_number": 1,
"due_date": "2017-12-28",
"payment_date": null,
"discount_deadline_date": null,
"paid": 0,
"value": "50.00",
"amount_paid": null,
"instructions": [
""
],
"demonstrative": [
""
],
"assessment": "",
"interest": "",
"discount": null,
"barcode": "23793049226000000016096003466503273870000001000",
"ticket_url": "https://app.contapay.me/invoice/view/2162d44d9e0ba955a1619434096fd25a34c573c2d55ab0279ee1a1a2b310c8e0be322fb77d654ad524a7fc2d66e1dc74dde39e544b5a189ef09f5c8aafc6ab3b"
}
]
}
]
Type
{
"name": "type",
"displayName": "type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "array",
"items": {
"name": "items",
"displayName": "items",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "billing",
"displayName": "billing",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de uma cobrança. Esse é gerado automaticamente pelo sistema.",
"key": "billing"
},
{
"name": "internal_code",
"displayName": "internal_code",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador para controle interno da empresa utilizadora da API ContaPay. Deve ser enviado na requisição de criação de uma cobrança. Ele suporta no máximo 20 caracteres.",
"key": "internal_code"
},
{
"name": "description",
"displayName": "description",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Breve descrição da cobrança criada.",
"key": "description"
},
{
"name": "client_id",
"displayName": "client_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de um cliente",
"key": "client_id"
},
{
"name": "installment",
"displayName": "installment",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Quantidade de parcelas atribuída a uma cobrança.",
"key": "installment"
},
{
"name": "amount",
"displayName": "amount",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "double",
"required": true,
"description": "Valor total de uma cobrança. Corresponde ao somatório dos valores de todas as parcelas de uma cobrança.",
"key": "amount"
},
{
"name": "created",
"displayName": "created",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"required": true,
"description": "Objeto de data de criação de uma cobrança.",
"properties": [
{
"name": "date",
"displayName": "date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"description": "Data e horário de criação de uma cobrança.",
"key": "date"
},
{
"name": "timezone_type",
"displayName": "timezone_type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Valor numérico do fuso horário da data de criação de uma cobrança.",
"key": "timezone_type"
},
{
"name": "timezone",
"displayName": "timezone",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Fuso Horário de referência. Exemplos: UTC, GMT, etc.",
"key": "timezone"
}
],
"key": "created"
},
{
"name": "updated",
"displayName": "updated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"required": true,
"description": "Objeto de data de atualização de uma cobrança.",
"properties": [
{
"name": "date",
"displayName": "date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"description": "Data e horário de atualização de uma cobrança.",
"key": "date"
},
{
"name": "timezone_type",
"displayName": "timezone_type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Valor numérico do fuso horário da data de atualização de uma cobrança.",
"key": "timezone_type"
},
{
"name": "timezone",
"displayName": "timezone",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Fuso Horário de referência. Exemplos: UTC, GMT, etc.",
"key": "timezone"
}
],
"key": "updated"
},
{
"name": "invoices",
"displayName": "invoices",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "array",
"required": true,
"description": "Array de informações de uma parcela.",
"items": {
"name": "items",
"displayName": "items",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "invoice_id",
"displayName": "invoice_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de uma parcela. Esse é gerado automaticamente pelo sistema.",
"key": "invoice_id"
},
{
"name": "billing_id",
"displayName": "billing_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de uma cobrança. Esse é gerado automaticamente pelo sistema.",
"key": "billing_id"
},
{
"name": "client_id",
"displayName": "client_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de um cliente. Esse é gerado automaticamente pelo sistema.",
"key": "client_id"
},
{
"name": "document_number",
"displayName": "document_number",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Número do documento.",
"key": "document_number"
},
{
"name": "installment_number",
"displayName": "installment_number",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Número da parcela.",
"key": "installment_number"
},
{
"name": "due_date",
"displayName": "due_date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"description": "Data de vencimento de uma parcela.",
"key": "due_date"
},
{
"name": "payment_date",
"displayName": "payment_date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"description": "Data de pagamento de uma parcela.",
"key": "payment_date"
},
{
"name": "discount_deadline_date",
"displayName": "discount_deadline_date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"description": "Data final para recebimento de um desconto para uma parcela.",
"key": "discount_deadline_date"
},
{
"name": "paid",
"displayName": "paid",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Indicação de pagamento efetuado.",
"key": "paid"
},
{
"name": "value",
"displayName": "value",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Valor de uma parcela.",
"key": "value"
},
{
"name": "amount_paid",
"displayName": "amount_paid",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Valor total pago.",
"key": "amount_paid"
},
{
"name": "instructions",
"displayName": "instructions",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "array",
"required": true,
"items": {
"name": "items",
"displayName": "items",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string"
},
"key": "instructions"
},
{
"name": "demonstrative",
"displayName": "demonstrative",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "array",
"required": true,
"items": {
"name": "items",
"displayName": "items",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string"
},
"key": "demonstrative"
},
{
"name": "assessment",
"displayName": "assessment",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Porcentagem de multa.",
"key": "assessment"
},
{
"name": "interest",
"displayName": "interest",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Porcentagem de juros.",
"key": "interest"
},
{
"name": "discount",
"displayName": "discount",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Porcentagem de desconto.",
"key": "discount"
},
{
"name": "barcode",
"displayName": "barcode",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Código de barras.",
"key": "barcode"
},
{
"name": "ticket_url",
"displayName": "ticket_url",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "URL da parcela.",
"key": "ticket_url"
}
]
},
"key": "invoices"
}
]
}
}
/billings post
POST: /billings
Via método post é possível adicionar uma cobrança.
Header Parameters
Authorization
Utilize esse campo para enviar um token válido. Inicie o preenchimento do campo com o termo
Bearer
e em seguida o token.
Property | Value |
---|---|
required | true |
type | string |
examples |
Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
|
Content-Type
Neste campo apenas preencha
application/json
Property | Value |
---|---|
required | true |
type | string |
examples |
application/json
|
Possible Responses
200, 401, 404, 417, 422, 500
/billings post
CURL EXAMPLE
curl -X POST "api.contapay.me/v1/billings" \
-H "Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6" \
-H "Content-Type: application/json" \
-d @request_body
REQUEST HEADERS
Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
Content-Type: application/json
REQUEST BODY
{
"description": "Cobranca de serviços web",
"internal_code": "f0268",
"client_id": "a0bd94956b9f42cde97b95b10ad65bbaf2a8d87142caf819e4c099ed75126d72",
"installment": "2",
"amount": "200",
"invoices": [
{
"due_date": "2018-10-10",
"value": "100",
"assessment": "5",
"interest": "2",
"discount": "1",
"days_discount": "5",
"demonstrative": ["Há debitos em atraso", "Não receber após o vencimento"]
},
{
"due_date": "2018-10-02",
"value": "100",
"assessment": "0",
"interest": "0",
"discount": "0",
"days_discount": "10",
"demonstrative": ["Há debitos em atraso"]
}
]
}
Type
{
"name": "type",
"displayName": "type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "array",
"items": {
"name": "items",
"displayName": "items",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "description",
"displayName": "description",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"key": "description"
},
{
"name": "internal_code",
"displayName": "internal_code",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"key": "internal_code"
},
{
"name": "client_id",
"displayName": "client_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"key": "client_id"
},
{
"name": "installment",
"displayName": "installment",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"key": "installment"
},
{
"name": "amount",
"displayName": "amount",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "double",
"required": true,
"key": "amount"
},
{
"name": "invoices",
"displayName": "invoices",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "array",
"required": true,
"items": {
"name": "items",
"displayName": "items",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "due_date",
"displayName": "due_date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"key": "due_date"
},
{
"name": "value",
"displayName": "value",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "double",
"required": true,
"key": "value"
},
{
"name": "assessment",
"displayName": "assessment",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"key": "assessment"
},
{
"name": "interest",
"displayName": "interest",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"key": "interest"
},
{
"name": "discount",
"displayName": "discount",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"key": "discount"
},
{
"name": "days_discount",
"displayName": "days_discount",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "integer",
"required": true,
"key": "days_discount"
},
{
"name": "demonstrative",
"displayName": "demonstrative",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "array",
"required": true,
"items": {
"name": "items",
"displayName": "items",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string"
},
"key": "demonstrative"
}
]
},
"key": "invoices"
}
]
}
}
RESPONSE BODY
{
"billing": "dc7b81fd2fff7f765c9db9420b55a09a31f1ec49492aab0ebc8739ba5c20312f",
"internal_code": "f0268",
"description": "Cobranca de serviços web",
"client_id": "a0bd94956b9f42cde97b95b10ad65bbaf2a8d87142caf819e4c099ed75126d72",
"installment": "2",
"amount": "200.00",
"created": {
"date": "2018-01-31 18:24:55.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"updated": {
"date": "2018-01-31 18:24:55.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"invoices": [
{
"invoice_id": "3921a7d7066d4666f3e7e9874ab7832eed2f4bcabdd2af8f081c0dedd953779b",
"billing_id": 2303,
"client_id": "a0bd94956b9f42cde97b95b10ad65bbaf2a8d87142caf819e4c099ed75126d72",
"document_number": 2427,
"installment_number": null,
"due_date": "2018-10-10",
"payment_date": null,
"discount_deadline_date": "2018-10-05",
"paid": 0,
"value": "100.00",
"amount_paid": null,
"instructions": [
"Após o vencimento cobrar multa de 5%",
"Até 5 dias antes do vencimento conceder desconto de 1%",
"Após o vencimento cobrar juro de mora de 2% ao mês"
],
"demonstrative": [
"Há debitos em atraso",
"Não receber após o vencimento"
],
"assessment": "5",
"interest": "2",
"discount": "1",
"barcode": null,
"ticket_url": "https://app.contapay.me/invoice/view/2162d44d9e0ba955a1619434096fd25a34c573c2d55ab0279ee1a1a2b310c8e03921a7d7066d4666f3e7e9874ab7832eed2f4bcabdd2af8f081c0dedd953779b"
},
{
"invoice_id": "a025f0314b164d72f92e11bd860ebbc0558addbeb5cf3ae1f06c4eded1d63ddc",
"billing_id": 2303,
"client_id": 1770,
"document_number": 2428,
"installment_number": null,
"due_date": "2018-10-02",
"payment_date": null,
"discount_deadline_date": "2018-09-22",
"paid": 0,
"value": "100.00",
"amount_paid": null,
"instructions": [
""
],
"demonstrative": [
"Há debitos em atraso",
"Feliz 2018"
],
"assessment": "0",
"interest": "0",
"discount": "0",
"barcode": null,
"ticket_url": "https://app.contapay.me/invoice/view/2162d44d9e0ba955a1619434096fd25a34c573c2d55ab0279ee1a1a2b310c8e0a025f0314b164d72f92e11bd860ebbc0558addbeb5cf3ae1f06c4eded1d63ddc"
}
]
}
Type
{
"name": "type",
"displayName": "type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "billing",
"displayName": "billing",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de uma cobrança. Esse é gerado automaticamente pelo sistema.",
"key": "billing"
},
{
"name": "internal_code",
"displayName": "internal_code",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador para controle interno da empresa utilizadora da API ContaPay. Deve ser enviado na requisição de criação de uma cobrança. Ele suporta no máximo 20 caracteres.",
"key": "internal_code"
},
{
"name": "description",
"displayName": "description",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Breve descrição da cobrança criada.",
"key": "description"
},
{
"name": "client_id",
"displayName": "client_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de um cliente",
"key": "client_id"
},
{
"name": "installment",
"displayName": "installment",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Quantidade de parcelas atribuída a uma cobrança.",
"key": "installment"
},
{
"name": "amount",
"displayName": "amount",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "double",
"required": true,
"description": "Valor total de uma cobrança. Corresponde ao somatório dos valores de todas as parcelas de uma cobrança.",
"key": "amount"
},
{
"name": "created",
"displayName": "created",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"required": true,
"description": "Objeto de data de criação de uma cobrança.",
"properties": [
{
"name": "date",
"displayName": "date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"description": "Data e horário de criação de uma cobrança.",
"key": "date"
},
{
"name": "timezone_type",
"displayName": "timezone_type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Valor numérico do fuso horário da data de criação de uma cobrança.",
"key": "timezone_type"
},
{
"name": "timezone",
"displayName": "timezone",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Fuso Horário de referência. Exemplos: UTC, GMT, etc.",
"key": "timezone"
}
],
"key": "created"
},
{
"name": "updated",
"displayName": "updated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"required": true,
"description": "Objeto de data de atualização de uma cobrança.",
"properties": [
{
"name": "date",
"displayName": "date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"description": "Data e horário de atualização de uma cobrança.",
"key": "date"
},
{
"name": "timezone_type",
"displayName": "timezone_type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Valor numérico do fuso horário da data de atualização de uma cobrança.",
"key": "timezone_type"
},
{
"name": "timezone",
"displayName": "timezone",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Fuso Horário de referência. Exemplos: UTC, GMT, etc.",
"key": "timezone"
}
],
"key": "updated"
},
{
"name": "invoices",
"displayName": "invoices",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "array",
"required": true,
"description": "Array de informações de uma parcela.",
"items": {
"name": "items",
"displayName": "items",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "invoice_id",
"displayName": "invoice_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de uma parcela. Esse é gerado automaticamente pelo sistema.",
"key": "invoice_id"
},
{
"name": "billing_id",
"displayName": "billing_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de uma cobrança. Esse é gerado automaticamente pelo sistema.",
"key": "billing_id"
},
{
"name": "client_id",
"displayName": "client_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de um cliente. Esse é gerado automaticamente pelo sistema.",
"key": "client_id"
},
{
"name": "document_number",
"displayName": "document_number",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Número do documento.",
"key": "document_number"
},
{
"name": "installment_number",
"displayName": "installment_number",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Número da parcela.",
"key": "installment_number"
},
{
"name": "due_date",
"displayName": "due_date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"description": "Data de vencimento de uma parcela.",
"key": "due_date"
},
{
"name": "payment_date",
"displayName": "payment_date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"description": "Data de pagamento de uma parcela.",
"key": "payment_date"
},
{
"name": "discount_deadline_date",
"displayName": "discount_deadline_date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"description": "Data final para recebimento de um desconto para uma parcela.",
"key": "discount_deadline_date"
},
{
"name": "paid",
"displayName": "paid",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Indicação de pagamento efetuado.",
"key": "paid"
},
{
"name": "value",
"displayName": "value",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Valor de uma parcela.",
"key": "value"
},
{
"name": "amount_paid",
"displayName": "amount_paid",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Valor total pago.",
"key": "amount_paid"
},
{
"name": "instructions",
"displayName": "instructions",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "array",
"required": true,
"items": {
"name": "items",
"displayName": "items",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string"
},
"key": "instructions"
},
{
"name": "demonstrative",
"displayName": "demonstrative",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "array",
"required": true,
"items": {
"name": "items",
"displayName": "items",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string"
},
"key": "demonstrative"
},
{
"name": "assessment",
"displayName": "assessment",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Porcentagem de multa.",
"key": "assessment"
},
{
"name": "interest",
"displayName": "interest",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Porcentagem de juros.",
"key": "interest"
},
{
"name": "discount",
"displayName": "discount",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Porcentagem de desconto.",
"key": "discount"
},
{
"name": "barcode",
"displayName": "barcode",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Código de barras.",
"key": "barcode"
},
{
"name": "ticket_url",
"displayName": "ticket_url",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "URL da parcela.",
"key": "ticket_url"
}
]
},
"key": "invoices"
}
]
}
{billingId} representa o ID de uma cobrança. Deve ser passado via método GET.
/{billingId} get
GET: /billings/{billingId}
Retorna os dados de uma cobrança específica.
URI Parameters
billingId
Property | Value |
---|---|
required | true |
type | string |
Header Parameters
Authorization
Utilize esse campo para enviar um token válido. Inicie o preenchimento do campo com o termo
Bearer
e em seguida o token.
Property | Value |
---|---|
required | true |
type | string |
examples |
Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
|
Content-Type
Neste campo apenas preencha
application/json
Property | Value |
---|---|
required | true |
type | string |
examples |
application/json
|
Query Parameters
billingId
Identificador exlclusivo de uma cobrança (ID). Na URL substitua {billingId} pelo ID de uma cobrança antes de iniciar a requisição.
Property | Value |
---|---|
required | false |
type | string |
examples |
b4c8ac20a87e493a3dd30a6f16094149771660c1ae17fbab1e4adfef86c76091
|
Possible Responses
200, 400, 401, 404, 417, 500
/{billingId} get
CURL EXAMPLE
curl -X GET "api.contapay.me/v1/billings/{billingId}?billingId=b4c8ac20a87e493a3dd30a6f16094149771660c1ae17fbab1e4adfef86c76091" \
-H "Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6" \
-H "Content-Type: application/json"
REQUEST HEADERS
Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
Content-Type: application/json
RESPONSE BODY
{
"billing": "0341b5dd628e639abaa6a2a7affb6e8905dc4a0065309f69c67456473483c9dd",
"internal_code": "f0268",
"description": "Lorem Ipsum",
"client_id": "678fdf60f09b909c910d95cc43d81a4660221760f463ffa63e2e51be41bc78b8",
"installment": "1",
"amount": "50.00",
"created": {
"date": "2017-12-27 18:24:41.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"updated": {
"date": "2017-12-27 18:24:41.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"invoices": [
{
"invoice_id": "be322fb77d654ad524a7fc2d66e1dc74dde39e544b5a189ef09f5c8aafc6ab3b",
"billing_id": "0341b5dd628e639abaa6a2a7affb6e8905dc4a0065309f69c67456473483c9dd",
"client_id": "678fdf60f09b909c910d95cc43d81a4660221760f463ffa63e2e51be41bc78b8",
"document_number": 1696,
"installment_number": 1,
"due_date": "2017-12-28",
"payment_date": null,
"discount_deadline_date": null,
"paid": 0,
"value": "50.00",
"amount_paid": null,
"instructions": [
""
],
"demonstrative": [
""
],
"assessment": "",
"interest": "",
"discount": null,
"barcode": "23793049226000000016096003466503273870000001000",
"ticket_url": "https://app.contapay.me/invoice/view/2162d44d9e0ba955a1619434096fd25a34c573c2d55ab0279ee1a1a2b310c8e0be322fb77d654ad524a7fc2d66e1dc74dde39e544b5a189ef09f5c8aafc6ab3b"
}
]
}
Type
{
"name": "type",
"displayName": "type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "billing",
"displayName": "billing",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de uma cobrança. Esse é gerado automaticamente pelo sistema.",
"key": "billing"
},
{
"name": "internal_code",
"displayName": "internal_code",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador para controle interno da empresa utilizadora da API ContaPay. Deve ser enviado na requisição de criação de uma cobrança. Ele suporta no máximo 20 caracteres.",
"key": "internal_code"
},
{
"name": "description",
"displayName": "description",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Breve descrição da cobrança criada.",
"key": "description"
},
{
"name": "client_id",
"displayName": "client_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de um cliente",
"key": "client_id"
},
{
"name": "installment",
"displayName": "installment",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Quantidade de parcelas atribuída a uma cobrança.",
"key": "installment"
},
{
"name": "amount",
"displayName": "amount",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "double",
"required": true,
"description": "Valor total de uma cobrança. Corresponde ao somatório dos valores de todas as parcelas de uma cobrança.",
"key": "amount"
},
{
"name": "created",
"displayName": "created",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"required": true,
"description": "Objeto de data de criação de uma cobrança.",
"properties": [
{
"name": "date",
"displayName": "date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"description": "Data e horário de criação de uma cobrança.",
"key": "date"
},
{
"name": "timezone_type",
"displayName": "timezone_type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Valor numérico do fuso horário da data de criação de uma cobrança.",
"key": "timezone_type"
},
{
"name": "timezone",
"displayName": "timezone",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Fuso Horário de referência. Exemplos: UTC, GMT, etc.",
"key": "timezone"
}
],
"key": "created"
},
{
"name": "updated",
"displayName": "updated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"required": true,
"description": "Objeto de data de atualização de uma cobrança.",
"properties": [
{
"name": "date",
"displayName": "date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"description": "Data e horário de atualização de uma cobrança.",
"key": "date"
},
{
"name": "timezone_type",
"displayName": "timezone_type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Valor numérico do fuso horário da data de atualização de uma cobrança.",
"key": "timezone_type"
},
{
"name": "timezone",
"displayName": "timezone",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Fuso Horário de referência. Exemplos: UTC, GMT, etc.",
"key": "timezone"
}
],
"key": "updated"
},
{
"name": "invoices",
"displayName": "invoices",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "array",
"required": true,
"description": "Array de informações de uma parcela.",
"items": {
"name": "items",
"displayName": "items",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "invoice_id",
"displayName": "invoice_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de uma parcela. Esse é gerado automaticamente pelo sistema.",
"key": "invoice_id"
},
{
"name": "billing_id",
"displayName": "billing_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de uma cobrança. Esse é gerado automaticamente pelo sistema.",
"key": "billing_id"
},
{
"name": "client_id",
"displayName": "client_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de um cliente. Esse é gerado automaticamente pelo sistema.",
"key": "client_id"
},
{
"name": "document_number",
"displayName": "document_number",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Número do documento.",
"key": "document_number"
},
{
"name": "installment_number",
"displayName": "installment_number",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Número da parcela.",
"key": "installment_number"
},
{
"name": "due_date",
"displayName": "due_date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"description": "Data de vencimento de uma parcela.",
"key": "due_date"
},
{
"name": "payment_date",
"displayName": "payment_date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"description": "Data de pagamento de uma parcela.",
"key": "payment_date"
},
{
"name": "discount_deadline_date",
"displayName": "discount_deadline_date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"description": "Data final para recebimento de um desconto para uma parcela.",
"key": "discount_deadline_date"
},
{
"name": "paid",
"displayName": "paid",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Indicação de pagamento efetuado.",
"key": "paid"
},
{
"name": "value",
"displayName": "value",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Valor de uma parcela.",
"key": "value"
},
{
"name": "amount_paid",
"displayName": "amount_paid",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Valor total pago.",
"key": "amount_paid"
},
{
"name": "instructions",
"displayName": "instructions",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "array",
"required": true,
"items": {
"name": "items",
"displayName": "items",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string"
},
"key": "instructions"
},
{
"name": "demonstrative",
"displayName": "demonstrative",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "array",
"required": true,
"items": {
"name": "items",
"displayName": "items",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string"
},
"key": "demonstrative"
},
{
"name": "assessment",
"displayName": "assessment",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Porcentagem de multa.",
"key": "assessment"
},
{
"name": "interest",
"displayName": "interest",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Porcentagem de juros.",
"key": "interest"
},
{
"name": "discount",
"displayName": "discount",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Porcentagem de desconto.",
"key": "discount"
},
{
"name": "barcode",
"displayName": "barcode",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Código de barras.",
"key": "barcode"
},
{
"name": "ticket_url",
"displayName": "ticket_url",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "URL da parcela.",
"key": "ticket_url"
}
]
},
"key": "invoices"
}
]
}
{invoiceId} representa o ID de um boleto (parcela).
/{invoiceId} put
PUT: /billings/{invoiceId}
Emite a segunda via de um boleto.
URI Parameters
invoiceId
Property | Value |
---|---|
required | true |
type | string |
Header Parameters
Authorization
Utilize esse campo para enviar um token válido. Inicie o preenchimento do campo com o termo
Bearer
e em seguida o token.
Property | Value |
---|---|
required | true |
type | string |
examples |
Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
|
Content-Type
Neste campo apenas preencha
application/json
Property | Value |
---|---|
required | true |
type | string |
examples |
application/json
|
Query Parameters
(invoiceId)
Identificador exlclusivo de uma cobrança (ID). Na URL substitua {invoiceId} pelo ID de uma parcela antes de iniciar a requisição.
Property | Value |
---|---|
required | false |
type | string |
examples |
a0bd94956b9f42cde97b95b10ad65bbaf2a8d87142caf819e4c099ed75126d72
|
Possible Responses
201, 400, 401, 404, 417, 422, 500
/{invoiceId} put
CURL EXAMPLE
curl -X PUT "api.contapay.me/v1/billings/{invoiceId}?(invoiceId)=a0bd94956b9f42cde97b95b10ad65bbaf2a8d87142caf819e4c099ed75126d72" \
-H "Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6" \
-H "Content-Type: application/json" \
-d @request_body
REQUEST HEADERS
Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
Content-Type: application/json
REQUEST BODY
{
"id": "2f11192801e83bf30f01139f338c5cf52a5e5cdf3e5b7c2d3ef5b051e9fd1fde",
"due_date": "2018-10-10"
}
Type
{
"name": "type",
"displayName": "type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "id",
"displayName": "id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "ID da parcela.",
"key": "id"
},
{
"name": "due_date",
"displayName": "due_date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "date-only",
"required": true,
"description": "Nova data de vencimento.",
"key": "due_date"
}
]
}
RESPONSE BODY
{
"billing": "0341b5dd628e639abaa6a2a7affb6e8905dc4a0065309f69c67456473483c9dd",
"description": "Lorem Ipsum",
"client_id": "678fdf60f09b909c910d95cc43d81a4660221760f463ffa63e2e51be41bc78b8",
"installment": "1",
"amount": "50.00",
"created": {
"date": "2017-12-27 18:24:41.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"updated": {
"date": "2017-12-27 18:24:41.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"invoices": [
{
"invoice_id": "be322fb77d654ad524a7fc2d66e1dc74dde39e544b5a189ef09f5c8aafc6ab3b",
"billing_id": "0341b5dd628e639abaa6a2a7affb6e8905dc4a0065309f69c67456473483c9dd",
"client_id": "678fdf60f09b909c910d95cc43d81a4660221760f463ffa63e2e51be41bc78b8",
"document_number": 1696,
"installment_number": 1,
"due_date": "2017-12-28",
"payment_date": null,
"discount_deadline_date": null,
"paid": 0,
"value": "50.00",
"amount_paid": null,
"instructions": [
""
],
"demonstrative": [
""
],
"assessment": "",
"interest": "",
"discount": null,
"barcode": "23793049226000000016096003466503273870000001000",
"ticket_url": "https://app.contapay.me/invoice/view/2162d44d9e0ba955a1619434096fd25a34c573c2d55ab0279ee1a1a2b310c8e0be322fb77d654ad524a7fc2d66e1dc74dde39e544b5a189ef09f5c8aafc6ab3b"
}
]
}
Type
{
"name": "type",
"displayName": "type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "billing",
"displayName": "billing",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de uma cobrança. Esse é gerado automaticamente pelo sistema.",
"key": "billing"
},
{
"name": "description",
"displayName": "description",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Breve descrição da cobrança criada.",
"key": "description"
},
{
"name": "client_id",
"displayName": "client_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de um cliente",
"key": "client_id"
},
{
"name": "installment",
"displayName": "installment",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Quantidade de parcelas atribuída a uma cobrança.",
"key": "installment"
},
{
"name": "amount",
"displayName": "amount",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Valor total de uma cobrança. Corresponde ao somatório dos valores de todas as parcelas de uma cobrança.",
"key": "amount"
},
{
"name": "created",
"displayName": "created",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"required": true,
"description": "Objeto de data de criação de uma cobrança.",
"properties": [
{
"name": "date",
"displayName": "date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"description": "Data e horário de criação de uma cobrança.",
"key": "date"
},
{
"name": "timezone_type",
"displayName": "timezone_type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Valor numérico do fuso horário da data de criação de uma cobrança.",
"key": "timezone_type"
},
{
"name": "timezone",
"displayName": "timezone",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Fuso Horário de referência. Exemplos: UTC, GMT, etc.",
"key": "timezone"
}
],
"key": "created"
},
{
"name": "updated",
"displayName": "updated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"required": true,
"description": "Objeto de data de atualização de uma cobrança.",
"properties": [
{
"name": "date",
"displayName": "date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"description": "Data e horário de atualização de uma cobrança.",
"key": "date"
},
{
"name": "timezone_type",
"displayName": "timezone_type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Valor numérico do fuso horário da data de atualização de uma cobrança.",
"key": "timezone_type"
},
{
"name": "timezone",
"displayName": "timezone",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Fuso Horário de referência. Exemplos: UTC, GMT, etc.",
"key": "timezone"
}
],
"key": "updated"
},
{
"name": "invoices",
"displayName": "invoices",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "array",
"required": true,
"description": "Array de informações de uma parcela.",
"items": {
"name": "items",
"displayName": "items",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "invoice_id",
"displayName": "invoice_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de uma parcela. Esse é gerado automaticamente pelo sistema.",
"key": "invoice_id"
},
{
"name": "billing_id",
"displayName": "billing_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de uma cobrança. Esse é gerado automaticamente pelo sistema.",
"key": "billing_id"
},
{
"name": "client_id",
"displayName": "client_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de um cliente. Esse é gerado automaticamente pelo sistema.",
"key": "client_id"
},
{
"name": "document_number",
"displayName": "document_number",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Número do documento.",
"key": "document_number"
},
{
"name": "installment_number",
"displayName": "installment_number",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Número da parcela.",
"key": "installment_number"
},
{
"name": "due_date",
"displayName": "due_date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"description": "Data de vencimento de uma parcela.",
"key": "due_date"
},
{
"name": "payment_date",
"displayName": "payment_date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"description": "Data de pagamento de uma parcela.",
"key": "payment_date"
},
{
"name": "discount_deadline_date",
"displayName": "discount_deadline_date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "datetime",
"required": true,
"description": "Data final para recebimento de um desconto para uma parcela.",
"key": "discount_deadline_date"
},
{
"name": "paid",
"displayName": "paid",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Indicação de pagamento efetuado.",
"key": "paid"
},
{
"name": "value",
"displayName": "value",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Valor de uma parcela.",
"key": "value"
},
{
"name": "amount_paid",
"displayName": "amount_paid",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Valor total pago.",
"key": "amount_paid"
},
{
"name": "instructions",
"displayName": "instructions",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "array",
"required": true,
"items": {
"name": "items",
"displayName": "items",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string"
},
"key": "instructions"
},
{
"name": "demonstrative",
"displayName": "demonstrative",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "array",
"required": true,
"items": {
"name": "items",
"displayName": "items",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string"
},
"key": "demonstrative"
},
{
"name": "assessment",
"displayName": "assessment",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Porcentagem de multa.",
"key": "assessment"
},
{
"name": "interest",
"displayName": "interest",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Porcentagem de juros.",
"key": "interest"
},
{
"name": "discount",
"displayName": "discount",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Porcentagem de desconto.",
"key": "discount"
},
{
"name": "barcode",
"displayName": "barcode",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "number",
"required": true,
"description": "Código de barras.",
"key": "barcode"
},
{
"name": "ticket_url",
"displayName": "ticket_url",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "URL da parcela.",
"key": "ticket_url"
}
]
},
"key": "invoices"
}
]
}
/{invoiceId} delete
DELETE: /billings/{invoiceId}
Apaga uma parcela específica.
URI Parameters
invoiceId
Property | Value |
---|---|
required | true |
type | string |
Header Parameters
Authorization
Utilize esse campo para enviar um token válido. Inicie o preenchimento do campo com o termo
Bearer
e em seguida o token.
Property | Value |
---|---|
required | true |
type | string |
examples |
Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
|
Content-Type
Neste campo apenas preencha
application/json
Property | Value |
---|---|
required | true |
type | string |
examples |
application/json
|
Query Parameters
(clientId)
Identificador exlclusivo de um cliente (ID). Contém 64 caracteres alfanuméricos. Na URL substitua (clientId) pelo ID de um cliente antes de iniciar a requisição.
Property | Value |
---|---|
required | false |
type | string |
examples |
a0bd94956b9f42cde97b95b10ad65bbaf2a8d87142caf819e4c099ed75126d72
|
Possible Responses
200, 400, 401, 404, 417, 500
/{invoiceId} delete
CURL EXAMPLE
curl -X DELETE "api.contapay.me/v1/billings/{invoiceId}?(clientId)=a0bd94956b9f42cde97b95b10ad65bbaf2a8d87142caf819e4c099ed75126d72" \
-H "Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6" \
-H "Content-Type: application/json"
REQUEST HEADERS
Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
Content-Type: application/json
RESPONSE BODY
{
"response": [
"O boleto foi excluído com sucesso."
]
}
Type
{
"name": "type",
"displayName": "type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "response",
"displayName": "response",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "array",
"required": true,
"description": "O boleto com o ID informado foi encontrado e excluído no sistema.",
"items": {
"name": "items",
"displayName": "items",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string"
},
"minItems": 1,
"maxItems": 1,
"key": "response"
}
]
}
/emails/{invoiceId}
Reenvia para o cliente um boleto com ID {invoiceId}
/emails/{invoiceId} put
PUT: /emails/{invoiceId}
Reenvia um boleto específico para o cliente.
URI Parameters
invoiceId
Property | Value |
---|---|
required | true |
type | string |
Header Parameters
Authorization
Utilize esse campo para enviar um token válido. Inicie o preenchimento do campo com o termo
Bearer
e em seguida o token.
Property | Value |
---|---|
required | true |
type | string |
examples |
Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
|
Content-Type
Neste campo apenas preencha
application/json
Property | Value |
---|---|
required | true |
type | string |
examples |
application/json
|
Query Parameters
invoiceId
Identificador exlclusivo de um boleto (ID). Na URL substitua {invoiceId} pelo ID de um boleto antes de iniciar a requisição.
Property | Value |
---|---|
required | true |
type | string |
examples |
b4c8ac20a87e493a3dd30a6f16094149771660c1ae17fbab1e4adfef86c76091
|
Possible Responses
200, 401, 404, 417, 422, 500
/emails/{invoiceId} put
CURL EXAMPLE
curl -X PUT "api.contapay.me/v1/emails/{invoiceId}?invoiceId=b4c8ac20a87e493a3dd30a6f16094149771660c1ae17fbab1e4adfef86c76091" \
-H "Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6" \
-H "Content-Type: application/json" \
-d @request_body
REQUEST HEADERS
Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
Content-Type: application/json
RESPONSE BODY
{
"response": "O email foi enviado com sucesso."
}
Type
{
"name": "type",
"displayName": "type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "response",
"displayName": "response",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Informativo de sucesso na requisição.",
"key": "response"
}
]
}
/transfer
A partir da rota /transfer pode-se realizar uma solicitação de saque.
/transfer post
POST: /transfer
Via método post é possível realizar uma solicitação de saque.
Header Parameters
Authorization
Utilize esse campo para enviar um token válido. Inicie o preenchimento do campo com o termo
Bearer
e em seguida o token.
Property | Value |
---|---|
required | true |
type | string |
examples |
Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
|
Content-Type
Neste campo apenas preencha
application/json
Property | Value |
---|---|
required | true |
type | string |
examples |
application/json
|
Possible Responses
201, 401, 404, 417, 422, 500
/transfer post
CURL EXAMPLE
curl -X POST "api.contapay.me/v1/transfer" \
-H "Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6" \
-H "Content-Type: application/json" \
-d @request_body
REQUEST HEADERS
Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
Content-Type: application/json
RESPONSE BODY
{
"saque_id": "8bd9c0d453533757387ed019c45617cdc440ba680a67b1a101c85b998ef715c0",
"value": 400
}
Type
{
"name": "type",
"displayName": "type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "saque_id",
"displayName": "saque_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de um saque. Esse é gerado automaticamente pelo sistema.",
"key": "saque_id"
},
{
"name": "value",
"displayName": "value",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "double",
"required": true,
"description": "Valor do saque efetuado.",
"key": "value"
}
]
}
/extract
Extrato completo de um período determinado.
/extract get
GET: /extract
Retorna o extrato financeiro de uma empresa em um determinado período de tempo.
Header Parameters
Authorization
Utilize esse campo para enviar um token válido. Inicie o preenchimento do campo com o termo
Bearer
e em seguida o token.
Property | Value |
---|---|
required | true |
type | string |
examples |
Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
|
Content-Type
Neste campo apenas preencha
application/json
Property | Value |
---|---|
required | true |
type | string |
examples |
application/json
|
Query Parameters
data_inicial
Antes de iniciar a requisição você deve informar um valor para a data inicial.
Property | Value |
---|---|
required | false |
type | date |
examples |
api.contapay.me/v1/extract?data_inicial=2017-10-01&data;_final=2018-10-01
|
data_final
Antes de iniciar a requisição você deve informar um valor para a data final.
Property | Value |
---|---|
required | false |
type | date |
examples |
api.contapay.me/v1/extract?data_inicial=2017-10-01&data;_final=2018-10-01
|
Possible Responses
200, 401, 404, 417, 500
/extract get
CURL EXAMPLE
curl -X GET "api.contapay.me/v1/extract?data_inicial=api.contapay.me/v1/extract?data_inicial=2017-10-01&data_final=2018-10-01&data_final=api.contapay.me/v1/extract?data_inicial=2017-10-01&data_final=2018-10-01" \
-H "Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6" \
-H "Content-Type: application/json"
REQUEST HEADERS
Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
Content-Type: application/json
RESPONSE BODY
[
{
"register_id": "27cf14dfc2232b941066f7c3f8cad04c9820f80a2362fc313f0567b0bae2d527",
"invoice_id": "a0bd94956b9f42cde97b95b10ad65bbaf2a8d87142caf819e4c099ed75126d72",
"tax_key": "quitacao_boleto",
"type": "Crédito",
"value": "100.00",
"status": "Liquidado",
"created_date": "2018-02-02 10:59:31",
"liquidation_date": "2017-12-26 00:00:00"
},
{
"register_id": "ad5ef4b29e148afd784de5373b210eb00879dfbf08922c96dc6ce4fc1e064fd9",
"invoice_id": "a7be8e1fe282a37cd666e0632b17d933fa13f21addf4798fc0455bc166e2488c",
"tax_key": "quitacao_boleto",
"type": "Crédito",
"value": "100.00",
"status": "Liquidado",
"created_date": "2018-02-02 10:59:32",
"liquidation_date": "2018-01-15 00:00:00"
}
]
Type
{
"name": "type",
"displayName": "type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "array",
"items": {
"name": "items",
"displayName": "items",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "register_id",
"displayName": "register_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de um registro financeiro. Esse é gerado automaticamente pelo sistema.",
"key": "register_id"
},
{
"name": "invoice_id",
"displayName": "invoice_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Identificador único de uma pacela.",
"key": "invoice_id"
},
{
"name": "tax_key",
"displayName": "tax_key",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Taxa aplicada.",
"key": "tax_key"
},
{
"name": "type",
"displayName": "type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Tipo de registro financeiro. Identifica se o registro é um crédito ou débito.",
"key": "type"
},
{
"name": "value",
"displayName": "value",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "double",
"required": true,
"description": "Valor de um registro financeiro.",
"key": "value"
},
{
"name": "status",
"displayName": "status",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Informa o status de quitação da empresa com o ContaPay, ou seja, informa se houve a quitação da tarifa de emissão de boleto.",
"key": "status"
},
{
"name": "created_date",
"displayName": "created_date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "date",
"required": true,
"description": "Data de criação do registro financeiro.",
"key": "created_date"
},
{
"name": "liquidation_date",
"displayName": "liquidation_date",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "date",
"required": true,
"description": "Data de quitação da Taxa de emissão de boleto.",
"key": "liquidation_date"
}
]
}
}
/notifications/{invoiceId}
Retorna as notificações atribuidas ao envio do boleto com ID {invoiceId}.
/notifications/{invoiceId} get
GET: /notifications/{invoiceId}
Retorna as notificações atribuidas ao envio do boleto com ID {invoiceId}.
URI Parameters
invoiceId
Property | Value |
---|---|
required | true |
type | string |
Header Parameters
Authorization
Utilize esse campo para enviar um token válido. Inicie o preenchimento do campo com o termo
Bearer
e em seguida o token.
Property | Value |
---|---|
required | true |
type | string |
examples |
Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
|
Content-Type
Neste campo apenas preencha
application/json
Property | Value |
---|---|
required | true |
type | string |
examples |
application/json
|
Query Parameters
invoiceId
Identificador exlclusivo de um boleto (ID). Na URL substitua {invoiceId} pelo ID de um boleto antes de iniciar a requisição.
Property | Value |
---|---|
required | true |
type | string |
examples |
b4c8ac20a87e493a3dd30a6f16094149771660c1ae17fbab1e4adfef86c76091
|
Possible Responses
200, 401, 404, 417, 422, 500
/notifications/{invoiceId} get
CURL EXAMPLE
curl -X GET "api.contapay.me/v1/notifications/{invoiceId}?invoiceId=b4c8ac20a87e493a3dd30a6f16094149771660c1ae17fbab1e4adfef86c76091" \
-H "Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6" \
-H "Content-Type: application/json"
REQUEST HEADERS
Authorization: Bearer $2y$10$AJ9nr0NAUcl3VskG/VoVK.T0g3KmG9DZXkuyKk4PBsIuEoa9s7ER6
Content-Type: application/json
RESPONSE BODY
[
{
"notification_id": "6e84c059401d22539a24363164c440f3a0e67ba0",
"document_number": 8888,
"type": "Envio de boleto",
"email": "[email protected]",
"action": "Enviado"
},
{
"notification_id": "eb55044020da10838690e0f110e0fd0796f76c71",
"document_number": 8888,
"type": "Envio de boleto",
"email": "[email protected]",
"action": "Entregue"
}
[
Type
{
"name": "type",
"displayName": "type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "object",
"properties": [
{
"name": "document_number",
"displayName": "document_number",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "integer",
"required": true,
"description": "Número de documento do boleto.",
"key": "document_number"
},
{
"name": "type",
"displayName": "type",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Tipo de notificação.",
"key": "type"
},
{
"name": "email",
"displayName": "email",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Endereço de email na qual o boleto foi enviado.",
"key": "email"
},
{
"name": "action",
"displayName": "action",
"typePropertyKind": "TYPE_EXPRESSION",
"type": "string",
"required": true,
"description": "Ação atrelada ao email.",
"key": "action"
}
]
}