Documentation

1Introduction

Transactions are after they have been authorized in the state Authorized. An authorized transaction can either be voided or completed. If you void a transaction the reserved amount will be cancelled at the processor.

Important
Transaction can only be voided as long as they are not in the in the state Completed. Voiding a transaction is therefore only possible for transactions done with a payment method that supports deferred completion. If you want to achieve a singular process for all payment methods we recommend to complete the payment immediately. The payment connector list shows which connector supports deferred completion. For information about the payment methods and if they support deferred completion can be found in the payment connector list.

2Integration Details

Before you can complete a transaction you should have considered the following guides

In case you want to cancel a not completed transaction you have to void it. See transaction complete documentation how to complete transactions.

2.1Online vs. Offline Void

A void can be issued in two ways:

  • Online: If you void a transaction online we send the void request directly to the processor.

  • Offline: The offline void simulates the void in our platform but will not send the void to the processor. This feature can be used if you voided the payment already at the processor and you can not send it anymore in the online mode.

2.2Void a Transaction inside the Back Office

Voids can be found in the back office under Space > Payment > Transactions. Open the transaction. In case the transaction is in the state authorized you should find the transaction tab Void. The backend offers an easy and convenient way to issue either online or offline voids.

Note
It can create an inconsistent data if you only change the line items inside the back office and not also in your application.

2.3Void a Transaction Over the Web Service

As long as the transaction is not Completed you can void it and cancel the transaction. The transaction will then move to the state Voided.

In order to void a transaction you have to use the voidOnline or the voidOffline operation on the Transaction Void Service.

