Credit card deposits (via Kushki)
A white-label card-not-present/B2B solution allowing Merchants to execute SALE transactions.
Note that Deposit payments imply authorisation and capture in a single message.The cut off time on provider side for all Capture requests to be sent to the respective Schema and Issuing Bank is 11pm local Mexico City time. Because of that if a deposit is executed during the day, then until the provider`s cut off time is reached a Cancel/Revert request can still be performed.
Depending on merchant preferences, PXP can make the following setup:
- Immediately move Deposit payment state from AuthorisedByProvider (13) to CapturedByProvider (27) after a successful authorisation response is returned for the respective Deposit payment.
- Delay the automated Deposit payment state swap from AuthorisedByProvider (13) to CapturedByProvider and execute it after the provider cut off time.
Supported Payment Methods to Trigger Card Deposit
| ID | Name | Credit/Debit State |
|---|---|---|
| 1 | ECMC Deposit | AuthorisedByProvider (13) |
| 2 | Visa Deposit | AuthorisedByProvider (13) |
| 113 | AMEX Deposit | AuthorisedByProvider (13) |
Payment method interaction type: Redirection to External Payment Provider (see Interaction Types).
Supported Creation Types for Card Deposit
| ID | Name | Description |
|---|---|---|
| 1 | User | Payment generated by user via web interface |
| 10 | MerchantInitiatedWithStoredAccount | Payment that is initiated by a merchant, with the consent of the cardholder, using the cardholder's stored credit card credentials |
| 11 | UserInitiatedWithStoredAccount | Payment that is initiated by a cardholder using the cardholder's stored credit card credentials |
Redirect Integration
Currently not supported.
Backend2Backend Integration
The following table contains the fields to be sent in initiatePaymentRequest:
| key (value type, account type, required) | value |
|---|---|
| userIP (string, required) | The IP of the user |
The following table contains the fields to be sent in initiatePaymentRequest.specificPaymentData xml section:
| key (value type, account type, required) | value |
|---|---|
| PaymentDescription (string) | Description of the payment |
| PaymentDescriptionLanguageCode (string) | Language value for the description |
| PaymentProviderID (Int) | The provider´s ID - 202 for Kushki |
Please note that sending data of the user is essential for this payment method as the data is sent to provider. The following parameters are recommended in initiatePaymentRequest.userData xml section and are required by the provider Kushki:
| key (value type, account type, required) | value |
|---|---|
| Firstname (string) | The user's first name |
| Lastname (string) | The user's last name |
| Email (string) | The user's email address |
| identificationNumber (string) | The user´s document ID |
| telephoneNumber (string) | The user´s phone number prefixed with the country code (Mexico: +52, Colombia: +57) |
| address > street (string) | The user´s street address |
| address > houseNumber (string) | The user´s house number |
| address > postalCode (string) | The user´s postalCode |
| address > city (string) | The user´s city |
| address > state (string) | The user´s state |
| address > countryCode2 (string) | The user´s country code |
Request samples:
Example initiatePaymentRequest (ECMC Deposit):
<?xml version="1.0" encoding="utf-8"?>
<initiatePaymentRequest
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="http://www.cqrpayments.com/PaymentProcessing">
<merchantID>DemoMerchant</merchantID>
<shopID>DemoShop</shopID>
<merchantTransactionID>ab0278d1-c891-459d-9314-c6bd3ced01a3</merchantTransactionID>
<paymentMethodID>1</paymentMethodID>
<amount currencyCode="MXN">45.88</amount>
<userID>761805d4-8274-4710-a5ac-7f4bbec37255</userID>
<userData>
<username>newusername</username>
<firstname>Barry</firstname>
<lastname>Allen</lastname>
<currencyCode>MXN</currencyCode>
<languageCode>ES</languageCode>
<email>[email protected]</email>
<address>
<street>José María Pino Suárez</street>
<houseNumber>30</houseNumber>
<houseNumberExtension>B</houseNumberExtension>
<postalCode>06060</postalCode>
<city>Mexico City</city>
<state>Mexico</state>
<countryCode2>MX</countryCode2>
<telephoneNumber>+5260000000</telephoneNumber>
</address>
<dateOfBirth>1980-10-10T00:00:00</dateOfBirth>
<gender>Male</gender>
<identificationNumber>HEGJ820506M10</identificationNumber>
</userData>
<userIP>127.0.0.1</userIP>
<userSessionID>97741380-002w-4a09-2bad-7fbca3c512s0-v0</userSessionID>
<creationTypeID>1</creationTypeID>
<specificPaymentData>
<data xsi:type="keyStringValuePair">
<key>PaymentDescription</key>
<value>5ded6850-b5b8-476f-8f29-bc2ad78b9e2e</value>
</data>
<data xsi:type="keyStringValuePair">
<key>PaymentDescriptionLanguageCode</key>
<value>en</value>
</data>
<data xsi:type="keyIntValuePair">
<key>PaymentProviderID</key>
<value>202</value>
</data>
</specificPaymentData>
<paymentAccount>
<specificPaymentAccountData>
<data xsi:type="keyStringValuePair">
<key>CardNumber</key>
<value>5451951574925480</value>
</data>
<data xsi:type="keyStringValuePair">
<key>CardVerificationCode</key>
<value>012</value>
</data>
<data xsi:type="keyIntValuePair">
<key>ExpiryMonth</key>
<value>06</value>
</data>
<data xsi:type="keyIntValuePair">
<key>ExpiryYear</key>
<value>2032</value>
</data>
<data xsi:type="keyStringValuePair">
<key>HolderName</key>
<value>Barry Allen</value>
</data>
</specificPaymentAccountData>
</paymentAccount>
</initiatePaymentRequest>Example initiatePaymentRequest (Visa Deposit):
<initiatePaymentRequest
xmlns="http://www.cqrpayments.com/PaymentProcessing"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<merchantID>DemoMerchant</merchantID>
<shopID>DemoShop</shopID>
<merchantTransactionID>1111141</merchantTransactionID>
<paymentMethodID>2</paymentMethodID>
<amount currencyCode="MXN">15.00</amount>
<userID>761805d4-8274-4710-a5ac-7f4bbec37255</userID>
<userData>
<username>newusername</username>
<firstname>Barry</firstname>
<lastname>Allen</lastname>
<currencyCode>MXN</currencyCode>
<languageCode>ES</languageCode>
<email>[email protected]</email>
<address>
<street>José María Pino Suárez</street>
<houseNumber>30</houseNumber>
<houseNumberExtension>B</houseNumberExtension>
<postalCode>06060</postalCode>
<city>Mexico City</city>
<state>Mexico</state>
<countryCode2>MX</countryCode2>
<telephoneNumber>+5260000000</telephoneNumber>
</address>
<dateOfBirth>1980-10-10T00:00:00</dateOfBirth>
<gender>Male</gender>
<identificationNumber>HEGJ820506M10</identificationNumber>
</userData>
<userIP>127.0.0.1</userIP>
<userSessionID>97741380-002w-4a09-2bad-7fbca3c512s0-v0</userSessionID>
<creationTypeID>1</creationTypeID>
<specificPaymentData>
<data xsi:type="keyStringValuePair">
<key>PaymentDescription</key>
<value>5ded6850-b5b8-476f-8f29-bc2ad78b9e2e</value>
</data>
<data xsi:type="keyStringValuePair">
<key>PaymentDescriptionLanguageCode</key>
<value>en</value>
</data>
<data xsi:type="keyIntValuePair">
<key>PaymentProviderID</key>
<value>202</value>
</data>
</specificPaymentData>
<paymentAccount>
<specificPaymentAccountData>
<data xsi:type="keyStringValuePair">
<key>CardNumber</key>
<value>4111111111111517</value>
</data>
<data xsi:type="keyStringValuePair">
<key>CardVerificationCode</key>
<value>012</value>
</data>
<data xsi:type="keyIntValuePair">
<key>ExpiryMonth</key>
<value>11</value>
</data>
<data xsi:type="keyIntValuePair">
<key>ExpiryYear</key>
<value>2032</value>
</data>
<data xsi:type="keyStringValuePair">
<key>HolderName</key>
<value>Barry Allen</value>
</data>
</specificPaymentAccountData>
</paymentAccount>
</initiatePaymentRequest>Example initiatePaymentRequest (AMEX Deposit):
<?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>DemoMerchant</merchantID>
<shopID>DemoMerchant</shopID>
<merchantTransactionID>20250624000000</merchantTransactionID>
<paymentMethodID>113</paymentMethodID>
<amount currencyCode="MXN">30.99</amount>
<userID>761805d4-8274-4710-a5ac-7f4bbec37255</userID>
<userData>
<username>newusername</username>
<firstname>Barry</firstname>
<lastname>Allen</lastname>
<currencyCode>MXN</currencyCode>
<languageCode>ES</languageCode>
<email>[email protected]</email>
<address>
<street>José María Pino Suárez</street>
<houseNumber>30</houseNumber>
<houseNumberExtension>B</houseNumberExtension>
<postalCode>06060</postalCode>
<city>Mexico City</city>
<state>Mexico</state>
<countryCode2>MX</countryCode2>
<telephoneNumber>+5260000000</telephoneNumber>
</address>
<dateOfBirth>1980-10-10T00:00:00</dateOfBirth>
<gender>Male</gender>
<identificationNumber>HEGJ820506M10</identificationNumber>
</userData>
<userIP>127.0.0.1</userIP>
<userSessionID>97741380-002w-4a09-2bad-7fbca3c512s0-v0</userSessionID>
<creationTypeID>1</creationTypeID>
<specificPaymentData>
<data xsi:type="keyStringValuePair">
<key>PaymentDescription</key>
<value>5ded6850-b5b8-476f-8f29-bc2ad78b9e2e</value>
</data>
<data xsi:type="keyStringValuePair">
<key>PaymentDescriptionLanguageCode</key>
<value>en</value>
</data>
<data xsi:type="keyIntValuePair">
<key>PaymentProviderID</key>
<value>202</value>
</data>
</specificPaymentData>
<paymentAccount>
<specificPaymentAccountData>
<data xsi:type="keyStringValuePair">
<key>CardNumber</key>
<value>373400000002221</value>
</data>
<data xsi:type="keyStringValuePair">
<key>CardVerificationCode</key>
<value>012</value>
</data>
<data xsi:type="keyIntValuePair">
<key>ExpiryMonth</key>
<value>06</value>
</data>
<data xsi:type="keyIntValuePair">
<key>ExpiryYear</key>
<value>2032</value>
</data>
<data xsi:type="keyStringValuePair">
<key>HolderName</key>
<value>Barry Allen</value>
</data>
</specificPaymentAccountData>
</paymentAccount>
</initiatePaymentRequest>Response success samples:
Example initiatePaymentResponse (ECMC Deposit - state AuthorisedByProvider):
<?xml version="1.0" encoding="utf-8"?>
<initiatePaymentResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="http://www.cqrpayments.com/PaymentProcessing">
<payment xsi:type="paymentWithPaymentAccount">
<merchantID>DemoMerchant</merchantID>
<shopID>DemoShop</shopID>
<paymentMethod>
<key>1</key>
<value>ECMC Deposit</value>
</paymentMethod>
<merchantTransactionID>ab0278d1-c891-459d-9314-c6bd3ced01a3</merchantTransactionID>
<paymentID>1329b1c7-f57c-4f25-a3ab-98f95ec3dfd1</paymentID>
<userID>761805d4-8274-4710-a5ac-7f4bbec37255</userID>
<paymentProvider>
<key>202</key>
<value>Kushki</value>
</paymentProvider>
<amount currencyCode="MXN">45.88</amount>
<creationType>
<key>1</key>
<value>User</value>
</creationType>
<userIP>127.0.0.1</userIP>
<state>
<id>0f6eb02d-9082-42c7-a63e-44ab3741c071</id>
<definition>
<key>13</key>
<value>AuthorisedByProvider</value>
</definition>
<createdOn>2025-06-20T12:09:49.5534874Z</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>ApprovalCode</key>
<value>000000</value>
</detail>
</paymentStateDetails>
</state>
<isExecuted>true</isExecuted>
<baseAmount currencyCode="EUR">2.72</baseAmount>
<paymentDetails>
<detail xsi:type="keyStringValuePair">
<key>ElectronicCommerceIndicator</key>
<value>07</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>Token</key>
<value>13447cc290884f31b42ec421d9b4e351</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>ProviderTransactionID</key>
<value>508504254073823639</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>ProviderExternalID</key>
<value>201734</value>
</detail>
</paymentDetails>
<paymentAccount>
<paymentAccountID>6db3fb2a-c6af-4d14-a267-95997f30f212</paymentAccountID>
<details>
<detail xsi:type="keyStringValuePair">
<key>MaskedNumber</key>
<value>545195******5480</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>AccountOwnerToken</key>
<value>78e8aa28-5f81-4c65-9423-fd9232086564</value>
</detail>
<detail xsi:type="keyIntValuePair">
<key>ExpiryMonth</key>
<value>6</value>
</detail>
<detail xsi:type="keyIntValuePair">
<key>ExpiryYear</key>
<value>2032</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>HolderName</key>
<value>Barry Allen</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>CardType</key>
<value>Mastercard</value>
</detail>
</details>
</paymentAccount>
</payment>
</initiatePaymentResponse>Example initiatePaymentResponse (Visa Deposit - state AuthorisedByProvider):
<initiatePaymentResponse
xmlns="http://www.cqrpayments.com/PaymentProcessing"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<payment xsi:type="paymentWithPaymentAccount">
<merchantID>DemoMerchant</merchantID>
<shopID>DemoShop</shopID>
<paymentMethod>
<key>2</key>
<value>VISA Deposit</value>
</paymentMethod>
<merchantTransactionID>1111141</merchantTransactionID>
<paymentID>77b9d942-efa4-49ff-8549-1deb002e6c12</paymentID>
<userID>761805d4-8274-4710-a5ac-7f4bbec37255</userID>
<paymentProvider>
<key>202</key>
<value>Kushki</value>
</paymentProvider>
<amount currencyCode="MXN">15.00</amount>
<creationType>
<key>1</key>
<value>User</value>
</creationType>
<userIP>127.0.0.1</userIP>
<state>
<id>55207c8f-5d85-4332-a033-52339849649d</id>
<definition>
<key>13</key>
<value>AuthorisedByProvider</value>
</definition>
<createdOn>2025-06-20T12:11:57.281902Z</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>ApprovalCode</key>
<value>000000</value>
</detail>
</paymentStateDetails>
</state>
<isExecuted>true</isExecuted>
<baseAmount currencyCode="EUR">0.89</baseAmount>
<paymentDetails>
<detail xsi:type="keyStringValuePair">
<key>ElectronicCommerceIndicator</key>
<value>07</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>Token</key>
<value>c0e97a7e7e6c4c22ba4c424cc2a34a7a</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>ProviderTransactionID</key>
<value>741918217340875500</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>ProviderExternalID</key>
<value>201735</value>
</detail>
</paymentDetails>
<paymentAccount>
<paymentAccountID>1cc29a56-e64c-4599-bb51-11d9ee96a8ff</paymentAccountID>
<details>
<detail xsi:type="keyStringValuePair">
<key>IssuerCountry</key>
<value>AT</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>AccountFundingSource</key>
<value>Credit</value>
</detail>
<detail xsi:type="keyBooleanValuePair">
<key>FastFunds</key>
<value>false</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>IssuerName</key>
<value></value>
</detail>
</details>
</paymentAccount>
</payment>
</initiatePaymentResponse>Example initiatePaymentResponse (AMEX Deposit - state AuthorisedByProvider):
<initiatePaymentResponse xmlns="http://www.cqrpayments.com/PaymentProcessing" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<payment xsi:type="paymentWithPaymentAccount">
<merchantID>DemoMerchant</merchantID>
<shopID>DemoMerchant</shopID>
<paymentMethod>
<key>113</key>
<value>AMEXDeposit</value>
</paymentMethod>
<merchantTransactionID>20250624000000</merchantTransactionID>
<paymentID>17cf9b3d-67b9-483b-a1d1-a12fdd53bde5</paymentID>
<userID>761805d4-8274-4710-a5ac-7f4bbec37255</userID>
<paymentProvider>
<key>202</key>
<value>Kushki</value>
</paymentProvider>
<amount currencyCode="MXN">30.99</amount>
<creationType>
<key>1</key>
<value>User</value>
</creationType>
<userIP>127.0.0.1</userIP>
<state>
<id>f6d8956a-73e9-4b8a-a29c-2ff38c56bfb1</id>
<definition>
<key>13</key>
<value>AuthorisedByProvider</value>
</definition>
<createdOn>2025-06-24T11:30:54.7343913Z</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>ApprovalCode</key>
<value>000000</value>
</detail>
</paymentStateDetails>
</state>
<isExecuted>true</isExecuted>
<baseAmount currencyCode="EUR">1.84</baseAmount>
<paymentDetails>
<detail xsi:type="keyStringValuePair">
<key>ElectronicCommerceIndicator</key>
<value>07</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>Token</key>
<value>7e4071f561bc40fa8127d67d434736f0</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>ProviderTransactionID</key>
<value>615765102634821481</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>ProviderExternalID</key>
<value>203078</value>
</detail>
</paymentDetails>
<paymentAccount>
<paymentAccountID>8f5e1e4d-1a19-4a4c-88f9-05730245cb9f</paymentAccountID>
<details>
<detail xsi:type="keyStringValuePair">
<key>IssuerCountry</key>
<value>US</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>AccountFundingSource</key>
<value>Credit</value>
</detail>
<detail xsi:type="keyBooleanValuePair">
<key>FastFunds</key>
<value>false</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>IssuerName</key>
<value>AMERICAN EXPRESS US CONSUMER</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>MaskedNumber</key>
<value>373400*****2221</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>AccountOwnerToken</key>
<value>ab13836e-12ca-4108-895f-593003aca3e5</value>
</detail>
<detail xsi:type="keyIntValuePair">
<key>ExpiryMonth</key>
<value>6</value>
</detail>
<detail xsi:type="keyIntValuePair">
<key>ExpiryYear</key>
<value>2032</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>HolderName</key>
<value>Barry Allen</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>CardType</key>
<value>AmericanExpress</value>
</detail>
</details>
</paymentAccount>
</payment>
</initiatePaymentResponse>Response error/refusal samples:
Example initiatePaymentResponse (state InitiatePaymentAccountTokenErrorReportedByProvider):
<initiatePaymentResponse xmlns="http://www.cqrpayments.com/PaymentProcessing" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<payment xsi:type="paymentWithPaymentAccount">
<merchantID>DemoMerchant</merchantID>
<shopID>DemoShop</shopID>
<paymentMethod>
<key>1</key>
<value>ECMC Deposit</value>
</paymentMethod>
<merchantTransactionID>ab0278d1-c891-459d-9314-c6bd3ced01a3</merchantTransactionID>
<paymentID>6829ceab-26f7-41e0-9d8d-e0b6b3adff88</paymentID>
<userID>761805d4-8274-4710-a5ac-7f4bbec37255</userID>
<paymentProvider>
<key>202</key>
<value>Kushki</value>
</paymentProvider>
<amount currencyCode="MXN">45.88</amount>
<creationType>
<key>1</key>
<value>User</value>
</creationType>
<userIP>127.0.0.1</userIP>
<state>
<id>3beaa143-ba99-43b3-a92c-6b79286599bd</id>
<definition>
<key>551</key>
<value>InitiatePaymentAccountTokenErrorReportedByProvider</value>
</definition>
<createdOn>2025-06-20T12:06:38.5254517Z</createdOn>
<paymentStateDetails>
<detail xsi:type="keyStringValuePair">
<key>ProviderErrorResponseCode</key>
<value>K006</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>ProviderErrorResponseMessage</key>
<value>DFR029 - Bin de tarjeta inválido</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>PaymentStateReasonID</key>
<value>1</value>
</detail>
</paymentStateDetails>
</state>
<isExecuted>false</isExecuted>
<baseAmount currencyCode="EUR">2.72</baseAmount>
<paymentDetails>
<detail xsi:type="keyStringValuePair">
<key>ElectronicCommerceIndicator</key>
<value>07</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>ProviderExternalID</key>
<value>201733</value>
</detail>
</paymentDetails>
<paymentAccount>
<paymentAccountID>0cdc94f6-1e85-4611-b68e-0fda7899e684</paymentAccountID>
<details>
<detail xsi:type="keyStringValuePair">
<key>MaskedNumber</key>
<value>555555******4444</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>AccountOwnerToken</key>
<value>75a5c231-e161-4ee8-9355-6d8202d89791</value>
</detail>
<detail xsi:type="keyIntValuePair">
<key>ExpiryMonth</key>
<value>6</value>
</detail>
<detail xsi:type="keyIntValuePair">
<key>ExpiryYear</key>
<value>2032</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>HolderName</key>
<value>Barry Allen</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>CardType</key>
<value>Mastercard</value>
</detail>
</details>
</paymentAccount>
</payment>
</initiatePaymentResponse>Testcard number: 4574441215190335/5555555555554444
Example initiatePaymentResponse (state InitiatePaymentAccountTokenCommunicationErrorOccurred):
<initiatePaymentResponse xmlns="http://www.cqrpayments.com/PaymentProcessing" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<payment xsi:type="paymentWithPaymentAccount">
<merchantID>DemoMerchant</merchantID>
<shopID>DemoShop</shopID>
<paymentMethod>
<key>2</key>
<value>VISA Deposit</value>
</paymentMethod>
<merchantTransactionID>1111141</merchantTransactionID>
<paymentID>85f33cf1-a876-4c46-a97f-bd242b92ae6e</paymentID>
<userID>761805d4-8274-4710-a5ac-7f4bbec37255</userID>
<paymentProvider>
<key>202</key>
<value>Kushki</value>
</paymentProvider>
<amount currencyCode="MXN">15.00</amount>
<creationType>
<key>1</key>
<value>User</value>
</creationType>
<userIP>127.0.0.1</userIP>
<state>
<id>090c1c9e-fe47-47b0-83c3-9e91475c7960</id>
<definition>
<key>549</key>
<value>InitiatePaymentAccountTokenCommunicationErrorOccurred</value>
</definition>
<createdOn>2025-06-20T13:30:50.1436365Z</createdOn>
<paymentStateDetails>
<detail xsi:type="keyStringValuePair">
<key>PaymentStateReasonID</key>
<value>1</value>
</detail>
</paymentStateDetails>
</state>
<isExecuted>false</isExecuted>
<baseAmount currencyCode="EUR">0.89</baseAmount>
<paymentDetails>
<detail xsi:type="keyStringValuePair">
<key>ElectronicCommerceIndicator</key>
<value>07</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>ProviderExternalID</key>
<value>201760</value>
</detail>
</paymentDetails>
<paymentAccount>
<paymentAccountID>1cc29a56-e64c-4599-bb51-11d9ee96a8ff</paymentAccountID>
<details>
<detail xsi:type="keyStringValuePair">
<key>IssuerCountry</key>
<value>AT</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>AccountFundingSource</key>
<value>Credit</value>
</detail>
<detail xsi:type="keyBooleanValuePair">
<key>FastFunds</key>
<value>false</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>IssuerName</key>
<value></value>
</detail>
</details>
</paymentAccount>
</payment>
</initiatePaymentResponse>Example initiatePaymentResponse (state RefusedByProvider):
<initiatePaymentResponse xmlns="http://www.cqrpayments.com/PaymentProcessing" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<payment xsi:type="paymentWithPaymentAccount">
<merchantID>B2BTestMerchant</merchantID>
<shopID>KushkiProviderShop</shopID>
<paymentMethod>
<key>2</key>
<value>VISA Deposit</value>
</paymentMethod>
<merchantTransactionID>111114211</merchantTransactionID>
<paymentID>6ee52a9d-c5cb-41af-afd1-b4955afcf69b</paymentID>
<userID>111111</userID>
<paymentProvider>
<key>202</key>
<value>Kushki</value>
</paymentProvider>
<amount currencyCode="COP">350.00</amount>
<creationType>
<key>1</key>
<value>User</value>
</creationType>
<userIP>80.121.151.158</userIP>
<state>
<id>182feb81-2667-404a-adbb-9c3568894044</id>
<definition>
<key>100</key>
<value>RefusedByProvider</value>
</definition>
<createdOn>2022-08-18T11:59:35.1765433Z</createdOn>
<paymentStateDetails>
<detail xsi:type="keyStringValuePair">
<key>ProviderResponseCode</key>
<value>6</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>ProviderResponseMessage</key>
<value>Error</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>PaymentStateReasonID</key>
<value>1</value>
</detail>
</paymentStateDetails>
</state>
<isExecuted>false</isExecuted>
<baseAmount currencyCode="EUR">0.14</baseAmount>
<paymentDetails>
<detail xsi:type="keyStringValuePair">
<key>ElectronicCommerceIndicator</key>
<value>07</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>Token</key>
<value>38f618baf19c4831a4e7d605bf51f958</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>ProviderExternalID</key>
<value>2630</value>
</detail>
</paymentDetails>
<paymentAccount>
<paymentAccountID>75929a10-c3b8-4f0d-a63a-82d135ec91e1</paymentAccountID>
<details>
<detail xsi:type="keyStringValuePair">
<key>IssuerCountry</key>
<value>EC</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>AccountFundingSource</key>
<value>Credit</value>
</detail>
<detail xsi:type="keyBooleanValuePair">
<key>FastFunds</key>
<value>false</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>IssuerName</key>
<value>UNKNOWN</value>
</detail>
</details>
</paymentAccount>
</payment>
</initiatePaymentResponse>Notifications
The standard notification mechanism is used for notifying the merchant in the background (asynchronously) about payment state changes. For more information see PaymentStateChangedNotification.
| Payment States | Description |
|---|---|
| AuthorisedByProvider | Success state |
| RefusedByProvider | Payment has been rejected by the provider. |
| AuthoriseErrorReportedByProvider | Payment has an error reported by the provider. |
| AuthoriseCommunicationErrorOccurred | A communication error has occurred |
Example handlePaymentStateChangedNotificationRequest (state RefusedByProvider):
<?xml version="1.0" encoding="utf-8"?>
<handlePaymentStateChangedNotificationRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.cqrpayments.com/PaymentProcessing">
<payment xsi:type="paymentWithPaymentAccount">
<merchantID>DemoMerchant</merchantID>
<shopID>DemoShop</shopID>
<paymentMethod>
<key>1</key>
<value>ECMC Deposit</value>
</paymentMethod>
<merchantTransactionID>7fd84823-325f-4c24-9160-b3f537ad3857</merchantTransactionID>
<paymentID>9462b4f7-2617-4eb9-a85c-51f71608c462</paymentID>
<userID>54fd76c3-459b-4a30-8e82-9c0716</userID>
<paymentProvider>
<key>202</key>
<value>Kushki</value>
</paymentProvider>
<amount currencyCode="COP">106.0200</amount>
<creationType>
<key>1</key>
<value>User</value>
</creationType>
<userIP>127.0.0.1</userIP>
<state>
<id>4b2e6d7c-788f-4de9-9843-e88a4bf037db</id>
<definition>
<key>100</key>
<value>RefusedByProvider</value>
</definition>
<createdOn>2022-08-02T12:38:45.953</createdOn>
<paymentStateDetails>
<detail xsi:type="keyStringValuePair">
<key>ProviderErrorResponseCode</key>
<value>017</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>ProviderErrorResponseMessage</key>
<value>Invalid card</value>
</detail>
<detail xsi:type="keyIntValuePair">
<key>PaymentStateReasonID</key>
<value>1</value>
</detail>
</paymentStateDetails>
</state>
<isExecuted>false</isExecuted>
<baseAmount currencyCode="EUR">0.0400</baseAmount>
<paymentDetails>
<detail xsi:type="keyStringValuePair">
<key>ProviderExternalID</key>
<value>1</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>Token</key>
<value>7d658056-8bce-407d-a564-2de922fac446</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>ElectronicCommerceIndicator</key>
<value>07</value>
</detail>
</paymentDetails>
<paymentAccount>
<paymentAccountID>44c0fd9b-b3a7-48f0-85f6-065a0aecee27</paymentAccountID>
<details>
<detail xsi:type="keyStringValuePair">
<key>IssuerCountry</key>
<value>AT</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>AccountFundingSource</key>
<value>Debit</value>
</detail>
<detail xsi:type="keyBooleanValuePair">
<key>FastFunds</key>
<value>false</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>IssuerName</key>
<value>Some Bank</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>MaskedNumber</key>
<value>526624******6818</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>AccountOwnerToken</key>
<value>acda11b6-3410-4a8b-bb84-59b26943bf0a</value>
</detail>
<detail xsi:type="keyIntValuePair">
<key>ExpiryMonth</key>
<value>4</value>
</detail>
<detail xsi:type="keyIntValuePair">
<key>ExpiryYear</key>
<value>2030</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>HolderName</key>
<value>Pepe Alonso</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>CardType</key>
<value>Mastercard</value>
</detail>
</details>
</paymentAccount>
</payment>
</handlePaymentStateChangedNotificationRequest>Example handlePaymentStateChangedNotificationRequest (state AuthorisedByProvider):
<?xml version="1.0" encoding="utf-8"?>
<handlePaymentStateChangedNotificationRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.cqrpayments.com/PaymentProcessing">
<payment xsi:type="paymentWithPaymentAccount">
<merchantID>DemoMerchant</merchantID>
<shopID>DemoShop</shopID>
<paymentMethod>
<key>2</key>
<value>VISA Deposit</value>
</paymentMethod>
<merchantTransactionID>1d609ff7-2d84-4bde-8ef7-965fc5ba6dfa</merchantTransactionID>
<paymentID>7e537a99-0558-40ed-908f-5383632bd648</paymentID>
<userID>cb385eaf-16a0-4e44-943c-994232</userID>
<paymentProvider>
<key>202</key>
<value>Kushki</value>
</paymentProvider>
<amount currencyCode="COP">104.0100</amount>
<creationType>
<key>1</key>
<value>User</value>
</creationType>
<userIP>127.0.0.1</userIP>
<state>
<id>9b377ef2-3ca1-43f2-b097-7ee1673fb21b</id>
<definition>
<key>13</key>
<value>AuthorisedByProvider</value>
</definition>
<createdOn>2022-08-02T12:37:07.297</createdOn>
<paymentStateDetails>
<detail xsi:type="keyStringValuePair">
<key>ApprovalCode</key>
<value>000000</value>
</detail>
</paymentStateDetails>
</state>
<isExecuted>true</isExecuted>
<baseAmount currencyCode="EUR">0.0400</baseAmount>
<paymentDetails>
<detail xsi:type="keyStringValuePair">
<key>ProviderExternalID</key>
<value>1</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>ProviderTransactionID</key>
<value>8906365111</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>Token</key>
<value>e40f59ef-9104-454c-998e-c703d034b593</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>ElectronicCommerceIndicator</key>
<value>07</value>
</detail>
</paymentDetails>
<paymentAccount>
<paymentAccountID>900edaf5-a594-4790-b372-93953235ccee</paymentAccountID>
<details>
<detail xsi:type="keyStringValuePair">
<key>IssuerCountry</key>
<value>AT</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>AccountFundingSource</key>
<value>Credit</value>
</detail>
<detail xsi:type="keyBooleanValuePair">
<key>FastFunds</key>
<value>false</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>IssuerName</key>
<value />
</detail>
</details>
</paymentAccount>
</payment>
</handlePaymentStateChangedNotificationRequest>Test Data (provider)
| Card Number | Result | State |
|---|---|---|
| 4349003000047015 | Transaction refused by Kushki | RefusedByProvider |
| 5451951574925480 | Successful transaction | AuthorisedByProvider |
| 4574441215190335 | Card number refused by Kushki | InitiatePaymentAccountTokenErrorReportedByProvider |
| 5555555555554444 | Card number refused by Kushki | InitiatePaymentAccountTokenErrorReportedByProvider |
Updated 11 days ago