Return - fsreturn

This section describes the message parameters for EBT Card - Food Stamp Return transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.

The fsreturn transaction refunds (credits) money onto the cardholder's EBT card. A return transaction will increase the cardholder's limit to buy once the batch containing the return has been settled or closed.

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: fsreturn
ssl_amount
11 | numeric | required
Transaction Amount
The amount to refund onto the EBT card.
Format: Number with 2 decimals places
ssl_reference_number
8 | numeric | required
Transaction Reference Number
Unique transaction reference number returned in the authorization response message of the original Food Stamp Purchase (fspurchase) transaction.
ssl_original_date
6 | numeric | optional
Original Transaction Date
The date of the original Food Stamp Purchase (fspurchase) transaction.
Format: MMDDYY
ssl_original_time
6 | numeric | optional
Original Transaction Time
The time of the original Food Stamp Purchase (fspurchase) transaction.
Format: HHMMSS
[Card Data]
 
ssl_track_data
76 | alphanumeric | required
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.
[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 EBT cardholder to authenticate ownership of the card.

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_exp_date
 
Card's Expiry Date
Returned based on merchant setup.
ssl_amount
 
Transaction Amount
The total refund 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.