GamersCard Deposit
The following method IDs are covered in this section:
ID | Name | Credit/Debit State |
---|---|---|
367 | GamersCardDeposit | DepositedByProvider (29) |
Payment method interaction type: Synchronous execution (see Interaction Types).
Redirect Integration
Currently not supported.
Backend2BackendIntegration - GamersCard Balance Enquiry
For the GamersCard balance enquiry getPaymentInputData is called by the merchant.
The following table contains the fields to be sent in the getPaymentInputData.Details xml section:
key (value type, required) | value |
---|---|
PaymentAccountID (string, required) | The unique id of the payment account in PS |
Example getPaymentInputData:
<getPaymentInputDataRequest xmlns="http://www.cqrpayments.com/PaymentProcessing" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<merchantID>B2BTestMerchant</merchantID>
<shopID>ProviderTesting</shopID>
<user>
<id>77bd959a-380c-4874-afc6-2a7ce6</id>
</user>
<paymentMethodID>367</paymentMethodID>
<details>
<data xsi:type="keyStringValuePair">
<key>PaymentAccountID</key>
<value>5b9688a5-cb2a-4cad-9cc8-ad0fe44b7b98</value>
</data>
</details>
</getPaymentInputDataRequest>
Example of successful getPaymentInputDataResponse:
<getPaymentInputDataResponse xmlns="http://www.cqrpayments.com/PaymentProcessing" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<paymentInputData>
<data xsi:type="keyStringValuePair">
<key>Currency</key>
<value>USD</value>
</data>
<data xsi:type="keyDecimalValuePair">
<key>Amount</key>
<value>1311025.79</value>
</data>
</paymentInputData>
</getPaymentInputDataResponse>
Example of an execution error reported by the provider in getPaymentInputDataResponse:
<getPaymentInputDataResponse xmlns="http://www.cqrpayments.com/PaymentProcessing" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<paymentInputData>
<data xsi:type="keyStringValuePair">
<key>ErrorCode</key>
<value>E2005</value>
</data>
<data xsi:type="keyStringValuePair">
<key>ErrorMessage</key>
<value>CUSTOMER NOT FOUND</value>
</data>
</paymentInputData>
</getPaymentInputDataResponse>
Example of a communication error reported by the provider in getPaymentInputDataResponse:
<getPaymentInputDataResponse xmlns="http://www.cqrpayments.com/PaymentProcessing" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<paymentInputData>
<data xsi:type="keyStringValuePair">
<key>ErrorCode</key>
<value>400</value>
</data>
<data xsi:type="keyStringValuePair">
<key>ErrorMessage</key>
<value>Communication error with provider!</value>
</data>
</paymentInputData>
</getPaymentInputDataResponse>
Example of no response received by the provider in getPaymentInputDataResponse:
<getPaymentInputDataResponse xmlns="http://www.cqrpayments.com/PaymentProcessing" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<paymentInputData>
<data xsi:type="keyStringValuePair">
<key>ErrorMessage</key>
<value>No response received from the provider.</value>
</data>
</paymentInputData>
</getPaymentInputDataResponse>
Backend2BackendIntegration
The following parameters can be provided in initiatePaymentRequest.specificPaymentData:
key (value type, requiredtype, required) | value |
---|---|
PayerPassword (String, required) | The player's password for their GamersCard account. |
PaymentDescription (string, required) | Description of payment: short description. |
PaymentDescriptionLanguageCode (string, required) | Language code of the payment description. |
Example initiatePaymentRequest for a user's initial deposit. A new payment account is created in this case:
<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>ProviderTesting</shopID>
<merchantTransactionID>e-4242-22225</merchantTransactionID>
<paymentMethodID>367</paymentMethodID>
<amount currencyCode="USD">10.05</amount>
<userID>bc1544de-7443-45f6-976e-ge</userID>
<userData></userData>
<userIP>127.0.0.1</userIP>
<userSessionID>44412fac-ec9d-44de-b511-5a5cc00ada80</userSessionID>
<creationTypeID>1</creationTypeID>
<specificPaymentData>
<data xsi:type="keyStringValuePair">
<key>PayerPassword</key>
<value>PS1234</value>
</data>
<data xsi:type="keyStringValuePair">
<key>PaymentDescription</key>
<value>Description of payment: short description</value>
</data>
<data xsi:type="keyStringValuePair">
<key>PaymentDescriptionLanguageCode</key>
<value>en</value>
</data>
</specificPaymentData>
<paymentAccount>
<specificPaymentAccountData>
<data xsi:type="keyStringValuePair">
<key>CardNumber</key>
<value>5292050400000114</value>
</data>
<data xsi:type="keyStringValuePair">
<key>HolderName</key>
<value>Dimitar</value>
</data>
<data xsi:type="keyIntValuePair">
<key>ExpiryMonth</key>
<value>11</value>
</data>
<data xsi:type="keyIntValuePair">
<key>ExpiryYear</key>
<value>2024</value>
</data>
<data xsi:type="keyStringValuePair">
<key>CardVerificationCode</key>
<value>123</value>
</data>
</specificPaymentAccountData>
</paymentAccount>
</initiatePaymentRequest>
Example initiatePaymentRequest for subsequent deposits, providing paymentAccountID:
<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>ProviderTesting</shopID>
<merchantTransactionID>e-new22443-442424a</merchantTransactionID>
<paymentMethodID>367</paymentMethodID>
<amount currencyCode="USD">20000.05</amount>
<userID>bc1544de-7443-45f6-976e-ge</userID>
<userData></userData>
<userIP>127.0.0.1</userIP>
<userSessionID>44412fac-ec9d-44de-b511-5a5cc00ada80</userSessionID>
<creationTypeID>1</creationTypeID>
<specificPaymentData>
<data xsi:type="keyStringValuePair">
<key>PayerPassword</key>
<value>PS1234</value>
</data>
<data xsi:type="keyStringValuePair">
<key>PaymentDescription</key>
<value>Description of payment: short description</value>
</data>
<data xsi:type="keyStringValuePair">
<key>PaymentDescriptionLanguageCode</key>
<value>en</value>
</data>
</specificPaymentData>
<paymentAccountID>cfb99453-95c2-4034-8234-1f42525</paymentAccountID>
</initiatePaymentRequest>
Example initiatePaymentResponse:
<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>ProviderTesting</shopID>
<paymentMethod>
<key>367</key>
<value>GamersCardDeposit</value>
</paymentMethod>
<merchantTransactionID>e-4242-22225</merchantTransactionID>
<paymentID>0434f6a4-9a64-4f8b-ab56-c7b0c525f204</paymentID>
<userID>bc1544de-7443-45f6-976e-ge</userID>
<paymentProvider>
<key>188</key>
<value>CREDTA</value>
</paymentProvider>
<amount currencyCode="USD">10.05</amount>
<creationType>
<key>1</key>
<value>User</value>
</creationType>
<userIP>127.0.0.1</userIP>
<state>
<id>5c584d41-db7f-4157-b699-8474bf3d2573</id>
<definition>
<key>29</key>
<value>DepositedByProvider</value>
</definition>
<createdOn>2020-04-28T08:48:17.8183967Z</createdOn>
<paymentStateDetails xsi:nil="true"></paymentStateDetails>
</state>
<isExecuted>true</isExecuted>
<baseAmount currencyCode="EUR">6.67</baseAmount>
<paymentDetails>
<detail xsi:type="keyStringValuePair">
<key>ElectronicCommerceIndicator</key>
<value>07</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>ProviderTransactionID</key>
<value>1530</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>ProviderExternalID</key>
<value>1753852</value>
</detail>
</paymentDetails>
<paymentAccount>
<paymentAccountID>cfb99453-95c2-4034-8234-1f42525</paymentAccountID>
<details>
<detail xsi:type="keyStringValuePair">
<key>MaskedNumber</key>
<value>************0114</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>AccountOwnerToken</key>
<value>bfc3b5fb-7edc-4581-80c4-e6a2f6382d7d</value>
</detail>
<detail xsi:type="keyIntValuePair">
<key>ExpiryMonth</key>
<value>11</value>
</detail>
<detail xsi:type="keyIntValuePair">
<key>ExpiryYear</key>
<value>2024</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>HolderName</key>
<value>Dimitar</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>CardType</key>
<value>MastercardDebit</value>
</detail>
</details>
</paymentAccount>
</payment>
</initiatePaymentResponse>
Following field is returned in paymentDetails of initiatePaymentResponse:
Field name | Description |
---|---|
ProviderTransactionID | GamersCard`s unique transactionID. |
Notifications
The standard notification mechanism is used for notifying the merchant in the background (asynchronously) about payment state changes. For more information see PaymentStateChangedNotification.
The final execution status has the following payment states:
Payment States | Description |
---|---|
RefusedByProvider (100) | Error state; payment was not accepted by provider. See section RefusedByProvider Breakdown. |
DepositedByProvider (29) | Success state; payment has been executed. |
DepositRequestSentToProviderCommunicationErrorOccured (353) | Error state; payment request was incorrect or provider was unreachable. |
RefusedByProvider Breakdown
The general case of a refused transaction, where the provider has returned an error code and error message.
<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>ProviderTesting</shopID>
<paymentMethod>
<key>367</key>
<value>GamersCardDeposit</value>
</paymentMethod>
<merchantTransactionID>e-new22443-22225</merchantTransactionID>
<paymentID>5a68766d-c554-4e05-b46d-039f52333efe</paymentID>
<userID>bc1544de-7443-45f6-976e-ge</userID>
<paymentProvider>
<key>188</key>
<value>CREDTA</value>
</paymentProvider>
<amount currencyCode="USD">10.05</amount>
<creationType>
<key>1</key>
<value>User</value>
</creationType>
<userIP>127.0.0.1</userIP>
<state>
<id>b7b1d4e4-418e-47e7-b589-fe59802879e7</id>
<definition>
<key>100</key>
<value>RefusedByProvider</value>
</definition>
<createdOn>2020-04-28T08:50:28.9735424Z</createdOn>
<paymentStateDetails>
<detail xsi:type="keyStringValuePair">
<key>ProviderResponseCode</key>
<value>E2003</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>ProviderResponseMessage</key>
<value>INVALID CARD OR CREDENTIALS DATA</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>PaymentStateReasonID</key>
<value>1</value>
</detail>
</paymentStateDetails>
</state>
<isExecuted>false</isExecuted>
<baseAmount currencyCode="EUR">6.67</baseAmount>
<paymentDetails>
<detail xsi:type="keyStringValuePair">
<key>ElectronicCommerceIndicator</key>
<value>07</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>ProviderExternalID</key>
<value>1753853</value>
</detail>
</paymentDetails>
<paymentAccount>
<paymentAccountID>cfb99453-95c2-4034-8234-1f42525</paymentAccountID>
<details>
<detail xsi:type="keyStringValuePair">
<key>MaskedNumber</key>
<value>************0114</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>AccountOwnerToken</key>
<value>bfc3b5fb-7edc-4581-80c4-e6a2f6382d7d</value>
</detail>
<detail xsi:type="keyIntValuePair">
<key>ExpiryMonth</key>
<value>11</value>
</detail>
<detail xsi:type="keyIntValuePair">
<key>ExpiryYear</key>
<value>2024</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>HolderName</key>
<value>Dimitar</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>CardType</key>
<value>MastercardDebit</value>
</detail>
</details>
</paymentAccount>
</payment>
</initiatePaymentResponse>
ProviderResponseCode | ProviderResponseMessage |
---|---|
E1000 | NOT AUTHORIZED - The user has insufficient funds for completing the transaction. |
E1001 | CASH-OUT LIMIT EXCEEDED - Deposit limit its exceeded. |
E1002 | CASH-IN LIMIT EXCEEDED - Our withdrawal limit its exceeded. |
E1003 | ALREADY CHARGED BACK |
E1004 | INSUFICIENT FUNDS FOR CHARGEBACK |
E2000 | PARTNER NOT AUTHORIZED - The user has blocked your transactions intentionally. |
E2001 | CARD BLOCKED |
E2002 | CARD NOT ACTIVATED - The user has a brand new card an has not activated it. |
E2003 | INVALID CARD OR CREDENTIALS DATA - The user has provided the wrong card or credential details (ex: PAN, CVV, password) |
E2004 | UNSUPPORTED CURRENCY |
E2005 | CUSTOMER NOT FOUND - The user has provided a PAN that does not belong to GamersCard BIN. |
E3000 | QUERY PERIOD EXCEEDED - The period asked in the query for Transcations is too long. |
E3001 | MISSING / WRONG DATA OR PARAMETERS TO COMPLETE OPERATION - Bad request format is being sent. |
E3003 | UNABLE TO COMPLETE OPERATION, TRY AGAIN LATER - Temporary state where we could not complete the operation (networking or processing problems in general). |
E3004 | PARTNER TRANSACTION ID ALREADY USED - Signals to partner that the desired partnerId has already been used. |
The GamersCard specific case of a refused transaction, where the provider has refused the transaction due to insufficient funds on the merchant account.
<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>ProviderTesting</shopID>
<paymentMethod>
<key>367</key>
<value>GamersCardDeposit</value>
</paymentMethod>
<merchantTransactionID>e-new22443-22225</merchantTransactionID>
<paymentID>5a68766d-c554-4e05-b46d-039f52333efe</paymentID>
<userID>bc1544de-7443-45f6-976e-ge</userID>
<paymentProvider>
<key>188</key>
<value>CREDTA</value>
</paymentProvider>
<amount currencyCode="USD">10.05</amount>
<creationType>
<key>1</key>
<value>User</value>
</creationType>
<userIP>127.0.0.1</userIP>
<state>
<id>b7b1d4e4-418e-47e7-b589-fe59802879e7</id>
<definition>
<key>100</key>
<value>RefusedByProvider</value>
</definition>
<createdOn>2020-04-28T08:50:28.9735424Z</createdOn>
<paymentStateDetails>
<detail xsi:type="keyStringValuePair">
<key>ProviderStatusCode</key>
<value>110</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>PaymentStateReasonID</key>
<value>1</value>
</detail>
</paymentStateDetails>
</state>
<isExecuted>false</isExecuted>
<baseAmount currencyCode="EUR">6.67</baseAmount>
<paymentDetails>
<detail xsi:type="keyStringValuePair">
<key>ElectronicCommerceIndicator</key>
<value>07</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>ProviderExternalID</key>
<value>1753853</value>
</detail>
</paymentDetails>
<paymentAccount>
<paymentAccountID>cfb99453-95c2-4034-8234-1f42525</paymentAccountID>
<details>
<detail xsi:type="keyStringValuePair">
<key>MaskedNumber</key>
<value>************0114</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>AccountOwnerToken</key>
<value>bfc3b5fb-7edc-4581-80c4-e6a2f6382d7d</value>
</detail>
<detail xsi:type="keyIntValuePair">
<key>ExpiryMonth</key>
<value>11</value>
</detail>
<detail xsi:type="keyIntValuePair">
<key>ExpiryYear</key>
<value>2024</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>HolderName</key>
<value>Dimitar</value>
</detail>
<detail xsi:type="keyStringValuePair">
<key>CardType</key>
<value>MastercardDebit</value>
</detail>
</details>
</paymentAccount>
</payment>
</initiatePaymentResponse>
Updated over 1 year ago