Cancel Transaction

This route is used when you want to cancel an Authorization. Only the transaction's transaction_id is required for the cancellation to be effective, passed in the endpoint's PATH.

Note

Only transactions with authorized status can be canceled.

POSTv1/cancel/:transaction_id

Request Path Variable

Attribute	Type	Description
transaction_id	string	Transaction ID to be canceled.

Attention

It is necessary to save the transaction_id that Marlim returns in transaction requests in your application. Only with this id will it be possible to proceed with the cancellation.

Samples

Status Canceled

Request

curl -X POST "https://api.wu.global.marlim.co/v1/cancel/55554444" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'

Response200

{
  "status": "canceled",
  "nsu": "55554444",
  "order_id": "123456789",
  "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": 0,
  "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"
}

Previously Canceled Transaction

Request

curl -X POST "https://api.wu.global.marlim.co/v1/cancel/55554444" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'

Response400

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

Transaction Not Found

Request

curl -X POST "https://api.wu.global.marlim.co/v1/cancel/12345678" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'

Response400

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