Objetivo
Permitir que o parceiro desenvolva uma API onde o PDV realizará a consulta de créditos para fazer pagamento de venda. Por favor, siga a documentação de configuração de ambiente para mais detalhes.
Chamada
POST {url}
Segurança
Se os parâmetros de autenticação estiver configurado será enviado no Header no formato Basic Auth ou Bearer Token, siga a documentação de configuração para selecionar o modelo de autenticação.
Informações da Requisição - Operação consulta (Request Information)
Parâmetros do Corpo (Body Parameters)
| Parâmetro | Tipo | Descrição |
| id | string | Identificado único da requisição |
| version | string | Versão da API |
| operation | string | Operação opReserve - Reservar opFinish - Baixar opCancel - Estorno |
| header | Object Json | Cabeçalho da requisição |
| header.idDocument | Integer | Número da venda |
| header.idStore | Integer | Número da empresa |
| header.idTerminal | Integer | Número do chekout |
| consult | Object Json | Dados para realizar a consulta |
| consult.identifications | Array object Json | Lista de documentos |
| consult.identifications[0].document | string | Documento |
| consult.identifications[0].documentType | string | Tipo do documento cdtNumberCredit- Número do crédito |
Formatos de Requisição (Request Formats)
application/json
Exemplo (Sample)
{
"id":"{92C7BEBB-511F-4D36-B51F-7ABC63ADA13A}",
"version":"1.0",
"operation":"opConsult",
"header":{
"idDocument":1094880,
"idStore":1,
"idTerminal":32
},
"consult":{
"identifications":[
{
"document":"123456789",
"documentType":"cdtNumberCredit"
}
]
}
}
Informações para Resposta - Operação consulta (Response Information)
Parâmetros do Corpo (Body Parameters)
PARÂMETRO | TIPO | TAMANHO | OBRIGATÓRIO | DESCRIÇÃO |
|---|---|---|---|---|
| id | string | Identificado único da resposta | ||
| version | Integer | Número da versão | ||
| Credits | Array object Json | Lista de créditos | ||
| Credits[0].IdCredit | Integer | 15 | Sim | Identificador do crédito |
| Credits[0].idPerson | Integer | 10 | Sim | Identificador da pessoa do crédito |
| Credits[0].dateTimeIssue | Datatime | Sim | Data de emissão | |
| Credits[0].openAmount | Double | 9.2 | Sim | Valor para ser utilizado |
| Credits[0].Kind | String | 6 | Sim | Espécie do crédito |
| Status | Object Json | Status do cédito | ||
| Status.Type | String | Sim | Status do crédito stSuccess - Sucesso stException - Falha | |
| Status.Message | String | 50 | Não | Mensagem para mostra no PDV, caso ocorra uma exceção. |
Formatos de Resposta (Response Formats)
application/json
Exemplo (Sample)
{
"id":"16774AFE-12D7-4AD4-BCEF-1A3580B593F1",
"version":1,
"Credits":[
{
"IdCredit":1233,
"idPerson":123456,
"dateTimeIssue":"2023-01-15T00:00:00.000Z",
"openAmount":100.00,
"Kind":"DUPP"
}
],
"Status":{
"Type":"stSuccess",
"Message":""
}
}
Informações da Requisição - Operações reservar, baixar e estorno (Request Information)
Parâmetros do Corpo (Body Parameters)
| Parâmetro | Tipo | Descrição |
| id | string | Identificado único da requisição |
| version | string | Versão da API |
| operation | string | Operação opReserve - Reservar opFinish - Baixar opCancel - Estorno |
| header | Object Json | Cabeçalho da requisição |
| header.idDocument | Integer | Número da venda |
| header.idStore | Integer | Número da empresa |
| Credits[0].IdCredit | Integer | Identificador do crédito |
| Credits[0].dateTimeIssue | Datatime | Data de emissão |
| Credits[0].amountPaid | Double | Valor utilizado da venda |
Formatos de Requisição (Request Formats)
application/json
Exemplo (Sample)
{
"id":"{B2DBF307-03B3-44CA-B4E1-FFABC860E85F}",
"version":"1.0",
"operation":"opReserve",
"header":{
"idDocument":1094880,
"idStore":1,
"idTerminal":32
},
"credits":[
{
"idCredit":1233,
"dateTimeIssue":"1899-12-30T00:00:00.000Z",
"amountPaid":30
}
]
}
Informações para Resposta - operações reversar, baixar e estorno (Response Information)
Parâmetros do Corpo (Body Parameters)
PARÂMETRO | TIPO | TAMANHO | OBRIGATÓRIO | DESCRIÇÃO |
|---|---|---|---|---|
| id | string | Identificado único da resposta | ||
| version | Integer | Número da versão | ||
| Status | Object Json | Status do cédito | ||
| Status.Type | String | Sim | Status do crédito stSuccess - Sucesso stException - Falha | |
| Status.Message | String | 50 | Não | Mensagem para mostra no PDV, caso ocorra uma exceção. |
Formatos de Resposta (Response Formats)
application/json
Exemplo (Sample)
{
"id":"16774AFE-12D7-4AD4-BCEF-1A3580B593F1",
"version":1,
"Status":{
"Type":"stSuccess",
"Message":""
}
}
Informações para resposta com emissão dos comprovantes no PDV - operações de baixar e estorno (Response Information)
Parâmetros do Corpo (Body Parameters)
PARÂMETRO | TIPO | TAMANHO | OBRIGATÓRIO | DESCRIÇÃO |
|---|---|---|---|---|
| id | string | Identificado único da resposta | ||
| version | Integer | Número da versão | ||
| Status | Object Json | Status do cédito | ||
| Status.Type | String | Sim | Status do crédito stSuccess - Sucesso stException - Falha | |
| Status.Message | String | 50 | Não | Mensagem para mostra no PDV, caso ocorra uma exceção. |
| TemplatesPrint | Object Json | Comprovantes para impressão | ||
| TemplatesPrint[0].Text | String | 500 | Não | Texto que será impresso pela impressora |
Formatos de Resposta (Response Formats)
application/json
Exemplo (Sample)
{
"id":"16774AFE-12D7-4AD4-BCEF-1A3580B593F1",
"version":1,
"Status":{
"Type":"stSuccess",
"Message":""
},
"TemplatesPrint": [
{
"Text": "RECEBO PAGAMENTO, CONVENIO: \r\n\r\n N. 100, Vlr. Compra: 99,99\r\n"
},
{
"Text": "SEGUNDA via cliente \r\n\r\n RECEBO PAGAMENTO, CONVENIO: \r\n\r\n N. 100, Vlr. Compra: 99,99\r\n"
}
]
}
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas