Serviço de operação genérica

O serviço de operação genérica depende da autorizadora / roteamento. Este capítulo irá se focar nas características em comum de cada operação. Para maiores detalhes de cada operação, veja a documentação elaborada para cada roteamento.

Detalhes da chamada#

  • Recurso: /v1/genericoperations
  • Método HTTP: POST
  • Formato da requisição: JSON
  • Formato da resposta: JSON
  • Parâmetros de cabeçalho:
ParâmetroDescriçãoTipo (Tamanho)Obrigatório
merchant_idCódigo da loja no Carat. Os códigos de produção e certificação serão diferentes.AN (≤ 15)Sim
merchant_keyChave de autenticação da loja no Carat. As chaves de produção e certificação serão diferentes.AN (≤ 80)Sim
Content-TypeUtilizar valor "application/json".AN (= 15)Sim

Parâmetro de requisição#

ParâmetroDescriçãoTipo (Tamanho)Obrigatório
operationNúmero identificador da operação que se deseja chamar.N (≤ 3)Sim
parametersConjunto de propriedades que devem ser enviadas para realizar a operação especificada no parâmetro operation.AN (≤ 20)Sim

Tabela descritiva dos parameters#

Cada operação possui um conjunto de parâmetros. Abaixo segue os parâmetros com características em comum para todas as operações:

ParâmetroDescriçãoTipo (Tamanho)Obrigatório
tokenToken de autenticidade que foi gerado pelo Carat (Saiba mais)AN (= 66)Condicional por operação
authorizer_idCódigo da autorizadora no Carat (Saiba mais)AN (≤ 3)Sim
terminal_idValor numérico que representa um terminal lógico no SiTef. Um número de terminal lógico não pode ser usado ao mesmo tempo por duas requisições diferentes.AN (= 8)Sim
merchant_usnNSU da operação gerado pela lojaN (≤ 12)Sim
operator_codeCódigo do operadorN (= 2)Não
supervisor_codeCódigo do supervisorN (= 5)Não
subfunctionSubfunção da operação. O valor deste campo deve estar condizente com a operaçãoN (= 2)Sim

Resposta#

A resposta depende de cada operação e será especificado na documentação de cada autorizadora/roteamento.