Purchase - ecspurchase

This section describes the message parameters for Electronic Check Purchase transaction processing, which you can submit using the Hosted Payments, Checkout.js, and XML API integration methods. Refer to the Integration Methods section for more information.

The ecspurchase transaction debits the purchase amount from a checking account.

In this section:

For the entire list of API endpoints, refer to API Endpoints.

Request

Field name	Description	Required	Length	Data type
`ssl_merchant_id`	Merchant ID Elavon-assigned Converge Account ID (AID).	Required	6 or 7	numeric
`ssl_user_id`	Converge User ID The user ID with Hosted Payment API User status that can send transaction requests through the terminal.	Required	15	alphanumeric
`ssl_pin`	Terminal ID Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway. Important: The `ssl_user_id` sending the transaction request must be associated with the terminal that will process the request.	Required	64	alphanumeric
`ssl_transaction_type`	Transaction Type Value: `ecspurchase`	Required	20	alphanumeric
`ssl_amount`	Transaction Amount The Sale amount that includes the Net and Sales Tax amounts. For Tip Processing, the Sale amount must not include the Tip amount. Format: Number with 2 decimal places	Required	11	numeric
[ECS Paper Check]	Uses a check reader device to capture data.
`ssl_micr_data`	Unformatted Magnetic Ink Character Recognition Data The exact MICR line from the check including the spaces and symbols. Replace the symbols with the following letters: `T` - Transit symbol `O` - On-US symbol `A` - Amount symbol `D` - Dash symbol	Required	80	alphanumeric
`ssl_check_image`	Check Image Scanned and encoded image of the check.	Required	BLOB	Base64 Encoded TIFF
`ssl_drivers_license_number`	Drivers License Number Unique identification code as it appears on the license. Important: Required for Guarantee transactions.	Conditional	16	alphanumeric
`ssl_drivers_license_phone_number`	Phone Number Contact number (includes the area code) as it appears on the license. Important: Required for Guarantee transactions.	Conditional	10	numeric
`ssl_drivers_license_state`	State Code State code as it appears on the license. Important: Required for Guarantee transactions.	Conditional	2	alphanumeric
[ACH ECheck]	Captures check data manually.
`ssl_aba_number`	Routing or Transit Number Unique code assigned to the bank to be able to send and receive funds from other financial institutions.	Required	9	alphanumeric
`ssl_bank_account_number`	Bank Account Number Unique identifier of the checking account.	Required	16	numeric
`ssl_bank_account_type`	Bank Account Type Indicates the type of checking account. Valid values: `0` - Personal `1` - Business	Required	1	numeric
`ssl_agree`	Agreement Indicator Valid values: `0` - Does not agree `1` - Agrees	Required	1	numeric
`ssl_first_name`	First Name First name on the cardholder’s / customer’s account or billing address. Important: Required if `ssl_bank_account_type` = 0.	Conditional	50	alphanumeric
`ssl_last_name`	Last Name Last name on the cardholder’s / customer’s account or billing address. Important: Required if `ssl_bank_account_type` = 0.	Conditional	50	alphanumeric
`ssl_company`	Company Name Company name on the cardholder’s / customer’s account or billing address. Important: Required if `ssl_bank_account_type` = 1.	Conditional	50	alphanumeric
`ssl_check_number`	Check Number Unique identifier commonly printed at the bottom of the check.	Optional	16	numeric
`ssl_ecs_product_code`	ACH Processing Option Overrides the default ACH type specified in Converge. Valid values: `WEB` - Web-based Check Processing For re-occurring or single Internet-initiated entry processed based on the customer’s input of account information at a payment application website `TEL` - Telephone-based Check Processing - For re-occurring or single entry in which an Electronic Payment Item is created based on the customer’s verbal authorization that is captured through phone `PPD` - Pre-arranged Payment and Deposit For re-occurring or single pre-arranged payment entry to a customer’s account pursuant to a written authorization that is obtained from the customer `CCD` - Corporate Credit or Debit A debit entry is initiated by an organization to another organization. Important: `WEB`, `TEL` or `PPD` is required if `ssl_bank_account_type` = 0. `CCD` is required if `ssl_bank_account_type` = 1.	Optional	3	alphanumeric
[Tip Processing]	Use only on terminals that are set up with the Market Segment set to Service.
`ssl_tip_amount`	Tip or Gratuity Amount Amount to add or update to the transaction amount. Format: Number with 2 decimal places	Required	11	numeric
`ssl_server`	Server ID Unique identifier of the clerk, waiter, waitress or cashier.	Optional	8	alphanumeric
`ssl_shift`	Shift ID Unique identifier of the time period, course or service type.	Optional	4	alphanumeric

