Caso de uso

"Preciso que meu cliente consiga realizar o envio de uma solicitação de ordem de cancelamento via API para a máquina."

O que é uma ordem de cancelamento?

Uma Ordem de cancelamento é uma solicitação iniciada pelo Merchant usando a API Safe2Pay. O Merchant envia o id da ordem de pagamento, através da API. A API Safe2Pay valida e processa este pedido, comunica-se com o POS para a realização do cancelamento pelo cliente, e, após o processamento do cancelamento, envia um retorno (callback) sobre o sucesso ou falha do cancelamento ao Merchant.

Diagrama de fluxo

Criação de uma ordem de cancelamento

Para realizar a criação de uma Ordem, você pode utilizar a API Criar Ordem de Cancelamento

🚧

Pré-requisitos para uso da máquina

Antes de enviar uma solicitação de ordem de pagamento ou cancelamento para o POS, verifique se:

• A máquina está ativa.
• O aplicativo Safe2Pay está aberto.
• O usuário está logado no aplicativo.

🚧

Nível mínimo de bateria

Assegure-se de que a máquina tenha pelo menos 6% de bateria para receber as ordens.

🚧

Prazo para cancelamentos

Cancelamentos devem ser efetuados dentro do mesmo dia em que a transação foi realizada. Após este período, não será mais possível cancelar a transação.

📘

Passos para efetuar o cancelamento na máquina

Para processar um cancelamento na máquina, siga estas etapas:

1. Validação dos Dados: Confirme os detalhes do cancelamento, como número da ordem, data e valor.
2. Acesso à Máquina: Insira o usuário e senha da máquina.
3. Cartão do Cliente: Passe ou aproxime o cartão do cliente na máquina.

Exemplos de payloads de retorno

{
    "data": {
        "title": "Não foi possível concluir a operação. Um ou mais erros ocorreram.",
        "errors": [
            {
                "message": "A ordem de pagamento não possui transação vinculada para ser cancelada. Por favor, verifique os dados informados e tente novamente."
            }
        ]
    }
}

{
    "data": {
        "title": "Não foi possível concluir a operação. Um ou mais erros ocorreram.",
        "errors": [
            {
                "message": "Não foi possível concluir a operação. A transação não está autorizada."
            }
        ],
        "traceId": 9221403819148546145
    }
}

{
    "data": {
        "title": "Não foi possível concluir a operação. Um ou mais erros ocorreram.",
        "errors": [
            {
                "message": "A máquina está inoperante."
            }
        ],
        "traceId": 7403863412448116474
    }
}

{
    "data": {
        "title": "Não foi possível concluir a operação. Um ou mais erros ocorreram.",
        "errors": [
            {
                "message": "A ordem de pagamento não foi encontrada ou não existe. Por favor, verifique os dados informados e tente novamente."
            }
        ]
    }
}

{
  "title": "Não foi possível concluir a operação. Um ou mais erros ocorreram.",
  "errors": [
    {
      "message": "Não foi possível realizar a autenticação com os parâmetros informados."
    }
  ]
}

Códigos de resposta