701 – Request Capture Authorization

Allows the merchant to submit a request to capture an authorized only transaction previously submitted and approved using the 700 command.

701 Request Data description:

NODE	INCLUDE IN CHECKSUM (IN THIS ORDER)	REQUIRED	DATA TYPE	DESCRIPTION
apiUser	YES (1)	YES	Character max 50.	The API user assigned by the Gateway to the merchant. Can be obtained from the website inside your merchant account.
apiPassword	YES (2)	YES	Character max 50.	The API password assigned by Gateway to the merchant. Can be obtained from the website inside your merchant account.
apiCmd	YES (3)	YES	701	3 digit numeric transaction code must be 701
gatetransid	YES (4)	YES	Character max 50.	Unique gateway internal transaction id, received by the merchant in the 850 Notification of the originating transaction.
amount		Opt	Number with point decimal	Optionally may be Required, depending on setting in Merchant Profile. Will be in currency of the original authorization transaction. The amount for capture may not exceed the amount in the authorized transaction. Decimal separator must be point (.). example: 125.45 = One hundred and twenty-five Major Currency Units with forty-five Minor Currency Units.
carrier		Opt	Character max 50.	Optionally may be Required, depending on setting in Merchant Profile. Must be one of the following: USPS, FedEx, UPS, DHL, Canada, TNT
trackingnumber		Opt	Character max 100.	Optionally may be Required, depending on setting in Merchant Profile. This is the tracking number provided by the carrier
checksum		YES	Character no limit	SHA-1 calculated using the fields specified by the transaction plus the API key assigned by gateway to the merchant. This field must be calculated using the fields marked as “Include in checksum” (in the order indicated) plus the API key at the end.

701 Response Data description

NODE	REQUIRED	DATA TYPE	DESCRIPTION
result	YES	Character	Result indicates the result of the transaction. SUCCESS: Transaction has been Captured PENDING: Request for Capture has been accepted but yet processed. (Can happen in case of transactions which need to be confirmed by staff or when tracking number provided). After the Capture has been processed, the results will be sent in the 850 Transaction State Notification that will be sent from the system server to the merchant server. Do NOT ASSUME the pending request as APPROVED or DECLINED. ERROR: means error detected in the request, no processing takes place, and transaction was not accepted by the system.
gatetransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
errorcode	YES	Character 3	Error Code of the transaction or 000 if no error condition found.
errormessage	YES	Character max 100	Full description of the error.
description	OPT	Character no limit	Optional details of the transaction except in the case of DECLINED and then the reason for the decline. May be null.

Creating users

CURL

The 701 request is plain XML that contains the following data:

  <?xmlversion="1.0" encoding="utf-8" ?>
	<transaction>
		<apiUser> </apiUser>
		<apiPassword> </apiPassword>
		<apiCmd> </apiCmd>
		<gatetransid> </gatetransid>
		<amount> </amount>
		<carrier> </carrier>
		<trackingnumber> </trackingnumber>
		<checksum> </checksum>		
	</transaction> 
							  

The response to a 701 - Request Capture Authorization is plain xml un-encoded that contains the following data:

	<?xmlversion="1.0" encoding="utf-8" ?>
	<transaction>
		<result> </result>
		<merchanttransid> </merchanttransid>
		<gatetransid> </gatetransid>
		<errorcode> </errorcode>
		<errormessage> </errormessage>
		<description> </description>
	</transaction> 

PHP

The 701 request is PHP that contains the following data:

  require_once 'autoload.php';

use Omnipay\GPNDataEurope\GPNGateway;
set_time_limit(0);

$gpnGateway = new GPNGateway();
$gpnGateway->setApiKey('APIKEY');
$gpnGateway->setApiPassword('APIPASS');
$gpnGateway->setApiUser('APIUSER');
$gpnGateway->setMode(GPNGateway::PROD_MODE);
$gpnGateway->setPROD('https://txtest.txpmnts.com/api/transaction/');


$params = [
	'gateTransId' => 'F1CD74B9-E94B-1877-DB9F-4A44B82D04EC',
	'amount' => '10.00',
	'carrier' => '',
    'trackingNumber' => '',	
];

try {
	// Capture 701
	$response = $gpnGateway->capture($params)->send();
	printf("%s-%s\n", $response->getCode(), $response->getMessage());
	
echo 'GPN Ref. No : '; print_r($response->getData()->getrefer());
echo 'Description : '; print_r($response->getData()->getmessage());
echo 'Merchant Transaction ID : '; print_r($response->getData()->getmerchantTransId());
echo 'Status : '; print_r($response->getData()->getstatus());
echo 'Status Code : '; print_r($response->getData()->getstatusCode());
echo 'Gateway Transaction ID : '; print_r($response->getData()->gettransId());


} catch (Exception $exc) {
	print_r($exc->getCode(), $exc->getMessage());
}