Merchant transactions

Cancel merchant transaction

Cancel a previously created merchant transaction.

This endpoint allows for the creation of cancellation transactions that reverse the financial impact of original sale transactions. Cancellation transactions maintain negative amounts of all financial values (amount, MDR, fees) and reference the original transaction via origin_merchant_transaction_id.

When the original transaction was split, the cancellation status is automatically set to WAITING_SPLIT, otherwise it follows the default status (SCHEDULED).

This endpoint generates a Merchant transaction created event.

post/v1/marketplaces/{marketplaceId}/merchants/{merchantId}/transactions/cancel

Request

  • Base URL
    https://sandbox.pismolabs.io/sellers
  • URL
    https://sandbox.pismolabs.io/sellers/v1/marketplaces/{marketplaceId}/merchants/{merchantId}/transactions/cancel
  • Auth
    HTTP bearer

Path parameters

marketplaceIdinteger required

Marketplace ID

merchantIdinteger required

Merchant ID

Headers

Authorizationstring required

Authorization token

Request body

event_datestring datetime required

Event datetime. The datetime format follows the ISO 8601 format (UTC).

amountnumber float required

Merchant transaction amount

processing_codestring required

Processing code.<br> For more information, refer to Processing codes.

Example request

{
  "event_date": "2023-01-01T12:00:00Z",
  "processing_code": "999999"
}

Response

Successfully list merchant transactions

Example response

{
  "items": [
    {
      "merchant_id": 1,
      "installment": 1,
      "number_of_installments": 1,
      "event_date": "2023-01-01T12:00:00Z",
      "scheduled_payment_date": "2023-01-02",
      "marketplace_id": 1,
      "currency_code": "BRL",
      "discount_amount": 1.99,
      "discount_details": [
        {
          "name": "EMISSION_FEE",
          "amount": 10
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.