head

Pass this parameter in all gateway requests regarding checkout, delivery and post-checkout

↔ Request/Response parameter

<head>

XML Examples

RequestResponse
Copy
Copied
ratepay.api.pay.payment-request.request.head.xml

<head>
	<system-id>myshop</system-id>
	<transaction-id>A12B3CD23J3KU324DADK</transaction-id>
	<operation subtype="cancellation">PAYMENT_CHANGE</operation>
	<credential>
		<profile-id>account123</profile-id>
		<securitycode>6cddf6b3a0e03412b0f3c0615616025a</securitycode>
	</credential>
	<external>
		<order-id>O-1234-HDZ</order-id>
		<merchant-consumer-id>CUSTOMER4711</merchant-consumer-id>
		<tracking>
			<id provider="HLG">12345</id>
			<id provider="DPD">678910</id>
		</tracking>
	</external>
	<meta>
		<systems>
			<system 
				name="Shopmodul XY" 
				version="1.2.2beta"
			></system>
			<api-version>1.8</api-version>
		</systems>
	</meta>
</head>
Copy
Copied
ratepay.api.pay.payment-request.response.head.xml

<head>
	<system-id>myshop</system-id>
	<transaction-id>A12B3CD23J3KU324DADK</transaction-id>
	<operation>PAYMENT_REQUEST</operation>
	<response-type>PAYMENT_PERMISSION</response-type>
	<external>
		<order-id>O-1234-HDZ</order-id>
		<merchant-consumer-id>CUSTOMER4711</merchant-consumer-id>
		<merchant-consumer-classification>neutral</merchant-consumer-classification>
	</external>
	<processing>
		<timestamp>2012-04-30T12:27:39.234</timestamp>
		<status code="OK">Successfully</status>
		<reason code="700">Request successful</reason>
		<result code="402">Transaction result pending</result>
	</processing>
</head>