Nesta seção você encontra as possíveis respostas ao validar cupons, com detalhes sobre cada tipo de resposta, incluindo casos de sucesso, pendência, invalidade e erro.

1. Cupom válido com desconto associado

• Código de status: 200 (Sucesso)

• Descrição: resposta indicando sucesso na validação do cupom, que está vinculado a um desconto ativo. Inclui os termos legais, o valor do desconto, tipo, limite máximo, e os montantes mínimos e máximos aplicáveis ao pagamento.

• Corpo da resposta:

  • json

  json

          
  {
      "status": "success",
      "description": "Descrição do cupom exibida aos clientes, por exemplo, em interfaces, faturas ou recibos",
      "legal_terms": "URL dos termos e condições para fins legais",
      "details": {
         "value": 10.0,
         "type": "percent",
         "cap": 1000.0,
         "min_payment_amount": 100.0,
         "max_payment_amount": 10000.0
      }
  }
  
  
        

  Copiar

2. Cupom com desconto pronto para uso

• Código de status: 200 (Sucesso)

• Descrição: resposta confirmando que o cupom está pronto para uso, aguardando aplicação em um pagamento. Detalhes do desconto e termos legais estão incluídos.

• Corpo da resposta:

  • json

  json

          
  {
      "status": "pending",
      "description": "Descrição do cupom, como exibido para os clientes em interfaces, faturas ou recibos.",
      "legal_terms": "URL dos termos e condições para fins legais.",
      "details": {
         "value": 10.0,
         "type": "percent",
         "cap": 1000.0,
         "min_payment_amount": 100.0,
         "max_payment_amount": 10000.0
      }
  }
  
  
        

  Copiar

3. Cupom sem desconto associado

• Código de status: 200

• Descrição: resposta que indica que o cupom enviado é inválido e não possui um desconto associado a ele.

• Corpo da resposta:

  • json

  json

          
  {
      "status": "invalid"
  }
  
  
        

  Copiar

1. Requisição mal formulada

• Código de status: 400 (Bad Request).

• Descrição: resposta de erro indicando que a requisição foi mal formulada. Inclui uma mensagem de erro detalhada com o código de status correspondente.

• Corpo da resposta:

  • json

  json

          
  {
    "error": "bad_request",
    "message": "mensagem de erro detalhada",
    "status": 400
  }
  
  
        

  Copiar

2. Coupon_id inválido

• Código de status: 400 (Bad Request).

• Descrição: resposta de erro indicando que o coupon_id enviado no request é inválido.

• Corpo da resposta:

  • json

  json

          
  {
    "error": "bad_request",
    "message": "Invalid coupon_id.",
    "status": 400
  }
  
        

  Copiar

3. Payer_token inválido

• Código de status: 400 (Bad Request).

• Descrição: resposta de erro indicando que o payer_token enviado no request é inválido.

• Corpo da resposta:

  • json

  json

          
  {
    "error": "bad_request",
    "message": "Invalid payer token.",
    "status": 400
  }
  
        

  Copiar