Capture – Trust Payments

Use this transaction to capture a previously authorized transaction.

Endpoint : /capture

Requirements

The capture can be up to 100% of the original authorization.
The capture can only be processed once for a PreAuth.
The transaction can be captured on a different terminal than the original transaction. If no terminalserialnumber is received, the system will use the terminalserialnumber used in the PreAuth.

Capture Request

{
"amount":"40.00",
"refid":"123456789876543212345",
"siteid":"123456",
"txndate":"2023-02-01:16:13:20",
"type":"capture"
}

Request field specification

	Field	Format	Description
Required	amount	String e.g. 20.00	The amount to be captured in main units (e.g. £20 would be submitted as 20.00). The amount submitted cannot be higher than the original PreAuth. Unless captured, any remaining reserved funds will eventually be released back to the customer.
Required	refid	String (min length: 1) e.g. 1234567890	The unique identifier to the transaction being submitted. (The value submitted must be unique within the scope of your own transactions)
Required	siteid	String (min length: 1) e.g. 1234	Unique identification code supplied by Trust Payments.
Required	txndate	String e.g. 2020-03-01:10:20:05	Unique timestamp for the transaction.
Required	type	String	You must submit "capture", as shown in the request example.
Optional	terminalserialnumber	String (min length: 1) e.g. 1234567890	The unique terminal identifier for the PIN Entry Device (PED) supplying the card details. This is the serial number of the PED.

Capture Response

{
"finalamount":"40.00",
"merchantreceipt":"Sample output",
"receipt":"Sample output",
"refid":"123456789876543212345",
"resultcode":"Approved",
"siteid":"123456"
}

Response field specification

	Field	Format	Description
Returned	refid	String e.g. 1234567890	The unique identifier assigned to the transaction submitted.
Returned	resultcode	String e.g. Approved	The result of the transaction from the acquirer. Possible values are: Approved Cancelled Connection Timeout Declined Error Pending Terminal Busy
Returned	siteid	String e.g. 1234	Unique code to identify the Trust Payments site used to process the request.
Conditional	error	String e.g. Invalid amount	The field returns details of an error if a request was not processed successfully. Info on error handling. Only returned if an error has occurred.
Conditional	errorcode	Integer e.g. 1006	This code helps you identify the error if a request was not processed successfully. Info on error handling. Only returned if an error has occurred.
Conditional	finalamount	String e.g. 20.00	The final amount authorised for the transaction in main units (e.g. £20 would be returned as 20.00). Note: The finalamount will include any changes made by the customer during checkout (e.g. addition of a tip). Returned if the finalamount differs from the original amount.
Conditional	merchantreceipt	String e.g. Merchant Receipt	Contains merchant receipt data that can be used for printing on the ePOS. Returned if available.
Conditional	receipt	String e.g. Customer Receipt	Contains cardholder receipt data that can be used for printing on the ePOS. Returned if available.