Sign in

v1

latestOpenAPI 3.0.02026-07-2436163302.7 KB

Cancel a transaction

Cancel a previously submitted transaction.

Cancellation must reference the transaction you want to cancel. It can be the original transaction, a credit note or an adjustment.

Use /cancellation endpoint to cancel a transaction.

post/v1/transactions/cancellation

Request body

country_codestring required

ISO 3166-1 alpha-2 uppercase country code the transaction is taking place in.

Validations:

  • Country code must be uppercase ISO 3166-1 alpha-2.
  • Required property
country_subdivision_codestring

ISO 3166-2 uppercase code of the principal country subdivision (province, state, region) the transaction is taking place in.

Validations:

  • Values allowed are (letter case matters): AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT
  • Country subdivision code is only supported for Canada.
notestring

A text note attached to a transaction. Notes are HTML enabled and will be displayed on the visual document.

Validations:

  • Maximum length: 3000
reference_transaction_idstring required

The external transaction identifier of the original transaction the cancellation is referencing. e.g., MY_ORIGINAL_IDENTIFIER_0001

Validations:

  • Maximum length: 150
  • Either reference_transaction_id or reference_transactions must be provided.
transaction_datestring required

RFC3339 datetime string representing the point in time when transaction is executed.

Validations:

  • Required property
  • Must be an RFC3339 format date
transaction_idstring required

External transaction identifier provided by the customer. e.g., MY_CANCELLATION_IDENTIFIER_0001

Validations:

  • Maximum length: 150
  • Required property

Example request

{
  "note": "This is my HTML <e>enabled</e> note.",
  "tax_reason": {
    "code": "S01",
    "description": "S01",
    "tax_reason_details": [
      {
        "code": "S01",
        "note": "S01"
      }
    ]
  }
}

Response

Accepted - transaction was successfully submitted for processing.

messagestring

Information about the failure reason in case the request was unsuccessful.

operation_idstring

Auto-generated unique identifier of a transaction operation returned upon async operation request.

transaction_idstring

The unique external transaction identifier provided with the initial request.