Skip to main content

Elavon

Overview​

Gateway Website: http://www.elavon.com
Developer Documentation:
https://developer.elavon.com/products/converge/v1/credit-card-transactions-overviewguide/api_introduction (XML API)
Default Currency: USD

Request Objects: BillingAddress, ShippingAddress, CreditCard, Check, OrderInfo, ThreeDSecure

Gateway Endpoints
This implementation of Elavon forwards requests to the below endpoints.
Production: https://api.convergepay.com/VirtualMerchant/processxml.do
Sandbox: https://api.demo.convergepay.com/VirtualMerchantDemo/processxml.do

Supported Request Parameters​

* denotes a required field
Field NameTypeElavon MappingNotes
gatewaystringN/AElavon
merchantId*stringssl_merchant_idMerchant ID: Elavon-assigned Converge account ID
username*stringssl_user_idConverge User ID: The user ID with Hosted Payment API User status that can send transaction requests through the terminal
password*stringssl_pinTerminal ID: Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway
amountnumericssl_amountTransaction amount in cents. Example: $10.00 should be sent as 1000
currencyCodestringssl_transaction_currencyCurrency 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.​Numberstringssl_card_numberCard number or TokenEx Token - TokenEx will replace the Token with the Detokenized number
creditCard.​ExpMonthnumericssl_exp_dateThe customer’s credit card expiration month. 1 or 2 digit value. Example: 11
creditCard.​ExpYearnumericssl_exp_dateThe customer’s credit card expiration year. 4 digit value. Example: 2025
creditCard.​Cvvstringssl_cvv2cvc2Card verification value

Please refer to Tokenization, Detokenization and CVV Retrieval.
threeDSecure.​CAVVstringssl_3dsecure_valueCardholder Authentication Verification (CAVV) (Visa)
Universal Cardholder Authentication Field (UCAF) (MasterCard)
Validates the integrity of the Verified by Visa (VbV) transaction data.
threeDSecure.​ECIstringssl_eci_indeCommerce Indicator

5 - Fully authenticated (if eci = 02 or 05)
6 - Attempted VbV (if eci = 01 or 06)
7 - Non-VbV (if eci = 07)
threeDSecure.​Xidstringssl_xidTransaction identifier. Unique transaction identifier generated by the Elavon Merchant Plug In (eMPI) engine.
threeDSecure.​ThreeDSecureVersionstringssl_3ds_message_version1.0.2, 2.1.0, or 2.2.0.
threeDSecure.​ThreeDSServerTransIdstringssl_3ds_server_trans_id3DS Server Transaction ID
threeDSecure.​TransactionStatusstringssl_3ds_trans_statusTransaction Status (Y, N, U, etc.)
threeDSecure.​TransactionStatusReasonstringssl_3ds_trans_status_reasonTransaction Status Reason
threeDSecure.​DSTransIdstringssl_dir_server_tran_idDirectory Server Transaction Identification (ID)
threeDSecure.​ProgramProtocolstringssl_program_protocol1 (Legacy 3DS - 1.0.2) or 2 (EMVCo - 2.0.0 +)
check.​FirstNamestringssl_first_nameFirst name on the customer's account.
check.​LastNamestringssl_last_nameLast name on the customer's account.
check.​AccountNumberstringssl_bank_account_numberACH account number or TokenEx Token - TokenEx will replace the Token with the Detokenized number
check.​RoutingNumberstringssl_aba_numberThe ABA routing number.
check.​CheckNumberstringssl_check_numberThe number of the check.
check.​AccountTypestringssl_bank_account_typeBank Account Type. Indicates the type of checking account.
Valid Values
0 - Checking
1 - CorporateChecking
agreementIndicatorstringssl_agreeAgreement Indicator.
Valid values
0 - Does not agree
1 - Agrees
processingOptionstringssl_ecs_product_codeACH 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.
companyNamestringssl_companyCompany name on the customer's account (ACH Purchase).
orderInfo.​PurchaseOrderNumberstringssl_customer_codeCustomer Code or Purchase Order Number
orderInfo.​InvoiceNumberstringssl_invoice_numberInvoice/Ticket Number. Unique identifier of the invoice or ticket.
tax.​Amountnumericssl_salestaxTax amount in cents. Example: $10.00 should be sent as 1000
tax.​TaxIncludedInAmountbooleanssl_salestax_indicatorSales Tax Indicator. Whether tax is included on a transaction.
True = Sales Tax Included ("Y")
False = Tax Exempted Sale ("N")
shippingAddress.​FirstNamestringssl_ship_to_first_nameFirst name associated with customer’s shipping address.
shippingAddress.​LastNamestringssl_ship_to_last_nameLast name associated with customer’s shipping address.
shippingAddress.​Address1stringssl_ship_to_address1First line of the shipping address
shippingAddress.​Citystringssl_ship_to_cityCity of the shipping address
shippingAddress.​Statestringssl_ship_to_stateState or province of the shipping address
shippingAddress.​Zipstringssl_ship_to_zipPostal code for the shipping address
shippingAddress.​Countrystringssl_ship_to_countryCountry Code. ISO country code.
billingAddress.​FirstNamestringssl_first_nameFirst name associated with customer’s billing address.
billingAddress.​LastNamestringssl_last_nameLast name associated with customer’s billing address.
billingAddress.​Address1stringssl_avs_addressCustomer’s billing address.
billingAddress.​Citystringssl_cityCity of customer’s billing address.
billingAddress.​Statestringssl_stateState of customer’s billing address.
billingAddress.​Zipstringssl_avs_zipThe 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.​Countrystringssl_countryCountry Code. ISO country code.
billingAddress.​Phonestringssl_phonePhone number associated with customer’s billing address.

