GuidesAPI ReferenceDiscussions

Card Deposits via Payper/Paybilt - ApplePay/GooglePay

Suggest Edits

The following method IDs are covered in this section:

IDNameCredit/Debit State
300AppleECMCDepositAuthorisedByProvider (13)
CapturedByProvider (27)
298AppleVisaDepositAuthorisedByProvider (13)
CapturedByProvider (27)

Payment method interaction type: Synchronous Execution (see Interaction Types)

Redirect Integration

There are no specific steps for initiating Card Deposits with Redirect Integration. Refer to Initiate New Payment (Redirect) for the standard steps.

Backend2Backend Integration

To initiate a card deposit the initiatePayment web method should be invoked. The following table contains the providerID that can be passed in the specificPaymentData collection:

key (value type, account type, required)value
PaymentProviderID (string)Payment provider, 212 for Payfacto, 211 for Moneris

ApplePay/GooglePay

The following are ApplePay/GooglePay payments to be sent after the merchant has decrypted the ApplePay/GooglePay token.

Sample ApplePay request:

<initiatePaymentRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.cqrpayments.com/PaymentProcessing">
	<merchantID>B2BTestMerchant</merchantID>
	<shopID>PayperCCMockShop</shopID>
	<merchantTransactionID>5e676ccd-3716-47e9-9aa4-923fd22bcba9</merchantTransactionID>
	<paymentMethodID>300</paymentMethodID>
	<amount currencyCode="CAD">100</amount>
	<userID>88c339bb-eb44-4620-80f8-8d8445</userID>
	<userData>
		<username>88c339bb-eb44-4620-80f8-8d8445</username>
		<firstname>Cristian</firstname>
		<lastname>C</lastname>
		<currencyCode xsi:nil="true" />
		<languageCode xsi:nil="true" />
		<email>[email protected]</email>
		<address>
			<street>1St Street</street>
			<houseName xsi:nil="true" />
			<houseNumber>23</houseNumber>
			<houseNumberExtension xsi:nil="true" />
			<postalCode>L8R2L1</postalCode>
			<city>Vienna</city>
			<state>Ontario</state>
			<countryCode2>CA</countryCode2>
			<telephoneNumber>+12264445555</telephoneNumber>
		</address>
		<identificationNumberType xsi:nil="true" />
		<drivingLicenseNumber xsi:nil="true" />
		<drivingLicenseIssuingState xsi:nil="true" />
		<globalUserID xsi:nil="true" />
		<nationality xsi:nil="true" />
		<identificationIssuingCountry xsi:nil="true" />
	</userData>
	<userIP>127.0.0.1</userIP>
	<userSessionID>f6707363-c20f-4863-b217-a01085fd51ed</userSessionID>
	<creationTypeID>1</creationTypeID>
	<specificPaymentData>
		<data xsi:type="keyStringValuePair">
			<key>PaymentDescription</key>
			<value>45e40642-3807-465f-a2be-ab970243420e</value>
		</data>
		<data xsi:type="keyStringValuePair">
			<key>PaymentDescriptionLanguageCode</key>
			<value>en</value>
		</data>
		<data xsi:type="keyIntValuePair">
			<key>ThreeDSecureCheckResult</key>
			<value>4</value>
		</data>
		<data xsi:type="keyStringValuePair">
			<key>ThreeDSecureECI</key>
			<value>02</value>
		</data>
		<data xsi:type="keyStringValuePair">
			<key>ThreeDSecureCAVV</key>
			<value>AJqTIRIV2gpaAAGTIPvHAoABFA==</value>
		</data>
		<data xsi:type="keyIntValuePair">
				<key>PaymentProviderID</key>
				<value>211</value>
		</data>
	</specificPaymentData>
	<paymentAccount>
		<specificPaymentAccountData>
			<data xsi:type="keyStringValuePair">
				<key>CardNumber</key>
				<value>5457350099887768</value>
			</data>
			<data xsi:type="keyStringValuePair">
				<key>HolderName</key>
				<value>004d15b4-b834-4276-8910-b2d39e54de85</value>
			</data>
			<data xsi:type="keyIntValuePair">
				<key>ExpiryMonth</key>
				<value>1</value>
			</data>
			<data xsi:type="keyIntValuePair">
				<key>ExpiryYear</key>
				<value>2099</value>
			</data>
			<data xsi:type="keyStringValuePair">
				<key>CardVerificationCode</key>
				<value>111</value>
			</data>
		</specificPaymentAccountData>
	</paymentAccount>
</initiatePaymentRequest>

Sample GooglePay request:

