post
https://sandbox-api.viobank.com.br/my-receivables//receive
Use este endpoint para registrar manualmente o recebimento de uma conta a receber.
Autenticacao
- Envie um Bearer token valido no header
Authorization.
Requisicao
- Envie o corpo da requisicao em
application/json.
Campos da Requisicao
| Campo | Tipo | Obrigatorio | Descricao | Exemplo |
|---|---|---|---|---|
amount | number | Nao | - | 1500.75 |
movement_date | string (date) | Nao | Formato esperado: Y-m-d. | 2026-03-18 |
notes | string | Nao | Maximo de 1000 caracteres. | valor_exemplo |
Exemplo de Requisicao
{
"amount": 1500.75,
"movement_date": "2026-03-18",
"notes": "valor_exemplo"
}Resposta
- Em caso de sucesso, a API retorna um envelope JSON com
success,messageedataquando houver payload.
Codigos de Resposta
| Codigo | Descricao | Formato |
|---|---|---|
200 | Operacao realizada com sucesso. | application/json |
401 | Nao autenticado. | application/json |
403 | Acesso negado. | application/json |
422 | Erro de validacao. | application/json |
Campos da Resposta de Sucesso
| Campo | Tipo | Obrigatorio | Descricao | Exemplo |
|---|---|---|---|---|
success | boolean | Sim | - | 1 |
message | string | Sim | - | valor_exemplo |
data | object | Sim | - | {"uuid":"00000000-0000-4000-8000-000000000000","movement_type":"valor_exemplo","amount":1500.75,"movement_date":"2026... |
data.uuid | string (uuid) | Sim | - | 00000000-0000-4000-8000-000000000000 |
data.movement_type | string | Sim | - | valor_exemplo |
data.amount | number | Sim | - | 1500.75 |
data.movement_date | string (date) | Sim | Formato esperado: Y-m-d. | 2026-03-18 |
data.notes | object | Sim | - | - |
data.metadata | object | Sim | - | - |
data.created_at | string (date-time) | Sim | - | 2026-03-18T10:00:00-03:00 |
Campos da Resposta de Validacao
| Campo | Tipo | Obrigatorio | Descricao | Exemplo |
|---|---|---|---|---|
message | string | Sim | - | valor_exemplo |
errors | object | Sim | - | {"field":["valor_exemplo"]} |
Exemplo de Resposta de Sucesso
{
"success": true,
"message": "valor_exemplo",
"data": {
"uuid": "00000000-0000-4000-8000-000000000000",
"movement_type": "valor_exemplo",
"amount": 1500.75,
"movement_date": "2026-03-18",
"created_at": "2026-03-18T10:00:00-03:00"
}
}Exemplo de Erro de Validacao
{
"message": "valor_exemplo",
"errors": {
"field": [
"valor_exemplo"
]
}
}Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…