Return - emvchipreturn

EMV return lets Converge users process refunds of a settled transaction. EMV Chip Return is available for both credit card and debit card EMV chips.

EMV Chip Returns can only affect a settled transaction.

Users can make partial returns linked to the same transaction.

Converge will return an error 5091 if a return would cause the total returns issued on a settled transaction to exceed the original amount paid on the settled transaction.

In this section:

For the entire list of API endpoints, refer to API Endpoints.

Request

Field nameDescriptionRequiredLengthData type
ssl_merchant_idMerchant ID
Elavon-assigned Converge Account ID (AID).
Required6 or 7numeric
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
Valid value:  emvchipreturn
Required20alphanumeric
ssl_txn_idTransaction ID
Unique identifier of the approved EMV Chip Sale (emvchipsale) transaction to be refunded or the approved EMV Chip Auth Only (emvchipauthonly) transaction to be completed.
Required46alphanumeric
ssl_tlv_encEncrypted Tag Length Value
Data defining the EMV record. The data includes the following:
  • Total Authorization Amount
  • Tip Amount (if available)
Required4hex
ssl_pos_modePOS Device Data Entry Capability
Indicates how the POS device captures card data.
Valid values:
  • 02 - Swipe-capable
  • 03 - Proximity or contactless-capable
Optional2numeric
ssl_entry_modeTransaction Entry Indicator
Indicates how the track data was captured.
Valid values:
  • 03 - Swiped (default)
Optional2numeric

Example

important

  • In this example, you will have to change the data values, such as my_merchant_id, my_user_id, my_pin, and transaction data to match your Converge account and meet the needs of your website.
  • Code samples provided are for demonstration only and should not be used for live transactions. All sensitive merchant data, including transaction amounts and your Converge credentials, should be placed in server side code.
xmldata=
<txn>
    <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_transaction_type>emvchipreturn</ssl_transaction_type>
    <ssl_tlv_enc>
        5F3002020157114761730000000010D151220100000000009F2608A0B1AB453C86165D9F27
        01805A0847617300000000105F2A0208405F2D0265659F4005F000F0A0019A031508159B02
        E8009F21030122399C01004004061820159F41040000023082025C009F1E08534330313030
        3438C00AFFFF44556600076000468407A00000000310105F340101950502000080005F200C
        5445535420434152442030319F1A0208409F1401039F02060000000017009F3901059F3602
        02899F370478813F359F0607A00000000310109F3501229F34031E03009F3303E0F8C89F03
        060000000000009F0902008C9F120B56697361204372656469744F07A00000000310109F11
        01019F100706010A03A000009F0702FF005F24031512319F530152D02845AF345545C28415
        29B3E3673B7538E0EE4ACAA24DA3E4158BAC0763A4EF024BFABF04822E063B865F28020124
        500B5649534120435245444954
    </ssl_tlv_enc>
    <ssl_entry_mode>4</ssl_entry_mode>
    <ssl_pos_mode>3</ssl_pos_mode>
</txn>