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

Field nameDescriptionRequiredLengthData type
ssl_merchant_idMerchant ID
Elavon-assigned Converge account ID.
Required15numeric
ssl_user_idConverge User ID
The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
Required15alphanumeric
ssl_pinTerminal ID
Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway.
The ssl_user_id sending the transaction request must be associated with the terminal that will process the request.
Required64alphanumeric
ssl_transaction_typeTransaction Type
Value:cbpurchase
Required20alphanumeric
ssl_amountTransaction Amount
The total purchase amount that includes the Cashback or Surcharge amount.
Format: Number with 2 decimals places
Required11numeric
ssl_cashback_amountCashback Amount
Amount to pay the cardholder for making a purchase transaction.
Format: Number with 2 decimal places
Optional12numeric
[Card Data]Use the appropriate card data parameters for the transaction.
ssl_card_numberCard Number
Card Number as it appears on the credit card.
Required for hand-keyed transactions.
Conditional18numeric
ssl_exp_dateCard’s Expiry Date
Date when the card becomes invalid.
Format: MMYY
Required if ssl_card_number is not null.
Conditional4numeric
ssl_track_dataRaw 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 and last name.
Required for swiped or contactless transactions.
Conditional76alphanumeric
[PIN Pad]Values returned by the PIN Pad device.
ssl_dukptDUKPT
Value used to encrypt the PIN of the cardholder.
Required20-
ssl_key_pointerTriple-DES DUKPT Pointer
Indicates the encryption key used on US debit transactions.
Valid value:T - Triple-DES DUKPT
Required1alphanumeric
ssl_pin_blockEncrypted PIN Block
The encrypted personal identification number entered by the EBT cardholder to authenticate ownership of the card.
Required16-
[Dynamic DBA]
ssl_dynamic_dbaDynamic DBA
The dynamic doing business as name for this transaction.
Allows a merchant to specify, on a per-transaction basis, a more recognizable or more service-specific name to the customer. This can prevent chargebacks by preventing users from seeing transactions attached to unrelated names on their payment card statements.
-21alphanumeric
ssl_dynamic_dba_addressDynamic DBA Address
This value allows a merchant to use an alternate address for this transaction.
-30alphanumeric
ssl_dynamic_dba_auth_typeMerchant ID
Valid values:
- F - Final
- P - Pre-authorize
-1alphanumeric
ssl_dynamic_dba_cityDynamic City Name
This value allows a merchant to use an alternate city as part of the address for this transaction.
-13alphanumeric
ssl_dynamic_dba_countryDynamic Country ISO Code
This value allows a merchant to specify an alternate country as part of the address for this transaction.
-3alphanumeric
ssl_dynamic_dba_emailDynamic Email Address
This value allows a merchant to specify an alternate email address for this transaction.
-70alphanumeric
ssl_dynamic_dba_mccDynamic Merchant Category Code
This value allows a merchant to specify an alternate merchant category for this transaction.
-22numeric
ssl_dynamic_dba_phoneDynamic Phone Number
This value allows a merchant to specify an alternate phone number for this transaction.
-20alphanumeric
ssl_dynamic_dba_postalDynamic Postal or ZIP Code
This value allows a merchant to set an alternate postal code for a transaction.
-9alphanumeric
ssl_dynamic_dba_stateDynamic State Code
This value allows a merchant to set an alternate state code for a transaction.
-2alphanumeric
ssl_dynamic_dba_submidDynamic Sub-merchant ID
This value allows a merchant to set an alternate sub-merchant ID for a transaction.
-22numeric
ssl_dynamic_dba_taxidDynamic Merchant Tax ID
This value allows a merchant to set an alternate Tax ID for this transaction.
-14alphanumeric

Response

Field nameDescription
ssl_resultTransaction Outcome
An ssl_result = 0 indicates an approved transaction.
An ssl_result not equal to 0 indicates a declined and unauthorized transaction.
ssl_result_messageTransaction Result Message
Refer to the EBT Card Response Codes section for an extensive list of possible returned messages.
ssl_txn_idTransaction ID
Unique identifier of the transaction.
ssl_txn_timeProcessing 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_codeTransaction Approval Code
Unique code returned by the credit card processor that indicates the approval status of the transaction.
ssl_reference_numberTransaction Reference Number
ssl_card_numberMasked Card Number
Converge only returns the first 2 or last 4 digits of the regular PAN.
ssl_base_amountBase Amount
The purchase amount not including the cashback or surcharge amount.
ssl_cashback_amountCashback Amount
Amount to pay the cardholder for making a purchase transaction.
Format: Number with 2 decimal places
ssl_surcharge_amountSurcharge Amount
The fee that the merchant charges for the transaction as a cost for doing business.
Format: Number with 2 decimal places
ssl_amountTransaction Amount
The total purchase amount.
ssl_emailEmail 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.
errorCodeError 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.
errorMessageError Message
Detailed explanation of the error. This field may be changed based on merchant configuration in the user interface.
errorNameError Name
Error name or reason for the error.