API Reference
Full technical reference for the Conta Simples API endpoints
About this section
The API Reference is the technical description of the Conta Simples API endpoints. Here you will find:
- All available endpoints with parameters and schemas
- Request and response examples
- HTTP response codes
- An interactive playground to test calls
New here? We recommend starting with the Guides before exploring the technical reference. The guides cover concepts and flows — this section focuses on the technical details of each endpoint.
How to use this reference
Understand the flow in the Guides
Read the Recommended integration flow to see the end-to-end journey.
Open the specific endpoint
Use this reference to see parameters, types, and examples for each endpoint.
Try the playground
Use the interactive playground next to each endpoint to test calls. If the credential has a public key, use the Request signing card inside Try it, right below Headers.
The playground sends the request through the documentation portal's server: the token and the body pass through it. Use Sandbox credentials here.
Check the data dictionary
For field meanings, see the Data dictionary.
Available endpoints
Accounts
| Method | Endpoint | Description |
|---|---|---|
GET | /accounts/v1/balance | Account Balance |
Attachments
| Method | Endpoint | Description |
|---|---|---|
POST | /attachments/v1/attachments | Link Receipt or Invoice |
GET | /attachments/v1/content/{attachmentId} | Download attachment |
Authentication
| Method | Endpoint | Description |
|---|---|---|
POST | /oauth/v1/access-token | Get access token |
Bills
| Method | Endpoint | Description |
|---|---|---|
GET | /credit-cards/v1/bills | List bills |
GET | /credit-cards/v1/bills/{dueDate} | Bill details |
Cards
| Method | Endpoint | Description |
|---|---|---|
GET | /credit-cards/v1/cards | List cards |
GET | /credit-cards/v1/cashback | Get cashback balance |
POST | /credit-cards/v1/{id}/block | Block card |
POST | /credit-cards/v1/{id}/unblock | Unblock card |
Categories
| Method | Endpoint | Description |
|---|---|---|
GET | /categories/v1/categories | List categories |
POST | /categories/v1/categories | Create category |
DELETE | /categories/v1/categories | Delete categories |
GET | /categories/v1/categories/{id} | Get category by ID |
PATCH | /categories/v1/categories/{id} | Update category name |
Cost Centers
| Method | Endpoint | Description |
|---|---|---|
GET | /cost-centers/v1/cost-centers | List cost centers |
POST | /cost-centers/v1/cost-centers | Create Cost Center |
GET | /cost-centers/v1/cost-centers/{id} | Get Cost Center by ID |
PATCH | /cost-centers/v1/cost-centers/{id} | Update Cost Center |
DELETE | /cost-centers/v1/cost-centers/{id} | Delete Cost Center |
Suppliers
| Method | Endpoint | Description |
|---|---|---|
GET | /suppliers/v1/suppliers | List Suppliers |
POST | /suppliers/v1/suppliers | Create Supplier |
GET | /suppliers/v1/suppliers/{id} | Get Supplier by ID |
PUT | /suppliers/v1/suppliers/{id} | Update Supplier |
DELETE | /suppliers/v1/suppliers/{id} | Delete Supplier |
Transactions
| Method | Endpoint | Description |
|---|---|---|
GET | /statements/v1/banking | Banking statement |
PATCH | /statements/v1/banking/{transactionId} | Update Banking Transaction |
GET | /statements/v1/banking/{transactionId}/receipt | Banking Transaction Receipt |
GET | /statements/v1/credit-card | Card statement |
PATCH | /statements/v1/credit-card/{transactionId} | Update Card Transaction |
Users
| Method | Endpoint | Description |
|---|---|---|
GET | /users/v1/invites | List invites |
GET | /users/v1/roles | List roles |
GET | /users/v1/users | List users |
GET | /users/v1/users/{userId} | Get User by ID |
DELETE | /users/v1/users/{userId} | Delete user |
PATCH | /users/v1/users/{userId} | Update User |
VCN
| Method | Endpoint | Description |
|---|---|---|
POST | /credit-cards/v1/vcns | Create VCN |
GET | /credit-cards/v1/vcns/{vcnId} | Get VCN |
PATCH | /credit-cards/v1/vcns/{vcnId} | Update VCN |
DELETE | /credit-cards/v1/vcns/{vcnId} | Cancel VCN |
GET | /credit-cards/v1/vcns/{vcnId}/reveal | Reveal VCN card data |
Authentication
All requests require a Bearer token in the Authorization header:
curl -X GET https://api-sandbox.contasimples.com/statements/v1/credit-card \
-H "Authorization: Bearer {TOKEN}" \
-H "Content-Type: application/json" \
-H "User-Agent: {your-app-name}/{version}"
| Header | Value | Required |
|---|---|---|
Authorization | Bearer {TOKEN} | Yes |
Content-Type | application/json | Yes (for POST) |
Signature-Input | sig=("@method" "@path" "@query");created=...;alg="rsa-v1_5-sha256" | Yes, when the credential has a public key registered |
Signature | sig=:SIGNATURE: | Yes, when the credential has a public key registered |
Content-Digest | sha-256=:DIGEST: | Yes, when the request has a body and the credential has a public key registered |
Authentication guide
How to obtain and refresh access tokens.
Request Signing
How to sign calls made by a credential with a public key.
Conventions
Dates
| Context | Format | Example |
|---|---|---|
| Request parameters | YYYY-MM-DD | 2025-01-15 |
| Response fields | ISO 8601 | 2025-01-15T14:30:00.000Z |
Money amounts
Values are number (decimal) in Brazilian Reais (BRL).
Pagination
Cursor-based pagination via nextPageStartKey. See Best practices — Pagination for a full implementation.