Example Requests​

{
  "gateway": "Elavon",
  "merchantId": "<Your Elavon-assigned Converge account Id>",
  "username": "<Your Converge User Id>",
  "password": "<Your Terminal Id>",
  "amount": 1200,
  "creditCard": {
    "number": "4000000000000002",
    "expMonth": 6,
    "expYear": 2026,
    "cvv": "123"
  },
  "billingAddress": {
    "phone": "555-555-5555",
    "firstName": "John",
    "lastName": "Doe",
    "company": "Test Co.",
    "address1": "123 Someplace Lane",
    "address2": "Some Place",
    "city": "Tulsa",
    "state": "OK",
    "zip": "74111",
    "country": "USA"
  },
  "shippingAddress": {
    "phone": "555-555-5555",
    "firstName": "John",
    "lastName": "Doe",
    "company": "Test Co.",
    "address1": "123 Someplace Lane",
    "address2": "Some Place",
    "city": "Tulsa",
    "state": "OK",
    "zip": "74111",
    "country": "USA"
  }
}

Gateway Response Parameters​

Field NameTypeTokenEx MappingNotes
approvalCodestringssl_approval_codeElavon approval code
approvedbooleanssl_resultTransaction Outcome
An ssl_result = 0 indicates an approved transaction.
An ssl_result not equal to 0 indicates a declined and unauthorized transaction.
providerTransactionCodestringssl_txn_idTransaction ID. Unique identifier of the transaction.

Example Responses​

{
  "gatewayResponse": {
    "rawResponse": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<txn><ssl_issuer_response>00</ssl_issuer_response><ssl_last_name>Appleseed</ssl_last_name><ssl_company></ssl_company><ssl_phone>555-555-5555</ssl_phone><ssl_card_number>40**********0002</ssl_card_number><ssl_departure_date></ssl_departure_date><ssl_oar_data>010012263012052135090000047554200000000000577569333921122630</ssl_oar_data><ssl_result>0</ssl_result><ssl_txn_id>051223C44-67FB7BB6-74B8-41A8-981B-7AA44C8A92B4</ssl_txn_id><ssl_avs_response>R</ssl_avs_response><ssl_approval_code>577569</ssl_approval_code><ssl_email></ssl_email><ssl_amount>4.01</ssl_amount><ssl_avs_zip>74111</ssl_avs_zip><ssl_transaction_currency>USD</ssl_transaction_currency><ssl_txn_time>12/05/2023 03:35:09 PM</ssl_txn_time><ssl_description></ssl_description><ssl_exp_date>0825</ssl_exp_date><ssl_card_short_description>VISA</ssl_card_short_description><ssl_completion_date></ssl_completion_date><ssl_address2></ssl_address2><ssl_get_token>N</ssl_get_token><ssl_customer_code></ssl_customer_code><ssl_country>USA</ssl_country><ssl_card_type>CREDITCARD</ssl_card_type><ssl_transaction_type>AUTHONLY</ssl_transaction_type><ssl_salestax></ssl_salestax><ssl_avs_address>123 Someplace Lane</ssl_avs_address><ssl_account_balance>0.00</ssl_account_balance><ssl_ps2000_data>W7533397770937155330A</ssl_ps2000_data><ssl_state>OK</ssl_state><ssl_ship_to_zip></ssl_ship_to_zip><ssl_city>Tulsa</ssl_city><ssl_result_message>APPROVAL</ssl_result_message><ssl_first_name>Johnny`</ssl_first_name><ssl_invoice_number></ssl_invoice_number><ssl_ship_to_address1></ssl_ship_to_address1><ssl_cvv2_response>N</ssl_cvv2_response><ssl_partner_app_id>01</ssl_partner_app_id></txn>",
    "gatewayErrors": [],
    "tokenExTransactionCode": "MDUxMjIzQzQ0LTY3RkI3QkI2LTc0QjgtNDFBOC05ODFCLTdBQTQ0QzhBOTJCNDswMQ==",
    "approvalCode": "577569",
    "providerTransactionCode": "051223C44-67FB7BB6-74B8-41A8-981B-7AA44C8A92B4",
    "approved": true
  },
  "referenceNumber": "23120515350834240943",
  "success": true,
  "error": "",
  "message": "",
  "thirdPartyStatusCode": "200"
}
Last updated on