Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

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"
   }
}


Informações da Requisição - Operação reversar, baixa e estorno  (Request Information)

Parâmetros do Corpo (Body Parameters)

ParâmetroTipoDescrição
idstringIdentificado único da requisição
versionstringVersão da API
operationstring

Operação 
opConsult - Consultar

opReserve - Reversar

opFinish - Baixar

opCancel - Estorno

headerObject Json

Cabeçalho da requisição

header.idDocumentInteger

Número da venda

header.idStoreInteger

Número da empresa

Credits[0].IdCreditIntegerIdentificador do crédito
Credits[0].dateTimeIssueDatatimeData de emissão
Credits[0].amountPaidDoubleValor utilizado da venda

Formatos de Requisição (Request Formats)

...

Bloco de código
{
   "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ção reversar, baixa e estorno (Response Information)

Parâmetros do Corpo (Body Parameters)

PARÂMETRO

TIPO

TAMANHO

OBRIGATÓRIO

DESCRIÇÃO

idstring

Identificado único da resposta
versionInteger

Número da versão
StatusObject Json

Status do cédito
Status.TypeString
Sim

Status do crédito

stSuccess - Sucesso

stException - Falha

Status.MessageString50NãoMensagem para mostra no PDV, caso ocorra uma exceção.

Formatos de Resposta (Response Formats)

...