GuidesAPI ReferenceDiscussions

Retrieve Payment Account Details

Suggest Edits

The details of a payment account can be retrieved by calling Account GET.
See Account GET for details.

📘

How to Test

See Overview for details about the API endpoints.

Please note the /v4 in the resource path
(Test: https://payments.test.kalixa.com/api/v4/)

For testing against the Test environment, please use the default credentials:

Username = KalixaAcceptDemoSystemUser
Password = KalixaAcceptDemoPassword

Please use Basic authentication to authenticate the request:

Authorization = Basic S2FsaXhhQWNjZXB0RGVtb1N5c3RlbVVzZXI6S2FsaXhhQWNjZXB0RGVtb1Bhc3N3b3Jk

Redirect Integration

Not available

Backend2Backend Integration

In Kalixa's system, Payment Accounts are scoped to the level of a particular customer, belonging to a particular merchant.

As a result, you have to pass in 3 parameters:

  • The ID of the Merchant
  • The ID of the User
  • The ID of the Payment Account you want to retrieve

Example:

The following initiatePayment request was called:

<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>KalixaAcceptDEMO</merchantID>
  <shopID>KalixaAcceptDEMO</shopID>
  <merchantTransactionID>Order99999</merchantTransactionID>
  <paymentMethodID>2</paymentMethodID>
  <amount currencyCode="EUR">100</amount>
  <userID>u12312312</userID>
  <userData>
    <username>johndoe</username>
    <firstname>John</firstname>
    <lastname>Doe</lastname>
    <currencyCode>EUR</currencyCode>
    <languageCode>EN</languageCode>
    <email>[email protected]</email>
    <address>
      <street>Marxergasse</street>
      <houseNumber>1b</houseNumber>
      <postalCode>1030</postalCode>
      <city>Vienna</city>
      <countryCode2>AT</countryCode2>
      <telephoneNumber>00437778889999</telephoneNumber>
    </address>
    <dateOfBirth>1980-10-10T00:00:00</dateOfBirth>
    <gender>Male</gender>
  </userData>

  <userIP>127.0.0.1</userIP>
  <userSessionID>123</userSessionID>
  <creationTypeID>1</creationTypeID>

  <specificPaymentData>
    <data xsi:type="keyStringValuePair">
      <key>PaymentDescription</key>
      <value>some 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>4111111111111111</value>
      </data>
      <data xsi:type="keyStringValuePair">
        <key>CardVerificationCode</key>
        <value>111</value>
      </data>
      <data xsi:type="keyStringValuePair">
        <key>HolderName</key>
        <value>John Doe</value>
      </data>
      <data xsi:type="keyIntValuePair">
        <key>ExpiryMonth</key>
        <value>1</value>
      </data>
      <data xsi:type="keyIntValuePair">
        <key>ExpiryYear</key>
        <value>2099</value>
      </data>
    </specificPaymentAccountData>
  </paymentAccount>

</initiatePaymentRequest>

Response:

<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>KalixaAcceptDEMO</merchantID>
    <shopID>KalixaAcceptDEMO</shopID>
    <paymentMethod>
      <key>2</key>
      <value>VISA Deposit</value>
    </paymentMethod>
    <merchantTransactionID>Order99999</merchantTransactionID>
    <paymentID>86b10ad3-d7f6-43fe-bccf-cfde79689584</paymentID>
    <userID>u12312312</userID>
    <paymentProvider>
      <key>92</key>
      <value>CQRUK</value>
    </paymentProvider>
    <amount currencyCode="EUR">100</amount>
    <creationType>
      <key>1</key>
      <value>User</value>
    </creationType>
    <userIP>127.0.0.1</userIP>
    <state>
      <id>b8c96597-97f7-4ed8-ba63-1d512f8eb62a</id>
      <definition>
        <key>13</key>
        <value>AuthorisedByProvider</value>
      </definition>
      <createdOn>2017-03-29T13:52:03.9956024Z</createdOn>
      <description>Approved or completed successfully</description>
      <paymentStateDetails>
        <detail xsi:type="keyStringValuePair">
          <key>ProviderResponseCode</key>
          <value>0</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>ApprovalCode</key>
          <value>129560</value>
        </detail>
      </paymentStateDetails>
    </state>
    <isExecuted>true</isExecuted>
    <baseAmount currencyCode="EUR">100</baseAmount>
    <paymentDetails>
      <detail xsi:type="keyStringValuePair">
        <key>ProviderExternalID</key>
        <value>471762</value>
      </detail>
    </paymentDetails>
    <paymentAccount>
      <paymentAccountID>7d3d1fce-3b15-438f-a63d-db92ce576f57</paymentAccountID>
    </paymentAccount>
  </payment>
</initiatePaymentResponse>

Kalixa's system has created a card payment account and returned the token ID - 7d3d1fce-3b15-438f-a63d-db92ce576f57.

If you want to retrieve the information of this account, call

GET https://payments.test.kalixa.com/api/v4/merchants/KalixaAcceptDEMO/users/u12312312/accounts/7d3d1fce-3b15-438f-a63d-db92ce576f57

The response will look like this

{
    "accounts": [
        {
            "cardNumber": "************1111",
            "expiryMonth": 1,
            "expiryYear": 2099,
            "holderName": "John Doe",
            "cardToken": "6f2a7407-1e7d-480a-83de-41804aa3d00d",
            "issuerCountryCode": null,
            "issuerName": null,
            "accountFundingSource": null,
            "id": "7d3d1fce-3b15-438f-a63d-db92ce576f57",
            "paymentAccountTypeID": 1,
            "paymentMethodID": 0
        }
    ]
}

Updated almost 3 years ago