iDebit Deposit (via IDS)

Payment Method iDebit Deposit is a online banking solution for the US and Canada.

The following method IDs are covered in this section:

ID	Name	Credit/Debit State
130	iDebitDeposit	DepositedByProvider (29)

Payment method interaction type: Redirection to External Payment Provider (see Interaction Types).

Redirect Integration

Currently not supported.

Backend2BackendIntegration

The following table contains the fields to be sent in the initiatePaymentRequest.specificPaymentData xml section:

key (value type, account type, required)	value
MiddleName (string)	The middle name of the user
AddressLine1* (string)	Home address line 1
AddressLine2* (string)	Home address line 2
PhoneNumberAreacode* (string)	Home phone area code
PhoneNumberLocalNumber* (string)	Home phone local number
ExtraField* (string)	Extra parameter. It is a pass-through only and provider IDS doesn´t record it

The following parameters can be provided in initiatePaymentRequest.userData:

key (value type, account type, required)	value
firstname (string (30))	The first name of the user
lastname* (string (30))	The last name of the user
languageCode* (string (2))	The language code of the user
dateOfBirth* (DateTime)	Date of birth
address.state* (string (20))	Home address state or province. Use standard 2-letter code for USA or Canada.
address.postalCode* (string (10))	Postal or ZIP code
address.countryCode2* (string (2))	Upper case two-letter country code (ISO 3166).
address.city* (string (30))	Home address city

Example initiatePaymentRequest:

<initiatePaymentRequest 
                        xmlns="http://www.cqrpayments.com/PaymentProcessing"
                        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <merchantID>KalixaAcceptDemo</merchantID>
  <shopID>KalixaAcceptDemo</shopID>
  <merchantTransactionID>d3086580-6351-4956-bb7d-2520e8098ce6</merchantTransactionID>
  <paymentMethodID>211</paymentMethodID>
  <amount currencyCode="EUR">10</amount>
  <userID>678358</userID>
  <userData>
    <username>democustomer</username>
    <firstname>testfirst</firstname>
    <lastname>testlast</lastname>
    <currencyCode>EUR</currencyCode>
    <languageCode>de</languageCode>
    <email>[email protected]</email>               
    <address>
      <postalCode>11444</postalCode>
      <city> berlin</city>
      <state>berlin</state>
      <countryCode2>US</countryCode2>
      <telephoneNumber>5067778888</telephoneNumber>
    </address>
    <dateOfBirth>1988-06-07T00:00:00</dateOfBirth>
  </userData >
  <userIP>127.0.0.1</userIP>
  <userSessionID>15208e51-9cfa-422e-9f6e-0a5b5e780e20</userSessionID>
  <creationTypeID>1</creationTypeID>
  <specificPaymentData>
    <data xsi:type="keyStringValuePair">
      <key>Middlename</key>
      <value>test</value>
    </data>
    <data xsi:type="keyStringValuePair">
      <key>PhoneNumberAreacode</key>
      <value>12345</value>
    </data>
    <data xsi:type="keyStringValuePair">
      <key>PhoneNumberLocalNumber</key>
      <value>23456</value>
    </data>
    <data xsi:type="keyStringValuePair">
      <key>AddressLine1</key>
      <value>testaddr1</value>
    </data>
    <data xsi:type="keyStringValuePair">
      <key>AddressLine2</key>
      <value>testaddr2</value>
    </data>
    <data xsi:type="keyStringValuePair">
      <key>ExtraField</key>
      <value>xxx</value>
    </data>
    <data xsi:type="keyStringValuePair">
      <key>SuccessPageUrl</key>
      <value>http://success/?a=b&amp;c=d</value>
    </data>
  </specificPaymentData>
