...
| 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 |
| header.taxDocument | Integer | Número do documento fiscal (NFC-e, CFE, COO) |
| 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 citInternal- Código do cliente (Seqpessoa) |
...
| Bloco de código |
|---|
{
"id":"{92C7BEBB-511F-4D36-B51F-7ABC63ADA13A}",
"version":"1.0",
"operation":"opConsult",
"header":{
"idDocument":1094880,
"idStore":1,
"idTerminal":32,
"taxdocument":12300
},
"consult":{
"identifications":[
{
"document":"123456789",
"documentType":"cdtNumberCredit"
},
{
"document":"1526",
"documentType":"cdtNumberCreditcitInternal"
}
]
}
} |
...
| Bloco de código |
|---|
{
"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":"CRÉDITO UITLIZADO"
}
} |
...
...
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 |
| Credits[0].paymentNumber | Integer | Número da forma de pagamento |
...
| Bloco de código |
|---|
{
"id":"{B2DBF307-03B3-44CA-B4E1-FFABC860E85F}",
"version":"1.0",
"operation":"opReserve",
"header":{
"idDocument":1094880,
"idStore":1,
"idTerminal":32,
"taxdocument":12300
},
"credits":[
{
"idCredit":1233,
"dateTimeIssue":"1899-12-30T00:00:00.000Z",
"amountPaid":30,
"paymentNumber":54
}
]
} |
...
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. |
Exemplo(Sample)
| Bloco de código |
|---|
{
"id":"16774AFE-12D7-4AD4-BCEF-1A3580B593F1",
"version":1,
"Status":{
"Type":"stSuccess",
"Message":""
}
} |
...
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 | 3000 | Não | Texto que será impresso pela impressora |
Exemplo(Sample)
| Bloco de código |
|---|
{
"id":"16774AFE-12D7-4AD4-BCEF-1A3580B593F1",
"version":1,
"Status":{
"Type":"stSuccess",
"Message":""
},
"TemplatesPrint":"CRÉDITO UITLIZADO"
} [
{
"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"
}
]
} |