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âmetro | Descrição | Tipo (Tamanho) | Obrigatório |
---|---|---|---|
merchant_id | Código da loja no Carat. Os códigos de produção e certificação serão diferentes. | AN (≤ 15) | Sim |
merchant_key | Chave de autenticação da loja no Carat. As chaves de produção e certificação serão diferentes. | AN (≤ 80) | Sim |
Content-Type | Utilizar valor "application/json". | AN (= 15) | Sim |
#
Parâmetro de requisiçãoParâmetro | Descrição | Tipo (Tamanho) | Obrigatório |
---|---|---|---|
operation | Número identificador da operação que se deseja chamar. | N (≤ 3) | Sim |
parameters | Conjunto de propriedades que devem ser enviadas para realizar a operação especificada no parâmetro operation. | AN (≤ 20) | Sim |
parameters
#
Tabela descritiva dos 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âmetro | Descrição | Tipo (Tamanho) | Obrigatório |
---|---|---|---|
token | Token de autenticidade que foi gerado pelo Carat (Saiba mais) | AN (= 66) | Condicional por operação |
authorizer_id | Código da autorizadora no Carat (Saiba mais) | AN (≤ 3) | Sim |
terminal_id | Valor 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_usn | NSU da operação gerado pela loja | N (≤ 12) | Sim |
operator_code | Código do operador | N (= 2) | Não |
supervisor_code | Código do supervisor | N (= 5) | Não |
subfunction | Subfunção da operação. O valor deste campo deve estar condizente com a operação | N (= 2) | Sim |
#
RespostaA resposta depende de cada operação e será especificado na documentação de cada autorizadora/roteamento.