Purchase - cbpurchase
This section describes the message parameters for EBT Card - Cash Benefit Purchase transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.
The cbpurchase
transaction completes the authorization of a non-Food Stamp purchase.
In this section:
Request
ssl_merchant_id 15 | numeric | required | Merchant ID Elavon-assigned Converge account ID. |
ssl_user_id 15 | alphanumeric | required | Converge User ID The user ID with Hosted Payment API User status that can send transaction requests through the terminal. |
ssl_pin 64 | alphanumeric | required | 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. |
ssl_transaction_type 20 | alphanumeric | required | Transaction Type Value: cbpurchase |
ssl_amount 11 | numeric | required | Transaction Amount The total purchase amount that includes the Cashback or Surcharge amount. Format: Number with 2 decimals places |
ssl_cashback_amount 12 | numeric | optional | Cashback Amount Amount to pay the cardholder for making a purchase transaction. Format: Number with 2 decimal places |
[Card Data] | Use the appropriate card data parameters for the transaction. |
ssl_card_number 18 | numeric | conditional | Card Number Card Number as it appears on the credit card. Important: Required for hand-keyed transactions. |
ssl_exp_date 4 | numeric | conditional | Card's Expiry Date Date when the card becomes invalid. Important: Required if ssl_card_number is not null.Format: MMYY |
ssl_track_data 76 | alphanumeric | conditional | Raw Track I and/or II Data Track data captured from the card's magnetic stripe. The data includes beginning and ending sentinels, card's expiry date, cardholder's first name, and the cardholder's last name. Important: Required for swiped or contactless transactions. |
[PIN Pad] | Values returned by the PIN Pad device. |
ssl_dukpt 20 | - | required | DUKPT Value used to encrypt the PIN of the cardholder. |
ssl_key_pointer 1 | alphanumeric | required | Triple-DES DUKPT Pointer Indicates the encryption key used on US debit transactions. Valid value: T - Triple-DES DUKPT |
ssl_pin_block 16 | - | required | Encrypted PIN Block The encrypted personal identification number entered by the debit or EBT cardholder to authenticate ownership of the card. |
[Dynamic DBA] |   |
ssl_dynamic_dba
21 | alphanumeric
|
Dynamic DBA
The dynamic doing business as name for this transaction. Lets a merchant specify, on a per-transaction basis, wording that may be more recognizable or more service-specific to the customer than their usual business name preventing chargebacks. This can prevent chargebacks by preventing users from seeing transactions attached to unrelated names on their payment card statements. |
ssl_dynamic_dba_address
30 | alphanumeric
|
Dynamic DBA Address
The dynamic doing business as street address for this transaction. This value lets a merchant use an alternate address for this transaction. |
ssl_dynamic_dba_auth_type
1 | alphanumeric
|
Merchant ID
The dynamic doing business as authorization type. Valid values:
|
ssl_dynamic_dba_city
13 | alphanumeric
|
Dynamic City Name
The dynamic doing business as city name. This value lets a merchant use an alternate city as part of the address for this transaction |
ssl_dynamic_dba_country
3 | alphanumeric
|
Dynamic Country ISO Code
The dynamic doing business as International Standards Organization country code. This value lets a merchant specify an alternate country as part of the address for this transaction. |
ssl_dynamic_dba_email
70 | alphanumeric
|
Dynamic Email Address
The dynamic doing business as email address. This value lets a merchant specify an alternate email address for this transaction. |
ssl_dynamic_dba_mcc
22 | numeric
|
Dynamic Merchant Category Code
The dynamic doing business as merchant category code. This value lets a merchant specify an alternate merchant category for this transaction. |
ssl_dynamic_dba_phone
20 | alphanumeric
|
Dynamic Phone Number
The dynamic doing business as phone number. This value lets a merchant specify an alternate phone number for this transaction. |
ssl_dynamic_dba_postal
9 | alphanumeric
|
Dynamic Postal or ZIP Code
The dynamic doing business as postal code. This value lets a merchant set an alternate postal code for a transaction. |
ssl_dynamic_dba_state
2 | alphanumeric
|
Dynamic State Code
The dynamic doing business as state code. This value lets a merchant set an alternate state code for a transaction. |
ssl_dynamic_dba_submid
22 | numeric
|
Dynamic Sub-merchant ID
The dynamic doing business as sub merchant ID. This value lets a merchant set an alternate sub-merchant ID for a transaction. |
ssl_dynamic_dba_taxid
14 | alphanumeric
|
Dynamic Merchant Tax ID
The dynamic doing business as Merchant Tax ID. This value lets a merchant set an alternate Tax ID for this transaction. |
Response
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 EBT Card 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 by the credit card processor that indicates the approval status of the transaction. |
ssl_reference_number | Transaction Reference Number |
ssl_card_number | Masked Card Number Converge only returns the first 2 or last 4 digits of the regular PAN. |
ssl_base_amount | Base Amount The purchase amount not including the cashback or surcharge amount. |
ssl_cashback_amount | Cashback Amount Amount to pay the cardholder for making a purchase transaction. Format: Number with 2 decimal places |
ssl_surcharge_amount | Surcharge Amount The fee that the merchant charges for the transaction as a cost for doing business. Format: Number with 2 decimal places |
ssl_amount | Transaction Amount The total transaction amount that may include the Surcharge or Cashback amount. |
ssl_email | Email Address The cardholder's or customer's email address. 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. |