Estornar Transação

Essa rota é utilizada quando se deseja estornar uma transação. Apenas o transaction_id da transação é necessário para a efetivação do estorno passado no PATH do endpoint.

Nota

Somente transações com o status paid podem ser estornadas.

POSTv1/transactions/:transaction_id/refund

Request Variável Path

Atributo	Tipo	Descrição
transaction_id	string	ID da Transação a ser estornada.

Atenção

É necessário guardar o transaction_id que a Marlim retorna nas requests de transação na sua aplicação. Somente com esse id será possível prosseguir com o estorno.

Exemplos

Status Refunded

Request

curl -X POST "https://api.crypto.foxbit.marlim.co/v1/transactions/55554444/refund" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'

Response200

{
  "status": "refunded",
  "authorization_code": "334455",
  "nsu": "55554444",
  "date_created": "2022-05-04T02:00:00.000Z",
  "date_updated": "2022-05-04T03:00:00.000Z",
  "net_value": 300000,
  "authorized_amount": 320341,
  "paid_amount": 0,
  "refunded_amount": 320341,
  "installments": "3",
  "transaction_id": "55554444",
  "card_holder_name": "Lord Darth Vader",
  "card_brand": "amex",
  "card_first_digits": "777788",
  "card_last_digits": "4444",
  "acquirer_status_code": "0000",
  "acquirer_status_message": "The amount has been refunded to the card."
}

Transação Previamente Estornada

Request

curl -X POST "https://api.crypto.foxbit.marlim.co/v1/transactions/55554444/refund" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'

Response400

{
  "errors": {
    "type": "transaction",
    "message": "Transaction with ID '55554444' is already refunded."
  }
}

Transação Não Encontrada

Request

curl -X POST "https://api.crypto.foxbit.marlim.co/v1/transactions/12345678/refund" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'

Response400

{
  "errors": {
    "type": "transaction",
    "message": "Transaction with ID '12345678' was not found."
  }
}