Capture an Authorized Amount

Request capture of an authorization after you've provided the service/good to the customer. Receive funds by referencing the approved authorization in a capture request. Your processor uses the capture request to initiate settlement, resulting in a funds transfer between the customer's credit card account and your bank account.

SecurityApiKeyAuth

Request

header Parameters

required

string

Initialization Vector for database encryption.

Request Body schema:
application/UNENCRYPTED—DO_NOT_SEND+json

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.

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.

amount

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

The TOTAL amount of the transaction.

tipAmount

number <double> (TipAmount) <= 999999999.99

The amount of any tip or gratuity.

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

400

Bad Request

401

Unauthorized access

403

Access forbidden

409

Conflict.

429

Too Many Requests

post/transactions/capture

Request samples

{"deviceAndPeripherals": {"deviceId": "A-10000",
"peripheralId": ["ABC-101",
"ABC-102",
"ABC-103"
]
},
"batchName": "AA-001",
"transactionId": "2NQREPK134YN90W",
"amount": 2050.99,
"tipAmount": 15.45,
"userDefinedFields": {"custom_field1": "Custom value 1",
"custom_field2": "Custom value 2"
},
"echo": "Hello World"
}

Response samples

{"transactionMetadata": {"referenceId": "2NQREPK134YN90W",
"transactionId": "2NQREPK134YN90W",
"terminalTransactionId": "2NQREPK134YN90W",
"entryMethod": "string",
"timestamp": "2017-07-21T17:32:28Z"
},
"result": {"approved": "Not Approved",
"responseCode": "st",
"responseDescription": "Approved message.",
"authorizationCode": "string",
"requestedAmount": 1050.99,
"approvedAmount": 1050.99,
"token": "string",
"currencyCode": "USD",
"maskedPan": "string",
"par": "string",
"version": "string",
"cardHolder": "Leonard McCoy",
"avsResult": "string",
"cvvResult": "1",
"cavvResult": "s",
"receipt": {"maskedPan": "string",
"merchantName": "PACESOFT",
"entryMethod": "string"
}
},
"referenceId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"userDefinedFields": {"property1": "string",
"property2": "string"
},
"cryptoKeys": {"deviceEncryptionKey": "7625e224dc0f0ec91ad28c1ee67b1eb96d1a5459533c5c950f44aae1e32f2da3",
"transactionEncryptionKey": "aafeeba6959ebeeb96519d5dcf0bcc069f81e4bb56c246d04872db92666e6d4b"
},
"echo": "Hello World"
}