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:
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. 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: cbpurchase | Required | 20 | alphanumeric |
ssl_amount | Transaction Amount The total purchase amount that includes the Cashback or Surcharge amount. Format: Number with 2 decimals places | Required | 11 | numeric |
ssl_cashback_amount | Cashback Amount Amount to pay the cardholder for making a purchase transaction. Format: Number with 2 decimal places | Optional | 12 | numeric |
| [Card Data] | Use the appropriate card data parameters for the transaction. | |||
ssl_card_number | Card Number Card Number as it appears on the credit card. Required for hand-keyed transactions. | Conditional | 18 | numeric |
ssl_exp_date | Card’s Expiry Date Date when the card becomes invalid. Format: MMYY Required if ssl_card_number is not null. | Conditional | 4 | numeric |
ssl_track_data | 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 and last name. Required for swiped or contactless transactions. | Conditional | 76 | alphanumeric |
| [PIN Pad] | Values returned by the PIN Pad device. | |||
ssl_dukpt | DUKPT Value used to encrypt the PIN of the cardholder. | Required | 20 | - |
ssl_key_pointer | Triple-DES DUKPT Pointer Indicates the encryption key used on US debit transactions. Valid value: T - Triple-DES DUKPT | Required | 1 | alphanumeric |
ssl_pin_block | Encrypted PIN Block The encrypted personal identification number entered by the EBT cardholder to authenticate ownership of the card. | Required | 16 | - |
| [Dynamic DBA] | ||||
ssl_dynamic_dba | Dynamic 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. | - | 21 | alphanumeric |
ssl_dynamic_dba_address | Dynamic DBA Address This value allows a merchant to use an alternate address for this transaction. | - | 30 | alphanumeric |
ssl_dynamic_dba_auth_type | Merchant ID Valid values:
| - | 1 | alphanumeric |
ssl_dynamic_dba_city | Dynamic City Name This value allows a merchant to use an alternate city as part of the address for this transaction. | - | 13 | alphanumeric |
ssl_dynamic_dba_country | Dynamic Country ISO Code This value allows a merchant to specify an alternate country as part of the address for this transaction. | - | 3 | alphanumeric |
ssl_dynamic_dba_email | Dynamic Email Address This value allows a merchant to specify an alternate email address for this transaction. | - | 70 | alphanumeric |
ssl_dynamic_dba_mcc | Dynamic Merchant Category Code This value allows a merchant to specify an alternate merchant category for this transaction. | - | 22 | numeric |
ssl_dynamic_dba_phone | Dynamic Phone Number This value allows a merchant to specify an alternate phone number for this transaction. | - | 20 | alphanumeric |
ssl_dynamic_dba_postal | Dynamic Postal or ZIP Code This value allows a merchant to set an alternate postal code for a transaction. | - | 9 | alphanumeric |
ssl_dynamic_dba_state | Dynamic State Code This value allows a merchant to set an alternate state code for a transaction. | - | 2 | alphanumeric |
ssl_dynamic_dba_submid | Dynamic Sub-merchant ID This value allows a merchant to set an alternate sub-merchant ID for a transaction. | - | 22 | numeric |
ssl_dynamic_dba_taxid | Dynamic Merchant Tax ID This value allows a merchant to set an alternate Tax ID for this transaction. | - | 14 | 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 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 purchase 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. |