Refund a Transaction

Refund a credit cardholder after the payment was successfully settled.

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.

batchName
string (BatchName)

Optional, merchant-assigned name for a batch of transactions. The system creates a default batch name of System for transactions that do not include this element. When used, the value for this element should be stored and passed in the Batch Close transaction.

amount
number <double> (Amount) [ 0 .. 999999999.99 ]

The TOTAL amount of the transaction.

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.

isOnlineRefund
boolean

Whether refund is an online refund.

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/refund
Request samples
{
  • "deviceAndPeripherals": {
    },
  • "batchName": "AA-001",
  • "amount": 2050.99,
  • "transactionId": "2NQREPK134YN90W",
  • "isOnlineRefund": true
}
Response samples
{
  • "transactionMetadata": {
    },
  • "result": {
    },
  • "referenceId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "userDefinedFields": {
    },
  • "cryptoKeys": {
    }
}
Copyright © Pace Software 2021–2023. All rights reserved.