Pay Tool Data

Special Notes:

• Int PayToolCounter - number of payment tool slots;
• Str PayToolSlot_N – data slot #N of information about payment tool which is going to be used to pay the order. Defines payment method used to pay the order. Generally, for credit card payments it is enough to submit PayToolID and arbitrary IPAddressID.

  Pay Tool data are submitted as strings of the following format:

  <PayToolSlotName>=<PayToolSlotValue>

  Where:

  • <PayToolSlotName> is a name of the payment tool data slot;
  • <PayToolSlotValue> is a value of the payment tool data slot;

  Parallels Business Automation supports the following payment tool data slots:

  • Check/Cash:
    • PayToolTypeID=3;
    • PluginID=0;
    • IPAddressID - customers current IP address.
  • Registered credit card:
    • PayToolID - ID of registered payment method.
    • IPAddressID - customers current IP address.
  • New Credit Card:
    • PayToolTypeID=0; "1" - bank account, "2" - external redirect, "3" - Check/Cash;
    • CardTypeID - ID of payment system registered in PBA, for example. "Visa", "MasterCard", etc;
    • CardNumberID - CC number;
    • CardHolderNameID - card holder name;
    • CVCID - CC security code;
    • IssueNumID - credit card issue number, can be skipped if payment system doesn't require;
    • StartDateID - credit card start date, can be skipped if payment system doesn't require;
    • ExpDateID - CC expiration date in format MM/YY;
    • BillingAddressID - first line of billing address;
    • BillingAddress2ID - second line of billing address;
    • BillingCityID - card holder's city;
    • BillingStateID - card holder's state;
    • BillingZipID - card holder's ZIP or postal code;
    • BillingCountryID - cardholder's country;
    • BillingEmailID - cardholder email;
    • BillingPhoneCountryID - phone code of cardholder country;
    • BillingPhoneAreaID - phone area code;
    • BillingPhoneNumberID - phone number;
    • BillingPhoneExtensionID - phone extension, optional;
    • BillingFaxCountryID - fax code of cardholder country;
    • BillingFaxAreaID - fax phone area code;
    • BillingFaxNumberID - fax number;
    • BillingFaxExtensionID - fax extension, optional.
    • IPAddressID - customers current IP address.

      Note: parameters with prefix Billing are optional. If these parameters are not passed, values of respective parameters from ContactDataSlot are taken.

  • Bank Account:
    • PayToolTypeID=1;
    • BankNumberID - customer bank number;
    • AccountNumberID - customer bank account number;
    • AccountHolderNameID - account holder name;
    • IPAddressID - customers current IP address.
  • External Redirect:
    • PayToolTypeID=2
    • IPAddressID - customers current IP address.

Check/Cash Example:

         <!-- PayToolCounter -->

         <value><i4>3</i4></value>

         <!-- Type of Payment tool. 3 means Check/Cash -->

         <value>PayToolTypeID=3</value>

         <!-- Identifier of payment plug-in Check/Cash -->

         <value>PluginID=0</value>

         <!-- IP Address -->

         <value>IPAddressID=192.168.232.10</value>

Registered Credit Card Example:

         <!-- PayToolCounter -->

         <value><i4>2</i4></value>

         <!-- Identifier of Payment tool registered on Customer's Account -->

         <value>PayToolID=3</value>

         <!-- IP Address -->

         <value>IPAddressID=192.168.232.10</value>

New Credit Card Example:

         <!-- PayToolCounter -->

         <value><i4>7</i4></value>

         <!-- Type of Payment tool. 0 means Credit Card -->

         <value>PayToolTypeID=0</value>

         <!-- Type of CC -->

         <value>CardTypeID=Visa</value>

         <!-- Card Number -->

         <value>CardNumberID=4111111111111111</value>

         <!-- Cardholder name -->

         <value>CardHolderNameID=JOHN SMITH</value>

         <!-- Security code -->

         <value>CVCID=123</value>

         <!-- Expiration date -->

         <value>ExpDateID=07/08</value>

         <!-- IP Address -->

         <value>IPAddressID=192.168.232.10</value>

Bank Account:

         <!-- PayToolCounter -->

         <value><i4>5</i4></value>

         <!-- Type of Payment tool. 1 means Bank Account -->

         <value>PayToolTypeID=1</value>

         <!-- Number of customer bank -->

         <value>BankNumberID=45689</value>

         <!-- Account Number -->

         <value>AccountNumberID=356892145</value>

         <!-- Accountholder name -->

         <value>AccountHolderNameID=JOHN SMITH</value>

         <!-- IP Address -->

         <value>IPAddressID=192.168.232.10</value>

External Redirect:

         <!-- PayToolCounter -->

         <value><i4>3</i4></value>

         <!-- Type of Payment tool. 2 means External Redirect -->

         <value>PayToolTypeID=2</value>

         <!-- IP Address -->

         <value>IPAddressID=192.168.232.10</value>

Please send us your feedback on this help page