Páginas filhas
  • DR VA Integração API Conta Corrente - Requisições de Conta Corrente

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Totvs custom tabs box
tabsRequisitos,Gerar adiantamento de cliente,Criar conta corrente,Buscar conta corrente,Buscar ou cadastrar conta corrente
idsrequisitos,geraradiantamento,criarcontacorrente,buscarcontacorrente,buscaroucadastrarCC
Totvs custom tabs box items
defaultyes
referenciarequisitos

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
Totvs custom tabs box items
defaultno
referenciageraradiantamento

01. INTRODUÇÃO

Requisição que tem a como finalidade criar um adiantamento financeiro para o cliente, fazendo um movimento com do tipo "transferência bancária". Em contra-partida, gera um movimento com do tipo "dinheiro" para a conta bancária informada.

02. UTILIZAÇÃO


Totvs custom tabs box
tabsEnvio, Retorno
idsenvio,retorno
Totvs custom tabs box items
defaultyes
referenciaenvio
Totvs custom tabs box
tabsURL, Body, Exemplo de Requisição
idsurlE,corpoE,exE
Totvs custom tabs box items
defaultyes
referenciaurlE
Totvs custom tabs box items
defaultno
referenciacorpoE
Bloco de código
languagexml
themeRDark
firstline1
titleBody
linenumberstrue
{
  "AccountNumber": 0,
  "CompensationAccountNumber": 0,
  "PaymentValue": 0,
  "AuxiliarDescription": "string",
  "DocumentNumber": "string"
}
Totvs custom tabs box items
defaultno
referenciaexE

URL


HEADER

AuthorizationBearer {{token}}


BODY


Bloco de código
languagexml
themeRDark
firstline1
titleBody
linenumberstrue
{
  "AccountNumber": 0,
  "CompensationAccountNumber": 0,
  "PaymentValue": 0,
  "AuxiliarDescription": "string",
  "DocumentNumber": "string"
}



Totvs custom tabs box items
defaultno
referenciaretorno
Totvs custom tabs box
tabsSucesso, Erro
idssucesso,erro
Totvs custom tabs box items
defaultyes
referenciasucesso
Bloco de código
languagexml
themeRDark
firstline1
titleStatus 200 OK
linenumberstrue
{
    "success":true
}
Totvs custom tabs box items
defaultno
referenciaerro
Bloco de código
languagexml
themeRDark
firstline1
titleStatus 400. 401 e 404
linenumberstrue
{
    "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]
    }
}
Totvs custom tabs box items
defaultno
referenciacriarcontacorrente

01. INTRODUÇÃO

Requisição que tem a como finalidade criar cadastrar uma conta corrente para o cliente. Essa requisição não valida validará se o cliente já possui possui  uma conta do tipo "cliente".

02. UTILIZAÇÃO

Totvs custom tabs box
tabsEnvio,Retorno
idsenvio2,retorno2
Totvs custom tabs box items
defaultyes
referenciaenvio2
Totvs custom tabs box
tabsURL,Body,Exemplo de requisição
idsurl2,body2,exemplo2
Totvs custom tabs box items
defaultyes
referenciaurl2
Totvs custom tabs box items
defaultno
referenciabody2
Bloco de código
linenumberstrue
{
  "companyDocument": "string",
  "customerDocument": "string"
}
Totvs custom tabs box items
defaultno
referenciaexemplo2

URL


HEADER

AuthorizationBearer {{token}}


BODY

Bloco de código
linenumberstrue
{
  "companyDocument": "string",
  "customerDocument": "string"
}
Totvs custom tabs box items
defaultno
referenciaretorno2
Totvs custom tabs box
tabsSucesso, Erro
idssucesso2,erro2
Totvs custom tabs box items
defaultyes
referenciasucesso2
Bloco de código
languagexml
themeRDark
firstline1
titleStatus 200 OK
linenumberstrue
{
  "success": true,
  "data": 999999
}
Totvs custom tabs box items
defaultno
referenciaerro2
Bloco de código
languagexml
themeRDark
firstline1
titleStatus 400. 401 e 404
linenumberstrue
{
    "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]
    }
}
Totvs custom tabs box items
defaultno
referenciabuscarcontacorrente

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

Totvs custom tabs box
tabsEnvio,Retorno
idsenvio3,retorno3
Totvs custom tabs box items
defaultyes
referenciaenvio3
Totvs custom tabs box
tabsURL,Body,Exemplo de requisição
idsurl3,body3,exemplo3
Totvs custom tabs box items
defaultyes
referenciaurl3
Totvs custom tabs box items
defaultno
referenciabody3
Bloco de código
linenumberstrue
{
  "companyDocument": "string",
  "customerDocument": "string"
}
Totvs custom tabs box items
defaultno
referenciaexemplo3

URL


HEADER

AuthorizationBearer {{token}}


BODY

Bloco de código
linenumberstrue
{
  "companyDocument": "string",
  "customerDocument": "string"
}
Totvs custom tabs box items
defaultno
referenciaretorno3
Totvs custom tabs box
tabsSucesso, Erro
idssucesso3,erro3
Totvs custom tabs box items
defaultyes
referenciasucesso3
Bloco de código
languagexml
themeRDark
firstline1
titleStatus 200 OK
linenumberstrue
{
  "success": true,
  "data": 999999
}
Totvs custom tabs box items
defaultno
referenciaerro3
Bloco de código
languagexml
themeRDark
firstline1
titleStatus 400. 401 e 404
linenumberstrue
{
    "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]
    }
}
Totvs custom tabs box items
defaultno
referenciabuscaroucadastrarCC

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

Totvs custom tabs box
tabsEnvio,Retorno
idsenvio4,retorno4
Totvs custom tabs box items
defaultyes
referenciaenvio4
Totvs custom tabs box
tabsURL,Body,Exemplo de requisição
idsurl4,body4,exemplo4
Totvs custom tabs box items
defaultyes
referenciaurl4
Totvs custom tabs box items
defaultno
referenciabody4
Bloco de código
linenumberstrue
{
  "companyDocument": "string",
  "customerDocument": "string"
}
Totvs custom tabs box items
defaultno
referenciaexemplo4

URL


HEADER

AuthorizationBearer {{token}}


BODY

Bloco de código
linenumberstrue
{
  "companyDocument": "string",
  "customerDocument": "string"
}
Totvs custom tabs box items
defaultno
referenciaretorno4
Totvs custom tabs box
tabsSucesso, Erro
idssucesso4,erro4
Totvs custom tabs box items
defaultyes
referenciasucesso4
Bloco de código
languagexml
themeRDark
firstline1
titleStatus 200 OK
linenumberstrue
{
  "success": true,
  "data": 999999
}
Totvs custom tabs box items
defaultno
referenciaerro4
Bloco de código
languagexml
themeRDark
firstline1
titleStatus 400. 401 e 404
linenumberstrue
{
    "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]
    }
}