</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>YourMerchantID</merchantID>
    <shopID>YourShopID</shopID>
    <paymentMethod>
      <key>211</key>
      <value>iDebitDeposit</value>
    </paymentMethod>
    <merchantTransactionID>d3086580-6351-4956-bb7d-2520e8098ce6</merchantTransactionID>
    <paymentID>c4642a17-a6c3-4afd-8c4b-e821fca4fc22</paymentID>
    <userID>678358</userID>
    <paymentProvider>
      <key>109</key>
      <value>InstaDebit</value>
    </paymentProvider>
    <amount currencyCode="EUR">10</amount>
    <creationType>
      <key>1</key>
      <value>User</value>
    </creationType>
    <userIP>127.0.0.1</userIP>
    <state>
      <id>7346cf00-de3b-4cde-8ce3-622330f6831b</id>
      <definition>
        <key>287</key>
        <value>RedirectDataCreated</value>
      </definition>
      <createdOn>2012-08-03T10:17:00.8739349Z</createdOn>
      <description>https://staging.idebitpayments.com/idebit/merGateway.do
        merchant_id='DemoG'
        merchant_user_id='678358'
        merchant_txn_num='4618'
        txn_amount='10.00'
        txn_currency='EUR'
        first_name='testfirst'
        middle_name='t'
        last_name='testlast'
        addr_1='testaddr1'
        addr_2='testaddr2'
        city='berlin'
        state='berlin'
        zip='11444'
        country='DE'
        hph_area_code='123'
        hph_local_number='23456'
        dob_day='7'
        dob_month='6'
        dob_year='1988'
        extra_field_1='xxx'
        return_url='http://success/?a=b&amp;c=d'
        lang='de'
      </description>
      <paymentStateDetails>
        <detail xsi:type="keyStringValuePair">
          <key>RedirectionUrl</key>
          <value> https://staging.idebitpayments.com/idebit/merGateway.do</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDatamerchant_id</key>
          <value>DemoG</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDatamerchant_user_id</key>
          <value>678358</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDatamerchant_txn_num</key>
          <value>4618</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDatatxn_amount</key>
          <value>10.00</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDatatxn_currency</key>
          <value>EUR</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDatafirst_name</key>
          <value>testfirst</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDatamiddle_name</key>
          <value>t</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDatalast_name</key>
          <value>testlast</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDataaddr_1</key>
          <value>testaddr1</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDataaddr_2</key>
          <value>testaddr2</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDatacity</key>
          <value>berlin</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDatastate</key>
          <value>berlin</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDatazip</key>
          <value>11444</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDatacountry</key>
          <value>DE</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDatahph_area_code</key>
          <value>123</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDatahph_local_number</key>
          <value>23456</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDatadob_day</key>
          <value>7</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDatadob_month</key>
          <value>6</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDatadob_year</key>
          <value>1988</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDataextra_field_1</key>
          <value>xxx</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDatareturn_url</key>
          <value>http://success/?a=b&amp;c=d</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDatalang</key>
          <value>de</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>PostDataKeys</key>
          <value>merchant_id,merchant_user_id,merchant_txn_num,txn_amount,txn_currency,first_name,middle_name,last_name,addr_1,addr_2,city,state,zip,country,hph_area_code,hph_local_number,dob_day,dob_month,dob_year,extra_field_1,return_url,lang</value>
        </detail>
      </paymentStateDetails>
    </state>
    <isExecuted>false</isExecuted>
    <baseAmount currencyCode="EUR">10</baseAmount>
    <paymentDetails>
      <detail xsi:type="keyStringValuePair">
        <key>ProviderExternalID</key>
        <value>4618</value>
      </detail>
    </paymentDetails>
    <paymentAccount>
      <paymentAccountID>0</paymentAccountID>
    </paymentAccount>
  </payment>
</initiatePaymentResponse>

Possible payment states in initiatePaymentResponse:

Payment States	Description
RedirectDataCreated (287)	The merchant system should retrieve the redirect URL from payment.state.paymentStateDetails (key: RedirectionUrl). Post data should be extracted from payment.state.paymentStateDetails(key: PostData…).
DuplicatePaymentValidationFailed (369)	Error state: duplicate payment

Notifications

The standard notification mechanism is used for notifying the merchant in the background (asynchronously) about payment state changes. For more information see PaymentStateChangedNotification.