Serviço de criação da transação

Detalhes da chamada#

  • Recurso: /v1/store
  • Método HTTP: POST
  • Formato da requisição: JSON
  • Formato da resposta: JSON
  • Headers:
    • Content-Type: application/json
    • merchant_id: {seu código de loja}
    • merchant_key: {sua chave da loja}

O consumo desse serviço é obrigatório no fluxo de armazenamento JavaScript.

Parâmetros de requisição#

Os seguintes parâmetros de requisição devem ser enviados:

ParâmetroDescriçãoFormatoObrigatório
merchant_usnNúmero sequencial único para cada pedido, criado pela loja.< 12 NSIM
customer_idIdentificação do comprador para armazenamento de cartão. Esta identificação deve ser única para cada usuário da loja. Mas atenção, essa garantia de unicidade é de total responsabilidade da loja, o Carat não realizará nenhuma validação.< 20 ANSIM

Parâmetros de resposta#

Na tabela abaixo está a descrição dos parâmetros de resposta:

ParâmetroDescriçãoFormato
codeCódigo de resposta do Carat. Qualquer código diferente de 0(zero) significa falha. Saiba mais.< 4 N
messageMensagem de resposta do Carat.< 500 AN
store
statusStatus da transação de armazenamento no Carat. Saiba mais.= 3 AN
nsuaNúmero sequencial único da transação de armazenamento no Carat.= 15 AN
nitaNúmero identificador criptografado da transação de armazenamento devolvido à loja pelo Carat.< 65 AN
merchant_usnNúmero sequencial único enviado pela loja.< 12 N
customer_idIdentificação do comprador para armazenamento de cartão.< 20 AN
store_tokenToken associado ao armazenamento JavaScript.= 66 AN

Exemplo#

Requisição:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor
esitef-homologacao.softwareexpress.com.br

curl
--request POST "https://{{url}}/e-sitef/api/v1/store"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
"merchant_usn":"16013439434",
"customer_id":"11122211122"
}
--verbose

Resposta:

{
"code":"0",
"message":"OK. Transaction successful.",
"store":{
"status":"CON",
"nsua":"12345600000560A",
"merchant_usn":"16013439434",
"customer_id":"11122211122",
"nita":"Z123adsfrh342r72498r34920ur23r328r2038r023rh0h203rh032r082380rf43",
"store_token": "123456789012345678901234567890123456789012345678901234567890123456"
}
}

Códigos de resposta

Veja a referencia no Códigos da API - códigos de resposta