Elavon

Default Currency: USD

Developer Documentation:
https://developer.elavon.com/na/docs/converge/1.0.0/integration-guide/api_introduction (XML API)
https://demo.myvirtualmerchant.com/VirtualMerchantDemo/download/developerGuide.pdf

Gateway Endpoints
Production: https://api.convergepay.com/VirtualMerchant/processxml.do
Test: https://api.demo.convergepay.com/VirtualMerchantDemo/processxml.do

Supported Parameters:
^{* denotes a required field}

Field Name	Type	Elavon Mapping	Notes
gateway	string	N/A	Elavon
merchantId*	string	ssl_merchant_id	Merchant ID: Elavon-assigned Converge account ID
username*	string	ssl_user_id	Converge User ID: The user ID with Hosted Payment API User status that can send transaction requests through the terminal
password*	string	ssl_pin	Terminal ID: Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway
amount	numeric	ssl_amount	Transaction amount in cents. Example: $10.00 should be sent as 1000
currencyCode	string	ssl_transaction_currency	Currency of the transaction. Alpha-3 ISO currency code Use the ISO 4217 three-letter alphabetic code for the currency. * Only applicable to Card Authorize and Purchase
creditCard.Number	string	ssl_card_number	Card number or TokenEx Token - TokenEx will replace the Token with the Detokenized number
creditCard.ExpMonth	numeric	ssl_exp_date	The customer’s credit card expiration month. 1 or 2 digit value. Example: 11
creditCard.ExpYear	numeric	ssl_exp_date	The customer’s credit card expiration year. 4 digit value. Example: 2025
creditCard.Cvv	string	ssl_cvv2cvc2	Card verification value Please refer to Tokenization, Detokenization and CVV Retrieval.
threeDSecure.CAVV	string	ssl_3dsecure_value	Cardholder Authentication Verification (CAVV) (Visa) Universal Cardholder Authentication Field (UCAF) (MasterCard) Validates the integrity of the Verified by Visa (VbV) transaction data.
threeDSecure.ECI	string	ssl_eci_ind	eCommerce Indicator 5 - Fully authenticated (if eci = 02 or 05) 6 - Attempted VbV (if eci = 01 or 06) 7 - Non-VbV (if eci = 07)
threeDSecure.Xid	string	ssl_xid	Transaction identifier. Unique transaction identifier generated by the Elavon Merchant Plug In (eMPI) engine.
threeDSecure.ThreeDSecureVersion	string	ssl_3ds_message_version	1.0.2, 2.1.0, or 2.2.0.
threeDSecure.ThreeDSServerTransId	string	ssl_3ds_server_trans_id	3DS Server Transaction ID
threeDSecure.TransactionStatus	string	ssl_3ds_trans_status	Transaction Status (Y, N, U, etc.)
threeDSecure.TransactionStatusReason	string	ssl_3ds_trans_status_reason	Transaction Status Reason
threeDSecure.DSTransId	string	ssl_dir_server_tran_id	Directory Server Transaction Identification (ID)
threeDSecure.ProgramProtocol	string	ssl_program_protocol	1 (Legacy 3DS - 1.0.2) or 2 (EMVCo - 2.0.0 +)
check.FirstName	string	ssl_first_name	First name on the customer's account.
check.LastName	string	ssl_last_name	Last name on the customer's account.
check.AccountNumber	string	ssl_bank_account_number	ACH account number or TokenEx Token - TokenEx will replace the Token with the Detokenized number
check.RoutingNumber	string	ssl_aba_number	The ABA routing number.
check.CheckNumber	string	ssl_check_number	The number of the check.
check.AccountType	string	ssl_bank_account_type	Bank Account Type. Indicates the type of checking account. Valid Values 0 - Checking 1 - CorporateChecking
agreementIndicator	string	ssl_agree	Agreement Indicator. Valid values 0 - Does not agree 1 - Agrees
processingOption	string	ssl_ecs_product_code	ACH Processing Option. Valid values: `WEB`, `TEL`, `PPD`, `CCD` Important: IF ssl_bank_account_type = 0 (Checking), WEB, TEL or PPD is required. IF ssl_bank_account_type = 1 (CorporateChecking) then CCD is required.
companyName	string	ssl_company	Company name on the customer's account (ACH Purchase).
orderInfo.PurchaseOrderNumber	string	ssl_customer_code	Customer Code or Purchase Order Number
orderInfo.InvoiceNumber	string	ssl_invoice_number	Invoice/Ticket Number. Unique identifier of the invoice or ticket.
tax.Amount	numeric	ssl_salestax	Tax amount in cents. Example: $10.00 should be sent as 1000
tax.TaxIncludedInAmount	boolean	ssl_salestax_indicator	Sales Tax Indicator. Whether tax is included on a transaction. True = Sales Tax Included ("Y") False = Tax Exempted Sale ("N")
shippingAddress.FirstName	string	ssl_ship_to_first_name	First name associated with customer’s shipping address.
shippingAddress.LastName	string	ssl_ship_to_last_name	Last name associated with customer’s shipping address.
shippingAddress.Address1	string	ssl_ship_to_address1	First line of the shipping address
shippingAddress.City	string	ssl_ship_to_city	City of the shipping address
shippingAddress.State	string	ssl_ship_to_state	State or province of the shipping address
shippingAddress.Zip	string	ssl_ship_to_zip	Postal code for the shipping address
shippingAddress.Country	string	ssl_ship_to_country	Country Code. ISO country code.
billingAddress.FirstName	string	ssl_first_name	First name associated with customer’s billing address.
billingAddress.LastName	string	ssl_last_name	Last name associated with customer’s billing address.
billingAddress.Address1	string	ssl_avs_address	Customer’s billing address.
billingAddress.City	string	ssl_city	City of customer’s billing address.
billingAddress.State	string	ssl_state	State of customer’s billing address.
billingAddress.Zip	string	ssl_avs_zip	The postal code of customer’s billing address. Address Verification Service (AVS) data compared with the postal or ZIP code on the card issuer's file.
billingAddress.Country	string	ssl_country	Country Code. ISO country code.
billingAddress.Phone	string	ssl_phone	Phone number associated with customer’s billing address.