<?xml version="1.0" encoding="utf-8"?>
<initiatePaymentRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.cqrpayments.com/PaymentProcessing">
	<merchantID>B2BTestMerchant</merchantID>
	<shopID>PaybiltGWMockShop</shopID>
	<merchantTransactionID>18b217b3-c1c6-4b99-b3ff-ae2a7495544d</merchantTransactionID>
	<paymentMethodID>413</paymentMethodID>
	<amount currencyCode="CAD">10</amount>
	<userID>2ecebf21-11e4-44c5-9ddf-78fe3d8a737b</userID>
	<userData>
		<username>2ecebf21-11e4-44c5-9ddf-78fe3d8a737b</username>
		<firstname xsi:nil="true" />
		<lastname xsi:nil="true" />
		<currencyCode xsi:nil="true" />
		<languageCode xsi:nil="true" />
		<email xsi:nil="true" />
		<address xsi:nil="true" />
		<identificationNumberType xsi:nil="true" />
		<drivingLicenseNumber xsi:nil="true" />
		<drivingLicenseIssuingState xsi:nil="true" />
		<globalUserID xsi:nil="true" />
		<nationality xsi:nil="true" />
		<identificationIssuingCountry xsi:nil="true" />
	</userData>
	<userIP>127.0.0.1</userIP>
	<userSessionID>820e63da-b291-4804-9be5-be15c696490f</userSessionID>
	<creationTypeID>1</creationTypeID>
	<specificPaymentData>
		<data xsi:type="keyStringValuePair">
			<key>PaymentDescription</key>
			<value>descr</value>
		</data>
		<data xsi:type="keyStringValuePair">
			<key>PaymentDescriptionLanguageCode</key>
			<value>en</value>
		</data>
		<data xsi:type="keyIntValuePair">
			<key>ThreeDSecureCheckResult</key>
			<value>4</value>
		</data>
		<data xsi:type="keyStringValuePair">
			<key>ThreeDSecureCAVV</key>
			<value>Vnu+KFZ7xyhGd+VJncGbeK1nZ1A=</value>
		</data>
		<data xsi:type="keyStringValuePair">
			<key>ThreeDSecureECI</key>
			<value>07</value>
		</data>
		<data xsi:type="keyIntValuePair">
			<key>PaymentProviderID</key>
			<value>212</value>
		</data>
	</specificPaymentData>
	<paymentAccount>
		<specificPaymentAccountData>
			<data xsi:type="keyStringValuePair">
				<key>CardNumber</key>
				<value>4111111111111111</value>
			</data>
			<data xsi:type="keyIntValuePair">
				<key>ExpiryMonth</key>
				<value>1</value>
			</data>
			<data xsi:type="keyIntValuePair">
				<key>ExpiryYear</key>
				<value>2099</value>
			</data>
			<data xsi:type="keyStringValuePair">
				<key>HolderName</key>
				<value>Sir Stenley Roise</value>
			</data>
		</specificPaymentAccountData>
	</paymentAccount>
</initiatePaymentRequest>

Sample ApplePay response:

<?xml version="1.0" encoding="utf-8"?>
<initiatePaymentResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.cqrpayments.com/PaymentProcessing">
	<payment xsi:type="paymentWithPaymentAccount">
		<merchantID>B2BTestMerchant</merchantID>
		<shopID>PaybiltGWMockShop</shopID>
		<paymentMethod>
			<key>298</key>
			<value>AppleVisaDeposit</value>
		</paymentMethod>
		<merchantTransactionID>0a9212b7-0d0a-4baa-8cc2-726215ed71cc</merchantTransactionID>
		<paymentID>7f654d1f-68e3-476f-a442-19d83773c257</paymentID>
		<userID>4e6bfa91-efd6-4269-a49b-52e83e28ba6d</userID>
		<paymentProvider>
			<key>212</key>
			<value>Payfacto</value>
		</paymentProvider>
		<amount currencyCode="CAD">10</amount>
		<creationType>
			<key>1</key>
			<value>User</value>
		</creationType>
		<userIP>127.0.0.1</userIP>
		<state>
			<id>840e29dc-156e-48d5-bdf1-3a9968f89648</id>
			<definition>
				<key>13</key>
				<value>AuthorisedByProvider</value>
			</definition>
			<createdOn>2023-10-31T08:20:17.3768644Z</createdOn>
			<paymentStateDetails>
				<detail xsi:type="keyStringValuePair">
					<key>ProviderResponseCode</key>
					<value>0</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>ProviderResponseMessage</key>
					<value>Approved or completed successfully</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>AVSResponse</key>
					<value>Y</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>AVSResponseMessage</key>
					<value>Exact match</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>CVCResponse</key>
					<value>Matched</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>ApprovalCode</key>
					<value>581151</value>
				</detail>
			</paymentStateDetails>
		</state>
		<isExecuted>true</isExecuted>
		<baseAmount currencyCode="EUR">7.22</baseAmount>
		<paymentDetails>
			<detail xsi:type="keyStringValuePair">
				<key>ThreeDSecureVersion</key>
				<value>1.0.2</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>CardholderAuthenticationVerificationValue</key>
				<value>jLRabyR3C2QaABEAAFHSuWJ7w5g=</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>ElectronicCommerceIndicator</key>
				<value>07</value>
			</detail>
			<detail xsi:type="keyIntValuePair">
				<key>PaymentProviderID</key>
				<value>212</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>ProviderTransactionID</key>
				<value>581151501135800320777992996352</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>ProviderExternalID</key>
				<value>116361</value>
			</detail>
			<detail xsi:type="keyIntValuePair">
				<key>PaymentMethodID</key>
				<value>298</value>
			</detail>
			<detail xsi:type="keyIntValuePair">
				<key>PaymentProviderID</key>
				<value>212</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>PaymentAccountID</key>
				<value>ac62dec3-7f00-40ba-8656-4a84912a1064</value>
			</detail>
		</paymentDetails>
		<paymentAccount>
			<paymentAccountID>ac62dec3-7f00-40ba-8656-4a84912a1064</paymentAccountID>
			<details>
				<detail xsi:type="keyStringValuePair">
					<key>MaskedNumber</key>
					<value>411111******1111</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>AccountOwnerToken</key>
					<value>532ea578-41fb-4132-a159-c4bcdc091c0a</value>
				</detail>
				<detail xsi:type="keyIntValuePair">
					<key>ExpiryMonth</key>
					<value>1</value>
				</detail>
				<detail xsi:type="keyIntValuePair">
					<key>ExpiryYear</key>
					<value>2099</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>HolderName</key>
					<value>Sir Stenley Roise</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>CardType</key>
					<value>Visa</value>
				</detail>
			</details>
		</paymentAccount>
	</payment>
