Método responsável pela consulta de credito online:
Ao realizarmos uma consulta na API de processoonlinecredito será possível verificar o limite de crédito, definido pela retaguarda, disponível para o consumidor no momento da venda, inclusive por diferentes formas de pagamento, se configurado.
- Endpoint: /api/pdvsyncserver/retaguarda/v2/processoonlinecredito/{IdInquilino}/{IdRetaguardaLoja}
- Método: Get
- Autenticação: Bearer token
- Permissão: Client
Os parâmetros para a requisição estão abaixo
Campo | Tipo | Descrição | Tipo Parâmetro | Obrigatório | Observação |
|---|---|---|---|---|---|
| IdInquilino | string | Identificador do Inquilino | Parameter/Path/Query Params | Sim | Usado apenas pelo PDV. Retaguarda não precisa criar API com esse parâmetro |
| IdRetaguardaLoja | string | Identificador da loja na retaguarda | Parameter/Path/Query Params | Sim | |
| cpfCnpj | string | Documento do cliente | Header | Não | |
| idRetaguardaCredito | string | Código do crédito disponível do cliente | Header | Não |
Retornos
Campo |
Tipo |
Descrição |
|---|---|---|
| Success | bool | Indica se a requisição foi feita com sucesso |
| Message | string | Mensagem de retorno de erros |
| creditos | Lista de Objetos | Lista com os créditos retornados |
| creditos.saldo | double | Saldo do crédito |
| creditos.IdRetaguardaCredito | string | Identificador do crédito na retaguarda |
{
"success": true,
"message": "string",
"creditos": [
{
"saldo": 0,
"idRetaguardaCredito": "string"
}
]
}
Campo |
Tipo |
Descrição |
Observação |
|---|---|---|---|
| Success | bool | Indica se a requisição foi feita com sucesso | |
| Message | string | Mensagem de retorno de erros | |
| creditos | Lista de Objetos | Quando erro essa lista vem nula |
{
"success": false,
"message": "sting",
"creditos": null,
"errors": null
}
Visão Geral
Import HTML Content
Conteúdo das Ferramentas