Skip to main content
POST
/
partner-connect
/
transactions
/
release
Error
A valid request URL is required to generate request examples
{
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "void"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Requires the transactionId of the locked transaction to be released in the request body.

​
transactionId
string<uuid>
required

Unique transaction identifier.

Response

Transaction successfully released (voided). The authorization hold on the customer's funds has been removed and the transaction status has been updated to void. This operation cannot be reversed.

​
transactionId
string<uuid>
required

The unique identifier (UUID) of the voided transaction (same as the authorization ID).

​
status
enum<string>
required

The updated status of the transaction, which will be void.

Available options:
locked,
captured,
void,
refunded
​
cardId
string<uuid>

The unique identifier (UUID) assigned to the successfully bound card. Store this cardId securely, as it is required to reference this card in all subsequent transaction requests (/verify, /purchase, etc.).

​
refId
string

A unique transaction identifier provided for the client’s reference. It can be used to track or correlate transactions

Example:

"CT6KQDDEC2"