Confirmation Deliver

The merchant must inform Ratepay about the (physical) shipping of the ordered goods the same day the goods are dispatched.

The merchant must therefore send a Confirmation Deliver request to Ratepay which triggers the proper processing of the receivables.

warning

The sending of a Confirmation Deliver (aka “CD”) is crucial for every Ratepay transaction which has not been cancelled.

Request Parameters

The merchant can use the CONFIRMATION_DELIVER request to confirm delivery of all the goods or only parts of the ordered goods.

<head> Section

Parameter Condition Enumeration
system-id Mandatory
transaction-id Mandatory
​operation​ Mandatory CONFIRMATION_DELIVER
​credential​ Mandatory
​external​ Optional
​meta​ Optional

<content> Section

Parameter Condition Type
invoicing Optional invoicingType
shopping-basket Mandatory shoppingBasketType
attention

A Confirmation Deliver request always contains the list of shopping-basket items which were delivered with that particular delivery transaction. That means the merchant uses the Confirmation Deliver message to communicate partial deliveries as well as full deliveries to Ratepay.

XML Examples

requestrequest-with-invoicing-block
Copy
Copied
<?xml version="1.0" encoding="UTF-8"?>
<request version="1.0" xmlns="urn://www.ratepay.com/payment/1_0">
	<head>
		<system-id>MyTestsystem</system-id> 
		<transaction-id>xx-xxxxxxxxxxxxxxxx</transaction-id>
		<operation>CONFIRMATION_DELIVER</operation>
		<credential>
			<profile-id>INTEGRATION_TE_DACH</profile-id>
			<securitycode>4c0a11923fa3433fb168f9c7176429e9</securitycode>
		</credential>
		<external>
			<order-id>O-1234-HDZ</order-id> <!-- optional, but reduces questions in later process, for provider list please see api documentation -->
			<tracking>
				<id provider="DHL">02384208304</id>  <!-- optional, but reduces questions in later process, for provider list please see api documentation -->
			</tracking>
		</external>
		<meta>
			<systems>
				<api-version>1.8</api-version>
			</systems>
		</meta>
	</head>
	<content>
		<invoicing>
			<invoice-id>1234</invoice-id>
		</invoicing>
		<shopping-basket amount="230.00" currency="EUR">
			<items>
				<item article-number="123" quantity="6" tax-rate="19" unit-price-gross="10.00">Artikel A</item>
				<item article-number="234" quantity="1" tax-rate="19" unit-price-gross="100.00">Artikel B</item>
				<item article-number="345" quantity="2" tax-rate="19" unit-price-gross="50.00" discount="-10.00">Artikel C</item> <!-- discount@item may be used for percent vouchers/discounts -->
			</items>
			<discount unit-price-gross="-15.00" tax-rate="19">Rabatt</discount> <!-- discount@shopping-basket may be used for value vouchers/discounts -->
			<shipping unit-price-gross="5.00" tax-rate="19">Versandkosten</shipping>
		</shopping-basket>		
	</content>
</request>
Copy
Copied
<?xml version="1.0" encoding="UTF-8"?>
<request version="1.0" xmlns="urn://www.ratepay.com/payment/1_0">
	<head>
		<system-id>MyTestsystem</system-id> 
		<transaction-id>xx-xxxxxxxxxxxxxx</transaction-id>
		<operation>CONFIRMATION_DELIVER</operation>
		<credential>
			<profile-id>INTEGRATION_TE_DACH</profile-id>
			<securitycode>4c0a11923fa3433fb168f9c7176429e9</securitycode>
		</credential>
		<external>
			<order-id>O-1234-HDZ</order-id> <!-- optional, but reduces questions in later process, for provider list please see api documentation -->
			<tracking>
				<id provider="DHL">02384208304</id>  <!-- optional, but reduces questions in later process, for provider list please see api documentation -->
			</tracking>
		</external>
		<meta>
			<systems>
				<api-version>1.8</api-version>
			</systems>
		</meta>
	</head>
	<content>
		<invoicing>
	       <invoice-id>12345</invoice-id>
	       <invoice-date>2017-05-25T10:54:59</invoice-date>
	       <delivery-date>2017-05-25T10:54:59</delivery-date>
	       <due-date>2017-11-22T10:54:59</due-date>
		</invoicing>
		<shopping-basket amount="230.00" currency="EUR">
			<items>
				<item article-number="123" quantity="6" tax-rate="19" unit-price-gross="10.00">Artikel A</item>
				<item article-number="234" quantity="1" tax-rate="19" unit-price-gross="100.00">Artikel B</item>
				<item article-number="345" quantity="2" tax-rate="19" unit-price-gross="50.00" discount="-10.00">Artikel C</item> <!-- discount@item may be used for percent vouchers/discounts -->
			</items>
			<discount unit-price-gross="-15.00" tax-rate="19">Rabatt</discount> <!-- discount@shopping-basket may be used for value vouchers/discounts -->
			<shipping unit-price-gross="5.00" tax-rate="19">Versandkosten</shipping>
		</shopping-basket>	
	</content>
</request>