</initiatePaymentResponse>

Sample GooglePay response:

<?xml version="1.0" encoding="utf-8"?>
<initiatePaymentResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.cqrpayments.com/PaymentProcessing">
	<payment xsi:type="paymentWithPaymentAccount">
		<merchantID>B2BTestMerchant</merchantID>
		<shopID>PaybiltGWMockShop</shopID>
		<paymentMethod>
			<key>413</key>
			<value>GoogleVisaDeposit</value>
		</paymentMethod>
		<merchantTransactionID>18b217b3-c1c6-4b99-b3ff-ae2a7495544d</merchantTransactionID>
		<paymentID>08cb7cfe-4d9a-4a33-8f4f-6f073eb6a706</paymentID>
		<userID>2ecebf21-11e4-44c5-9ddf-78fe3d8a737b</userID>
		<paymentProvider>
			<key>212</key>
			<value>Payfacto</value>
		</paymentProvider>
		<amount currencyCode="CAD">10</amount>
		<creationType>
			<key>1</key>
			<value>User</value>
		</creationType>
		<userIP>127.0.0.1</userIP>
		<state>
			<id>7e262f20-3077-4f55-affb-d997930d910b</id>
			<definition>
				<key>13</key>
				<value>AuthorisedByProvider</value>
			</definition>
			<createdOn>2023-11-06T12:58:02.3849962Z</createdOn>
			<paymentStateDetails>
				<detail xsi:type="keyStringValuePair">
					<key>ProviderResponseCode</key>
					<value>0</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>ProviderResponseMessage</key>
					<value>Approved or completed successfully</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>AVSResponse</key>
					<value>Y</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>AVSResponseMessage</key>
					<value>Exact match</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>CVCResponse</key>
					<value>Matched</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>ApprovalCode</key>
					<value>627428</value>
				</detail>
			</paymentStateDetails>
		</state>
		<isExecuted>true</isExecuted>
		<baseAmount currencyCode="EUR">7.22</baseAmount>
		<paymentDetails>
			<detail xsi:type="keyStringValuePair">
				<key>ThreeDSecureVersion</key>
				<value>1.0.2</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>CardholderAuthenticationVerificationValue</key>
				<value>Vnu+KFZ7xyhGd+VJncGbeK1nZ1A=</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>ElectronicCommerceIndicator</key>
				<value>07</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>ProviderTransactionID</key>
				<value>627428365157117416222296278185</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>ProviderExternalID</key>
				<value>118618</value>
			</detail>
		</paymentDetails>
		<paymentAccount>
			<paymentAccountID>ae8d545c-2831-472d-902b-6c364301ada9</paymentAccountID>
			<details>
				<detail xsi:type="keyStringValuePair">
					<key>MaskedNumber</key>
					<value>411111******1111</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>AccountOwnerToken</key>
					<value>532ea578-41fb-4132-a159-c4bcdc091c0a</value>
				</detail>
				<detail xsi:type="keyIntValuePair">
					<key>ExpiryMonth</key>
					<value>1</value>
				</detail>
				<detail xsi:type="keyIntValuePair">
					<key>ExpiryYear</key>
					<value>2099</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>HolderName</key>
					<value>Sir Stenley Roise</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>CardType</key>
					<value>Visa</value>
				</detail>
			</details>
		</paymentAccount>
	</payment>
</initiatePaymentResponse>

Updated 6 months ago