Skip to content

Cancellation

Info

This transaction type is available for: Cards, BLIK, and PayByLink.

A cancellation is performed against a previous payment authorisation (AUTH), by referencing its transactionID and sending a POST request over HTTPS to the /payments/{transactionID}/cancellation endpoint.

When canceling a payment and if sent within the time-frame the authorisation is not captured yet, the cancellation causes an authorisation reversal request to be sent to the card issuer to clear the funds held against the authorisation.

It can be a full cancellation when the total amount of the authorisation is cancelled by the merchant, or a partial, when a subtotal of the total authorisation is cancelled by the merchant.

Generate the transaction:
POST https://stargate-cer.qly.site1.sibs.pt/api/v1/payments/{transactionID}/cancellation
Header parameters
Content-type

string

Mandatory

application/json

Show more
Authorization

string

Mandatory

Bearer Token. Based on OAuth2 authentication performed in a pre-step.

Show more
x-ibm-client-id

string

Mandatory

Token that identifies a client organization. It is provided during onboarding process and must be used in every call.

Show more
Request parameters
Merchant

object

Mandatory

An optional element to query transaction status.

Show more
TerminalID

numeric [<= 10 characters]

Mandatory

Merchant Terminal Identification.

Show more
Channel

string

Mandatory

Merchant channel, Possible Value “Web”.

Show more
merchantTransactionID

string

Mandatory

Unique Id used by the Merchant.

Show more
Transaction

object

Mandatory

An optional element to query transaction status.

Show more
transactionTimeStamp

Date ISODate Time

Mandatory

Transaction timestamp.

Show more
Description

string <= 70 characters

Mandatory

Transaction short description.

Show more
amount
Mandatory

Parameter with the value and currency of the transaction.

Show more
Value

number Double

Mandatory

Amount in the transaction.

Show more
Currency

Currency Code
SO 4217 Alpha-3 Code

Mandatory
Show more
originalTransaction
Mandatory

Parameter with the original transaction.

Show more
Id

string

Mandatory

Unique identifier of the original transaction.

Show more
Date time

date ISODate Time

Mandatory

Timestamp of the original transaction.

Show more

Here’s an example of a cancellation message:

Request Header:
Autorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6I (...)
X-IBM-Client-Id: b4480347-9fc8-4790-b359-100a99c60ea3
Content-Type: application/json
{
 "merchant": {
 "terminalId": 24,
 "channel": "web",
 "merchantTransactionId": "BO_Order Id: c9876bcasd"
 },
 "transaction": {
 "transactionTimestamp": "2022-05-29T18:23:41.367Z",
 "description": "This is a cancellation request",
 "amount": {
 "value": 5,
 "currency": "PLN"
 },
 "originalTransaction": {
 "id": "1ach2CGpZ2BAKUfqJ9Rp",
 "datetime": "2022-05-29T17:23:36.105Z"
 }
 }
}