- Endpoint:
POST /api/v2/remessas
- Consumer:
application/json
- Producer:
application/json
- Descrição: Endpoint para criar uma nova remessa com informações do cliente e parcelamento.
| Nome |
Tipo |
Obrigatório |
Descrição |
| Content-Type |
string |
Sim |
Indica o tipo de mídia (MIME type) do corpo da requisição. |
| Authorization |
string |
Sim |
Token de Autorização OAuth 2.0. |
| Nome |
Tipo |
Obrigatório |
Descrição |
| venda |
object |
Sim |
Dados da venda |
Descrição: Retorno quando uma remessa é criada com sucesso.
{
"code": 200,
"message": "Remessa created successfully",
"data": {
"idRemessa": "valor_do_idRemessa"
}
}
| Campo |
Tipo |
Descrição |
| code |
int |
Código HTTP da resposta |
| message |
string |
Mensagem de retorno |
| data |
object |
Objeto contendo os dados da remessa |
| idRemessa |
string |
Identificador da remessa criada |
Descrição: Erro ao validar as informações enviadas no corpo da requisição.
{
"message": "Erro ao realizar parse JSON",
"unit": 2,
"error": "descricao_do_erro"
}
| Código |
Descrição |
| 2 |
Erro ao realizar parse JSON |
| 3 |
Corpo da requisição inválido |
| 5 |
Data menor ou igual à data atual |
| 6 |
CEP inválido |
| 7 |
Remessa duplicada |
| 8 |
Chave PIX não informada |
| 9 |
Soma dos rateios incorreta |
| Campo |
Tipo |
Descrição |
| message |
string |
Mensagem de erro |
| unit |
int |
Código do erro |
| error |
string |
Descrição detalhada do erro |
Descrição: Quando o token não foi corretamente enviado no header, está expirado ou sem permissão para acessar o recurso.
{
"code": 401,
"unit": 1,
"message": "Unauthorized to access this resource",
"error": "descricao_do_erro"
}
| Campo |
Tipo |
Descrição |
| code |
int |
Código HTTP da resposta |
| unit |
int |
Código do erro |
| message |
string |
Mensagem de erro |
| error |
string |
Descrição detalhada do erro |
Descrição: Quando o servidor não conseguiu processar a remessa.
{
"code": 500,
"unit": 4,
"message": "Failed to create remessa",
"error": "descricao_do_erro"
}
| Campo |
Tipo |
Descrição |
| code |
int |
Código HTTP da resposta |
| unit |
int |
Código do erro |
| message |
string |
Mensagem de erro |
| error |
string |
Descrição detalhada do erro |
Representa uma venda com informações do cliente, endereço e status da venda.
| Campo |
Tipo |
Descrição |
| DOCCliente |
string |
Documento do cliente |
| bairro |
string |
Bairro |
| cep |
string |
CEP |
| cidade |
string |
Cidade |
| codigo |
int |
Código da venda |
Detalha informações sobre uma parcela de uma venda, como vencimento, valor e forma de pagamento.
| Campo |
Tipo |
Descrição |
| DadosPgto |
string |
Dados do pagamento |
| FormaPgto |
string |
Forma de pagamento |
| boletoCancelado |
int |
Status de cancelamento do boleto |
| boletoPago |
int |
Status do pagamento do boleto |
| boletoRegistrado |
int |
Status de registro do boleto |
| dataVencimento |
string |
Data de vencimento da parcela |
| valor |
number |
Valor da parcela |
Informações sobre como o valor da parcela é rateado entre os beneficiados.
| Campo |
Tipo |
Descrição |
| DOC |
string |
Documento do beneficiado |
| beneficiado |
string |
Nome do beneficiado |
| valor |
number |
Valor do rateio |
Nota: Para mais informações, consulte a documentação oficial do ImobiBank Brasil.