Void a transaction

Void a payment before payment settlement. A Void prevents the transaction or the order from being sent for settlement.

SecurityApiKeyAuth
Request
header Parameters
IV
required
string

Initialization Vector for database encryption.

Request Body schema:
object (DeviceAndPeripherals)

An object containing the device ID and the ID of any peripherals.

deviceId
string (DeviceId)

The unique identifier for the device.

peripheralId
Array of strings (PeripheralId)

An array containing the IDs of the peripherals used with associated device.

transactionId
string (Guid)

String created by Pace Software APIs to serve as a unique identifier for different resources. Used in to identify resources in a request or response. Most resources are assigned an id.

object (CustomPropertiesInput)

An object containing user-defined key/value pairs.

property name*
additional property
string
echo
string (Echo)

Returns (echos) a user-provided value in the API response.

Responses
200

OK

400

Bad Request

401

Unauthorized access

403

Access forbidden

404

Resource was not found

409

Conflict.

429

Too Many Requests

post/transactions/void
Request samples
{
  • "deviceAndPeripherals": {
    },
  • "transactionId": "2NQREPK134YN90W",
  • "userDefinedFields": {
    },
  • "echo": "Hello World"
}
Response samples
{
  • "transactionMetadata": {
    },
  • "result": {
    },
  • "userDefinedFields": {
    },
  • "referenceId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "cryptoKeys": {
    },
  • "echo": "Hello World"
}
Copyright © Pace Software 2021–2023. All rights reserved.