Example Payloads:

{
    "merchantId": "<Your Elavon-assigned Converge account Id>",
    "username": "<Your Converge User Id>",
    "password": "<Your Terminal Id>",
    "tokenExTransactionCode": "<TokenExTransactionCode provided by Authorize/Purchase call>",
    "gateway": "Elavon",
    "testMode": true
}

{
    "merchantId": "<Your Elavon-assigned Converge account Id>",
    "username": "<Your Converge User Id>",
    "password": "<Your Terminal Id>",
    "tokenExTransactionCode": "<TokenExTransactionCode provided by Authorize/Purchase call>",
    "amount": 123,
    "gateway": "Elavon",
    "testMode": true
}

{
    "merchantId": "<Your Elavon-assigned Converge account Id>",
    "username": "<Your Converge User Id>",
    "password": "<Your Terminal Id>",
    "tokenExTransactionCode": "<TokenExTransactionCode provided by Authorize/Purchase/Capture call>",
    "gateway": "Elavon",
    "testMode": true
}

{
    "merchantId": "<Your Elavon-assigned Converge account Id>",
    "username": "<Your Converge User Id>",
    "password": "<Your Terminal Id>",   
    "agreementIndicator": "1",
    "processingOption": "PPD",
    "check": {
        "accountNumber": "987654321",
        "routingNumber": "021000021",
        "checkNumber": "123456789",
        "firstName": "John",
        "lastName": "Doe",
        "accountType": 1
    },
    "billingAddress": {
        "phone": "555-555-5555",
        "fax": "555-555-6666",
        "email": "[email protected]",
        "firstName": "John",
        "lastName": "Doe",
        "name": "John Doe",
        "company": "Test Co.",
        "address1": "123 Someplace Lane",
        "address2": null,
        "city": "Tulsa",
        "state": "OK",
        "zip": "74111",
        "country": "USA"
    },
    "amount": 1200,
    "gateway": "Elavon", 
    "testMode": true
}

Operation Not Supported By Elavon Gateway

{
    "merchantId": "<Your Elavon-assigned Converge account Id>",
    "username": "<Your Converge User Id>",
    "password": "<Your Terminal Id>",
    "tokenExTransactionCode": "<TokenExTransactionCode provided by Authorize/Purchase call>",
    "gateway": "Elavon",
    "testMode": true
}

Gateway Response Fields:

Field Name	Type	TokenEx Mapping	Notes
approvalCode	string	ssl_approval_code	Elavon approval code
approved	boolean	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.
providerTransactionCode	string	ssl_txn_id	Transaction ID. Unique identifier of the transaction.