01. INTRODUÇÃO
Para utilização das APIs de Conta Corrente, primeiramente é necessário obter um token de autenticação. Para obtê-lo, basta seguir os procedimentos documentados no link a seguir:
- Link para documentação referente a obtenção de token: obter token
01. INTRODUÇÃO
Requisição que tem como finalidade criar um adiantamento financeiro para o cliente, fazendo um movimento do tipo "transferência bancária". Em contra-partida, gera um movimento do tipo "dinheiro" para a conta bancária informada.
- Link para documentação técnica: gerar adiantamento para cliente
02. UTILIZAÇÃO
{ "AccountNumber": 0, "CompensationAccountNumber": 0, "PaymentValue": 0, "AuxiliarDescription": "string", "DocumentNumber": "string" }
URL
HEADER
Authorization | Bearer {{token}} |
---|
BODY
{ "AccountNumber": 0, "CompensationAccountNumber": 0, "PaymentValue": 0, "AuxiliarDescription": "string", "DocumentNumber": "string" }
{ "success":true }
{ "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": {status code}, "traceId": {traceId}, "errors": { [lista de erros] } }
01. INTRODUÇÃO
Requisição que tem como finalidade cadastrar uma conta corrente para o cliente. Essa requisição não validará se o cliente já possui uma conta do tipo "cliente".
02. UTILIZAÇÃO
{ "companyDocument": "string", "customerDocument": "string" }
URL
HEADER
Authorization | Bearer {{token}} |
---|
BODY
{ "companyDocument": "string", "customerDocument": "string" }
{ "success": true, "data": 999999 }
{ "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": {status code}, "traceId": {traceId}, "errors": { [lista de erros] } }
01. INTRODUÇÃO
Requisição que tem como finalidade buscar uma conta corrente para o cliente. Retornará o valor "0" quando não encontrar um registro.
02. UTILIZAÇÃO
{ "companyDocument": "string", "customerDocument": "string" }
URL
HEADER
Authorization | Bearer {{token}} |
---|
BODY
{ "companyDocument": "string", "customerDocument": "string" }
{ "success": true, "data": 999999 }
{ "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": {status code}, "traceId": {traceId}, "errors": { [lista de erros] } }
01. INTRODUÇÃO
Requisição que tem como finalidade buscar ou cadastrar uma conta corrente para o cliente. Realiza a busca baseado nos filtros e caso o registro não seja encontrado uma nova conta corrente será cadastrada para o cliente.
02. UTILIZAÇÃO
{ "companyDocument": "string", "customerDocument": "string" }
URL
HEADER
Authorization | Bearer {{token}} |
---|
BODY
{ "companyDocument": "string", "customerDocument": "string" }
{ "success": true, "data": 999999 }
{ "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": {status code}, "traceId": {traceId}, "errors": { [lista de erros] } }