Cancel

POST 
/:payByLinkId/cancel

Cancel a Pay-by-Link.

warning

For technical reasons, cancelling a Pay-by-Link does not prevent customers from finishing a transaction in all cases. In case the customer was redirected to the PSP's payment page, they could still conduct and finish the payment. Depending on your use case, you must ensure to have remediation mechanisms in place to prevent double payments.

When using Payment Selection Pages, cancellation of the transaction is only possible up to the point where the customer did not yet choose a payment method.

Request

Path Parameters

payByLinkId stringrequired

Possible values: <= 50 characters

ID of the Pay-by-Link.

The value for payByLinkId can be extracted from the cancelUrl of the payByLinkData response field in the Transaction API.

Responses

200

Successfully cancelled a Pay-by-Link.

application/json

Schema

Schema

success boolean

Whether the request was successful.

transactionStatus string

Current status of the transaction

Possible values: [success, error_adapter, error_internal, invalid, pending, pending_postback, await_redirect, await_completion, redirected, cancelled, pending_dcc]

errorCode number

Error message in case of error.

errorMessage string

Error code in case of error.

property name* any

Example (from schema)

{
  "success": true,
  "transactionStatus": "success",
  "errorCode": 0,
  "errorMessage": "string"
}

Example

{
  "success": true,
  "transactionStatus": "cancelled"
}

401

Unauthorized access.

application/json

Schema

Schema

success boolean

Whether the request was successful.

errorCode number

Error message in case of error.

errorMessage string

Error code in case of error.

property name* any

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}

Example

{
  "success": false,
  "errorMessage": "Invalid credentials.",
  "errorCode": 3002
}

422

Cannot cancel anymore because preconditions were violated.

application/json

Schema

Schema

success boolean

Whether the request was successful.

transactionStatus string

Current status of the transaction

Possible values: [success, error_adapter, error_internal, invalid, pending, pending_postback, await_redirect, await_completion, redirected, cancelled, pending_dcc]

errorCode number

Error message in case of error.

errorMessage string

Error code in case of error.

property name* any

Example (from schema)

{
  "success": true,
  "transactionStatus": "success",
  "errorCode": 0,
  "errorMessage": "string"
}

Already expired

{
  "success": false,
  "transactionStatus": "error_internal",
  "errorMessage": "Transaction has already expired and can not be cancelled",
  "errorCode": 1006
}

Not cancellable

{
  "success": false,
  "transactionStatus": "success",
  "errorMessage": "Transaction is not in a state which can be cancelled",
  "errorCode": 1006
}

500

Server error.

application/json

Schema

Schema

success boolean

Whether the request was successful.

errorCode number

Error message in case of error.

errorMessage string

Error code in case of error.

property name* any

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}

Example

{
  "success": false,
  "errorMessage": "Failed to cancel transaction",
  "errorCode": 1008
}

Loading...