Cancelar transação

Introdução

Este guia explica como cancelar uma transação através da API REST.

Pré-requisitos para cancelar uma transação

O cancelamento de uma transação somente poderá ser solicitada quando:

• A transação deve estar no status inicial (status waiting).

Como usar?

Faça uma requisição PUT para o endpoint /credit/transactions/{transaction_id}/cancel

Com um token de acesso válido, faça uma requisição para o endpoint (PUT/credit/transactions/{transaction_id}/cancel).

A resposta esperada no sucesso da requisição é um JSON contendo o status como "canceled", como o exemplo seguinte:

{
  "status": "canceled"
}

Para mais informações sobre os status, veja a guia Enumerados.

Caso algum erro aconteça, a resposta de retorno é um JSON contendo o erro e o código do erro:

{
  "error": {
    "code": "40004",
    "description": "transaction id is invalid"
  }
}

A seguir uma lista dos possíveis erros retornados pelo serviço:

HTTP Code	Código	Descrição	Motivo
400	40004	transaction id is invalid	O ID da transação é inválido (formato)
400	40009	transaction status is invalid	O status da transação não permite o cancelamento
403	40301	not allowed	O usuário não tem permissão para fazer tal ação
404	40401	transaction not found	A transação não foi encontrada
500	50001	internal error	Falha interna no serviço

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.