Response

Field name	Description
`ssl_result`	Transaction Outcome An `ssl_result` = 0 indicates an approved transaction. An `ssl_result` not equal to 0 indicates a declined and unauthorized transaction.
`ssl_result_message`	Transaction Result Message Refer to the Electronic Check Response Codes section for an extensive list of possible returned messages.
`ssl_txn_id`	Transaction ID Unique identifier of the transaction.
`ssl_txn_time`	Processing Date and Time Indicates when Converge processed the transaction. Format: MM/DD/YYYY hh:mm:ss AM/PM Example: 03/18/2010 10:34:10 AM
`ssl_approval_code`	Transaction Approval Code Unique code returned that indicates the approval status of the transaction.
`ssl_reference_number`	Transaction Reference Number
`ssl_amount`	Total Transaction Amount The amount includes the Tip amount, if submitted in the request. Returned based on merchant setup.
`ssl_email`	Email Address The cardholder’s or customer’s email address. Returned based on merchant setup
[ECS Paper Check]
`ssl_drivers_license_number`	Drivers License Number
`ssl_drivers_license_phone_number`	Phone Number
`ssl_drivers_license_state`	State Code
[ACH ECheck]
`ssl_aba_number`	Routing or Transit Number Routing or Transit number form the parsed MICR data.
`ssl_bank_account_number`	Bank Account Number
`ssl_check_number`	Check Number
[Tip Processing]	Returned only if Tip parameters are sent in the request.
`ssl_base_amount`	Base Amount Original transaction amount sent in the request. Returned based on merchant setup.
`ssl_tip_amount`	Tip Amount Added or updated tip or gratuity amount. Returned based on merchant setup.
`ssl_server`	Server ID Server identifier sent in the request. Returned based on merchant setup.
`ssl_shift`	Shift Shift information sent in the request. Returned based on merchant setup.
[Error]	Returned only if an error occurs. Refer to the Error Codes section for more information.
`errorCode`	Error Code Typically, when the transaction failed validation or the request is incorrect. This will prevent the transaction from going to authorization. This is a numeric field.
`errorMessage`	Error Message Detailed explanation of the error. This field may be changed based on merchant configuration in the user interface.
`errorName`	Error Name Error name or reason for the error.

Example

important

In this example, you will have to change the data values, such as my_merchant_id, my_user_id, my_pin, and transaction data to match your Converge account and meet the needs of your website.
Code samples provided are for demonstration only and should not be used for live transactions. All sensitive merchant data, including transaction amounts and your Converge credentials, should be placed in server side code.

Request

xmldata=
<txn>
    <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_transaction_type>ecspurchase</ssl_transaction_type>
    <ssl_amount>20.00</ssl_amount>
    <ssl_bank_account_type>0</ssl_bank_account_type>
    <ssl_aba_number>123456789</ssl_aba_number>
    <ssl_bank_account_number>1234567890</ssl_bank_account_number>
    <ssl_agree>1</ssl_agree>
    <ssl_first_name>John</ssl_first_name>
    <ssl_last_name>Doe</ssl_last_name>
</txn>

Response

<txn>
    <ssl_approval_code>NACREN</ssl_approval_code>
    <ssl_agree>1</ssl_agree>
    <ssl_bank_account_type>0</ssl_bank_account_type>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_aba_number>123456789</ssl_aba_number>
    <ssl_reference_number>212182533</ssl_reference_number>
    <ssl_base_amount>20.00</ssl_base_amount>
    <ssl_amount>20.00</ssl_amount>
    <ssl_txn_id>AA49315-2C70E99A-F9E0-4C65-9339- F8E6AB917B4A</ssl_txn_id>
    <ssl_bank_account_number>12**********7890</ssl_bank_account_num ber>
    <ssl_result>0</ssl_result>
    <ssl_txn_time>02/12/2014 11:25:33 AM</ssl_txn_time>
</txn>

Cash Advance

Apple Pay

Magento Guide

Purchase - ecspurchase

Request

Response

Example

Request

Response