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 name Description Required Length Data type
ssl_merchant_id Merchant ID
Elavon-assigned Converge account ID.
Required 15 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.
error_outline

important

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: fsforcereturn
Required 20 alphanumeric
ssl_amount Transaction Amount
The amount to refund onto the EBT card.
Format: Number with 2 decimal places
Required 11 numeric
[Card Data]
ssl_card_number Card Number
Card Number as it appears on the credit card.
Required 18 numeric
ssl_exp_date Card's Expiry Date
Date when the card becomes invalid.
Format: MMYY
Required 4 numeric
[Voucher Clear Data]
ssl_voucher_number Voucher Clear Number
Derived from the merchant's Food Stamp sales slip.
Required 15 alphanumeric
ssl_approval_code Voucher Clear Approval Code
Unique code obtained using a phone.
Required 6 numeric

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_exp_date Card's Expiry Date
Returned based on merchant setup.
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.
ssl_voucher_number Voucher Clear Number
[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.