Cash Advance - emvswipecashadvance

This section describes the message parameters for EMV Swipe Cash Advance transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.

The emvswipecashadvance transaction obtains real-time cash advance for a chip credit card using swipe. The cash advance option must be enabled in the terminal for performing emvswipecashadvance transaction.

note

An emvchipupdatetxn transaction must be sent once an emvswipecashadvance has been completed and the Chip card has returned additional data.
POS system will need to update the chip or device with the Issuer Script received from the authorization.

In this section:

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

Request

Field name	Description	Required	Length	Data type
`ssl_amount`	Transaction Amount Amount sent for authorization, approval or refund. Important: When submitting transaction amounts to terminals that are set up with the Multi Currency credit payment option, make sure that the number of decimal places are correct as some currencies have 0 (like JPY) or 3 (like BHD) decimal places. Format: Number with 2 decimals places	Required	11	numeric
`ssl_merchant_id`	Merchant ID Elavon-assigned Converge Account ID (AID).	Required	6 or 7	numeric
`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 Valid value: `emvswipecashadvance`	Required	20	alphanumeric
`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
[Card Data]
`ssl_pos_mode`	POS Device Data Entry Capability Indicates how the POS device captures card data. Valid values: `04` - EMV chip-capable (ICC) - Contact only with magnetic stripe `05` - EMV chip-capable (ICC) - Dual interface with magnetic stripe	Required	2	numeric
`ssl_entry_mode`	Transaction Entry Indicator Indicates how the track data was captured. Valid values: `05` - EMV (ICC) with CVV or iCVV `06` - EMV (ICC) Proximity Read `07` - EMV (ICC) without CVV or iCVV	Required	2	numeric
`ssl_enc_track_data`	Encrypted Raw Track I and/or II Data Encrypted Track I and/or II data captured from the card’s magnetic stripe when using an Ingenico encrypting device. The data includes beginning and ending sentinels, card’s expiry date, cardholder’s first and last name.	Conditional	160	alphanumeric
`ssl_ksn`	Key Serial Number Unique identifier generated from the swiped payment card and returned by the encrypting device. The KSN encrypts the PAN data through the DUKPT method. Required if submitting `ssl_enc_track_data`, `ssl_enc_track1_data` or `ssl_enc_track2_data` in the transaction request.	Required	20	alphanumeric
[Optional Fields]
`ssl_vm_mobile_source`	Mobile Source Valid values: `BBERRY` - BlackBerry Mobile Device `ADROID` - Android Mobile Device `ITUNES` - Apple Mobile Device `WIN8` - Windows WIN8-based Device `NOMOB` - Non-mobile Device Required for encrypting devices.	Optional	-	alphanumeric
`ssl_vendor_id`	Vendor ID Unique vendor identifier assigned by Elavon. Required for encrypting devices and certification.	Conditional	8	alphanumeric
`ssl_decline_offline`	Decline Transaction Indicator Indicates the action for the EMV card or reader to take when terminals are offline. Valid values: `Y` - Chip card or reader declines transaction `N` - Chip card or reader approves transaction	Optional	1	alphanumeric
[Invoice Number]	Use only on terminals that are set up with the Invoice Number credit card payment option
`ssl_invoice_number`	Invoice/Ticket Number Unique identifier of the invoice or ticket.	Optional	25	alphanumeric
[Doing Business As]	Use only on terminals that are set up with the DBA Name terminal option.
`ssl_dynamic_dba`	Doing Business As Name Merchant-defined descriptors that replace the merchant’s business name on credit card statements. Format: PrefixDescriptor Length:* Prefix = 3, 7, or 12, Asterisk = 1, Descriptor = 21 - (Prefix + Asterisk) Important: DBA Prefix must be set using DBA Payment Fields Settings UI if ssl_dynamic_dba is used. Example: MANYMAG*BAKERS MONTHLY	Conditional	21	alphanumeric
`ssl_dynamic_dba_address`	Dynamic DBA Address The dynamic doing business as street address for this transaction. This value allows a merchant use an alternate address for this transaction.	Optional	30	alphanumeric
`ssl_dynamic_dba_auth_type`	Merchant ID The dynamic doing business as authorization type. Valid values: `F` - Final `P` - Pre-authorize	Optional	1	alphanumeric
`ssl_dynamic_dba_city`	Dynamic City Name This value allows a merchant use an alternate city as part of the address for this transaction	Optional	13	alphanumeric
`ssl_dynamic_dba_country`	Dynamic Country ISO Code This value allows a merchant specify an alternate country as part of the address for this transaction.	Optional	3	alphanumeric
`ssl_dynamic_dba_email`	Dynamic Email Address This value allows a merchant specify an alternate email address for this transaction.	Optional	70	alphanumeric
`ssl_dynamic_dba_mcc`	Dynamic Merchant Category Code This value allows a merchant specify an alternate merchant category for this transaction.	Optional	22	numeric
`ssl_dynamic_dba_phone`	Dynamic Phone Number This value allows a merchant specify an alternate phone number for this transaction.	Optional	20	alphanumeric
`ssl_dynamic_dba_postal`	Dynamic Postal or ZIP Code This value allows a merchant set an alternate postal code for a transaction.	Optional	9	alphanumeric
`ssl_dynamic_dba_state`	Dynamic State Code This value allows a merchant set an alternate state code for a transaction.	Optional	2	alphanumeric
`ssl_dynamic_dba_submid`	Dynamic Sub-merchant ID This value allows a merchant set an alternate sub-merchant ID for a transaction.	Optional	22	numeric
`ssl_dynamic_dba_taxid`	Dynamic Merchant Tax ID This value allows a merchant set an alternate Tax ID for this transaction.	Optional	14	alphanumeric
[Purchasing Cards]	Use only on terminals that are set up with the Purchasing Card 2 credit card payment option
`ssl_customer_code`	Customer Code or Purchase Order Number Customer ID or PO number specified in the billing statement of the cardholder.	Optional	17	alphanumeric
`ssl_salestax`	Sales Tax Tax amount to add to the purchase or sales amount. For a tax exempt transaction, enter 0.00. Format: Amount with 2 decimal places.	Optional	8	alphanumeric
[Travel Data]	Use only on terminals that are set up with the Travel Data credit card payment option.
`ssl_departure_Date`	Travel Departure Date Date sent to the Merchant Airline Risk Monitoring System (MARMS) to monitor risks associated with advanced booking. Format: MM/DD/YYYY	Optional	10	alphanumeric
`ssl_completion_Date`	Travel Completion Date Date sent to the Merchant Airline Risk Monitoring System (MARMS) to monitor risks associated with advanced booking. Format: MM/DD/YYYY	Optional	10	alphanumeric
`ssl_bin_override`	Override Bank Identification Number (BIN) Allows the integrated application to pass the `ssl_Customer_code` and/or `ssl_salestax` values for non-corporate cards. Valid value: `1` - Pass customer code and/or sales tax for non-corporate card transaction requests	Optional	1	numeric
`ssl_lane_number`	Lane Number A unique identifier for point of sale devices that can be passed to satisfy Mastercard’s unique Terminal ID requirement	Optional	8	numeric