Response

	{
	"createdBy": 4,
	"createdOn": "2017-12-07T14:00:12.39Z",
	"failedOn": null,
	"failureReason": null,
	"id": 67,
	"labels": [],
	"language": "de-CH",
	"linkedSpaceId": 396,
	"linkedTransaction": 109741,
	"mode": "ONLINE",
	"nextUpdateOn": null,
	"plannedPurgeDate": "2017-12-28T13:58:54.738Z",
	"processorReference": null,
	"spaceViewId": null,
	"state": "SUCCESSFUL",
	"succeededOn": "2017-12-07T14:00:12.538Z",
	"timeoutOn": "2017-12-07T14:00:12.389Z",
	"transaction": {
		"acceptHeader": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
		"allowedPaymentMethodBrands": [],
		"allowedPaymentMethodConfigurations": [],
		"authorizationAmount": 65,
		"authorizationTimeoutOn": "2017-12-07T14:58:54.202Z",
		"authorizedOn": "2017-12-07T13:58:54.738Z",
		"autoConfirmationEnabled": true,
		"billingAddress": {
			"city": "Zürich",
			"commercialRegisterNumber": null,
			"country": "CH",
			"dateOfBirth": null,
			"dependentLocality": null,
			"emailAddress": "info@customweb.com",
			"familyName": "Customweb",
			"gender": null,
			"givenName": "Admin",
			"legalOrganizationForm": null,
			"mobilePhoneNumber": null,
			"organizationName": "customweb GmbH",
			"phoneNumber": "044 123 45 67",
			"postCode": "8000",
			"postalState": null,
			"salesTaxNumber": null,
			"salutation": "",
			"socialSecurityNumber": null,
			"sortingCode": null,
			"street": "Beispielstrasse 1"
		},
		"chargeRetryEnabled": false,
		"completedOn": null,
		"completionTimeoutOn": "2017-12-07T14:08:54.788Z",
		"confirmedBy": 0,
		"confirmedOn": "2017-12-07T13:58:54.051Z",
		"createdBy": 0,
		"createdOn": "2017-12-07T13:58:17.431Z",
		"currency": "CHF",
		"customerEmailAddress": "info@customweb.com",
		"customerId": "141",
		"customersPresence": "VIRTUAL_PRESENT",
		"endOfLife": "2017-12-28T13:58:54.738Z",
		"failedOn": null,
		"failedUrl": "https://demo2.sellxed.com/magento/wallee/wallee/transaction/failure/order_id/231/secret/b18b0e9eae19e5490c6bd2df279fb91a09919e48ecfafe204ea75e4a74b9e388/",
		"failureReason": null,
		"group": {
			"beginDate": "2017-12-07T13:58:17.436Z",
			"customerId": null,
			"endDate": "2017-12-07T13:58:17.436Z",
			"id": 109747,
			"linkedSpaceId": 396,
			"plannedPurgeDate": "2017-12-07T14:03:17.436Z",
			"state": "SUCCESSFUL",
			"version": 2
		},
		"id": 109741,
		"internetProtocolAddress": "212.90.201.186",
		"internetProtocolAddressCountry": "CH",
		"invoiceMerchantReference": "103000035",
		"language": "de-CH",
		"lineItems": [
			{
				"aggregatedTaxRate": 0,
				"amountExcludingTax": 60,
				"amountIncludingTax": 60,
				"attributes": {
					"color": {
						"label": "Color",
						"value": "Indigo"
					},
					"size": {
						"label": "Size",
						"value": "S"
					}
				},
				"name": "Tori Tank",
				"quantity": 1,
				"shippingRequired": true,
				"sku": "wbk003",
				"taxAmount": 0,
				"taxAmountPerUnit": 0,
				"taxes": [],
				"type": "PRODUCT",
				"uniqueId": "2634",
				"unitPriceExcludingTax": 60,
				"unitPriceIncludingTax": 60
			},
			{
				"aggregatedTaxRate": 0,
				"amountExcludingTax": 5,
				"amountIncludingTax": 5,
				"attributes": {},
				"name": "Flat Rate - Fixed",
				"quantity": 1,
				"shippingRequired": false,
				"sku": "shipping",
				"taxAmount": 0,
				"taxAmountPerUnit": 0,
				"taxes": [],
				"type": "SHIPPING",
				"uniqueId": "shipping",
				"unitPriceExcludingTax": 5,
				"unitPriceIncludingTax": 5
			}
		],
		"linkedSpaceId": 396,
		"merchantReference": "145000039",
		"metaData": {},
		"paymentConnectorConfiguration": {
			"applicableForTransactionProcessing": true,
			"conditions": [],
			"connector": 1465882788941,
			"enabledSpaceViews": [],
			"id": 822,
			"linkedSpaceId": 396,
			"name": "Test - MasterCard",
			"paymentMethodConfiguration": {
				"dataCollectionType": "ONSITE",
				"description": {
					"availableLanguages": [
						"en-US"
					],
					"displayName": "",
					"items": [
						{
							"language": "en-US",
							"languageCode": "en",
							"translation": ""
						}
					]
				},
				"id": 510,
				"imageResourcePath": null,
				"linkedSpaceId": 396,
				"name": "Credit / Debit Card",
				"oneClickPaymentMode": "ALLOW",
				"paymentMethod": 1457546097597,
				"plannedPurgeDate": null,
				"resolvedDescription": {
					"de-DE": "Bezahlen Sie bequem per Kredit- oder Debitkarte.",
					"en-US": "Pay conveniently with your credit or debit card."
				},
				"resolvedImageUrl": "https://app-wallee.com/s/396/resource/icon/payment/method/credit-debit-card.svg",
				"resolvedTitle": {
					"de-DE": "Kredit- / Debitkarte",
					"en-US": "Credit / Debit Card"
				},
				"sortOrder": 1,
				"spaceId": 396,
				"state": "ACTIVE",
				"title": {
					"availableLanguages": [
						"en-US"
					],
					"displayName": "",
					"items": [
						{
							"language": "en-US",
							"languageCode": "en",
							"translation": ""
						}
					]
				},
				"version": 2
			},
			"plannedPurgeDate": null,
			"priority": 0,
			"processorConfiguration": {
				"id": 316,
				"linkedSpaceId": 396,
				"name": "Test",
				"plannedPurgeDate": null,
				"processor": 1448256458282,
				"state": "ACTIVE",
				"version": 0
			},
			"state": "ACTIVE",
			"version": 1
		},
		"plannedPurgeDate": "2017-12-28T13:58:54.738Z",
		"processingOn": "2017-12-07T13:58:54.107Z",
		"refundedAmount": 0,
		"shippingAddress": {
			"city": "Zürich",
			"commercialRegisterNumber": null,
			"country": "CH",
			"dateOfBirth": null,
			"dependentLocality": null,
			"emailAddress": "info@customweb.com",
			"familyName": "Customweb",
			"gender": null,
			"givenName": "Admin",
			"legalOrganizationForm": null,
			"mobilePhoneNumber": null,
			"organizationName": "customweb GmbH",
			"phoneNumber": "044 123 45 67",
			"postCode": "8000",
			"postalState": null,
			"salesTaxNumber": null,
			"salutation": "",
			"socialSecurityNumber": null,
			"sortingCode": null,
			"street": "Beispielstrasse 1"
		},
		"shippingMethod": "",
		"spaceViewId": null,
		"state": "VOIDED",
		"successUrl": "https://demo2.sellxed.com/magento/wallee/wallee/transaction/success/order_id/231/secret/b18b0e9eae19e5490c6bd2df279fb91a09919e48ecfafe204ea75e4a74b9e388/",
		"timeZone": "Europe/Zurich",
		"token": {
			"createdOn": "2017-12-07T10:53:55.86Z",
			"customerEmailAddress": "info@customweb.com",
			"customerId": "141",
			"enabledForOneClickPayment": true,
			"externalId": "4bc461bb-719d-468b-980b-2378f6e3bb33",
			"id": 1571,
			"language": "de-CH",
			"linkedSpaceId": 396,
			"plannedPurgeDate": null,
			"state": "ACTIVE",
			"timeZone": "Europe/Zurich",
			"tokenReference": "141",
			"version": 2
		},
		"userAgentHeader": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36",
		"userFailureMessage": null,
		"userInterfaceType": "IFRAME",
		"version": 16
	},
	"version": 3
}