Force Return - fsforcereturn

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

The fsforcereturn transaction completes the authorization, which is obtained using a phone, of a Food Stamp refund.

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:fsforcereturn
Required20alphanumeric
ssl_amountTransaction Amount
The amount to refund onto the EBT card.
Format: Number with 2 decimal places
Required11numeric
[Card Data]
ssl_card_numberCard Number
Card Number as it appears on the credit card.
Required18numeric
ssl_exp_dateCard’s Expiry Date
Date when the card becomes invalid.
Format: MMYY
Required4numeric
[Voucher Clear Data]
ssl_voucher_numberVoucher Clear Number
Derived from the merchant’s Food Stamp sales slip.
Required15alphanumeric
ssl_approval_codeVoucher Clear Approval Code
Unique code obtained using a phone.
Required6numeric

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_exp_dateCard’s Expiry Date
Returned based on merchant setup.
ssl_amountTransaction Amount
The total purchase amount.
ssl_emailEmail Address
The cardholder’s or customer’s email address. Returned based on merchant setup.
ssl_voucher_numberVoucher Clear Number
[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.