Response

Field name	Description
`ssl_account_balance`	Account balance Available balance on the card.
`ssl_account_type`	Account Type on File Valid values: `Checking` `Savings` `Default`
`ssl_amount`	Transaction Amount The total transaction amount that may include the Surcharge or Cashback amount.
`ssl_address2`	Address Line 2 Apartment or condominium unit number and floor number on the cardholder’s or customer’s account or billing address.
`ssl_approval_code`	Transaction Approval Code Unique code returned by the credit card processor that indicates the approval status of the transaction.
`ssl_avs_address`	Address Line 1 Address Verification Service (AVS) data compared with the address on the card issuer’s file. Commonly the house number and street name on the cardholder’s / customer’s account or billing address. Recommended for hand-keyed transactions to qualify for better interchange rates.
`ssl_avs_zip`	Postal or ZIP Code Address Verification Service (AVS) data compared with the postal or ZIP code on the card issuer’s file. Recommended for hand-keyed transactions to qualify for better interchange rates.
`ssl_card_number`	Masked Card Number Converge only returns the first 2 or last 4 digits of the regular PAN.
`ssl_card_type`	Card Type Valid values: `Credit` (default if parameter is null) `Debit`
`ssl_card_short_description`	Short Card Brand Name Valid values are: `MC` and `VISA`.
`ssl_city`	City City name on the cardholder’s / customer’s account or billing address.
`ssl_company`	Company Name Company name on the cardholder’s / customer’s account or billing address.
`ssl_country`	Country ISO Code Country ISO code on the cardholder’s / customer’s account or billing address.
`ssl_email`	Email Address The cardholder’s or customer’s email address.
`ssl_exp_date`	Card’s Expiry Date Returned based on merchant setup Format: MMYY
`ssl_first_name`	First Name First name on the cardholder’s / customer’s account or billing address.
`ssl_last_name`	Last Name Last name on the cardholder’s / customer’s account or billing address.
`ssl_issuer_response`	Original Issuer Response The issuer response returned during the authorization attempt. An `ssl_issuer_response` = 00 indicates success. An `ssl_issuer_response` not equal to 00 indicates a decline or failure.
`ssl_phone`	Phone Phone number on the cardholder’s / customer’s account or billing address. Important: Accepts dashes.
`ssl_ship_from_postal_code`	ZIP Code ZIP or postal code of the originating address. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
`ssl_ship_to_address1`	Address Line 1 House number and street name on the shipping address.
`ssl_ship_to_address2`	Address Line 2 Apartment or condominium unit number and floor number on the shipping address.
`ssl_ship_to_city`	City Name of the city on the shipping address.
`ssl_ship_to_company`	Company Name Name of the company (recipient) on the shipping address.
`ssl_ship_to_country`	Country Country ISO code on the shipping address.
`ssl_ship_to_first_name`	First Name First name of the recipient on the shipping address.
`ssl_ship_to_last_name`	Last Name Last name of the recipient on the shipping address.
`ssl_ship_to_phone`	Phone Phone number on the shipping address.
`ssl_ship_to_state`	State Code State code on the shipping address.
`ssl_ship_to_zip`	ZIP Code Postal or ZIP code on the shipping address.
`ssl_state`	State Code State or province code on the cardholder’s / customer’s account or billing address.
`ssl_transaction_type`	Transaction Type Valid value: `emvswipecashadvance`
`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/2020 10:34:10 AM
`ssl_response_code`	Authorization Result Code Refer to the EMV Card Response Codes section for an extensive list of possible returned response codes.
`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 Debit Card Response Codes section for an extensive list of possible returned messages. Important: When the Chip sends a decline by card, submit an `emvreverse` transaction to reverse an approved authorization.
`ssl_state`	State Code State or province code on the cardholder’s / customer’s account or billing address.
`ssl_tran_code`	Transaction code from the original authorization attempt
`ssl_update_emv_keys`	Update EMV Keys Indicator Indicates whether an EMV key exchange is needed because the Issuer keys have changed. Valid values: `Y` - Perform EMV key exchange `N` - Do not perform EMV key exchange Important: If set to Y, perform an `emvkeyexchange` transaction.
[Invoice Number]	Returned only if Invoice Number parameters are sent in the request.
`ssl_invoice_number`	Invoice Number The invoice number or ticket number sent in the original request.
[Card On File]
`ssl_oar_data`	Original Authorization Response Data This data will be as received during the original authorization processing. This is a retain and return value for terminal-based settlement messages. You may store this field with the payment details from the transaction to make future Card On File transactions.
`ssl_ps2000_data`	PS2000 This data will be as received during the original authorization processing. This is a retain and return value for terminal-based settlement messages. You must store this field with the payment details from the transaction to make future Card On File transactions.
[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.

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.

Request

A swipe cash advance of 11.00.

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>EMVSWIPECASHADVANCE</ssl_transaction_type>
    <ssl_enc_track_data>35227AD6839F8174FECE3F5F769CB30F3F26F3B2EA7A919CC9618C0FC55A4BB32D8D10F93D347DD905BE2B559C64C8CCFBF288FE7E2D5B8F0E3C9B613F20A193E5123ABB0B0A5B342F58AA6C1395ECA68197944A96BC53B9FF911A28FF884BEAF5456CFB357EA2310B443398D40CDF68C4CBFAC4EDDCCC3A</ssl_enc_track_data>
    <ssl_amount>11.00</ssl_amount>
    <ssl_pos_mode>05</ssl_pos_mode>
    <ssl_entry_mode>03</ssl_entry_mode>
</txn>

Response

xmldata=
<txn>
    <ssl_transaction_type>EMVSWIPECASHADVANCE</ssl_transaction_type>
    <ssl_response_code>AA</ssl_response_code>
    <ssl_txn_id>091221M33-1025CF6C-F562-4478-9988-F7BB83F6B865</ssl_txn_id>
    <ssl_txn_time>12/09/2021 12:49:52 PM</ssl_txn_time>
    <ssl_card_type>CREDITCARD</ssl_card_type>
    <ssl_issuer_response>00</ssl_issuer_response>
    <ssl_account_balance>0.00</ssl_account_balance>
    <ssl_ps2000_data>MMCC828755 1209</ssl_ps2000_data>
    <ssl_oar_data>010001560712091749521209000816800000000000327265MCC828755</ssl_oar_data>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_result>0</ssl_result>
    <ssl_approval_code>327265</ssl_approval_code>
    <ssl_card_number>54**********4111</ssl_card_number>
    <ssl_exp_date>1222</ssl_exp_date>
    <ssl_amount>11.00</ssl_amount>
    <ssl_card_short_description>MC</ssl_card_short_description>
    <ssl_tran_code>000</ssl_tran_code>
    <ssl_company/>
    <ssl_first_name>TEST CARD 05 </ssl_first_name>
    <ssl_last_name>UAT CAN</ssl_last_name>
    <ssl_avs_address/>
    <ssl_address2/>
    <ssl_city/>
    <ssl_state/>
    <ssl_avs_zip>80112</ssl_avs_zip>
    <ssl_country/>
    <ssl_phone/>
    <ssl_email/>
    <ssl_ship_to_company/>
    <ssl_ship_to_first_name/>
    <ssl_ship_to_last_name/>
    <ssl_ship_to_address1/>
    <ssl_ship_to_address2/>
    <ssl_ship_to_city/>
    <ssl_ship_to_state/>
    <ssl_ship_to_zip/>
    <ssl_ship_to_country/>
    <ssl_ship_to_phone/>
</txn>

Cash Advance

Apple Pay

Magento Guide

Cash Advance - emvswipecashadvance

Request

Response

Example

Request

Response