Export Scripts
Export scripts are a way to export the results of a merchant’s payment transactions and post them to a set location. Merchants can use this exported information for inventory, sales analysis, or customer database management.
Export scripts are an asynchronous authorization response method, allowing you to set an alternate destination for the transaction response. Converge will also send that response to the export destination you choose.
Once you’ve configured an export script, it will run after completion of a transaction. The script will return the results (approvals, declines, errors) of a payment to your web server using a standard HTTP POST request.
Export script generation uses default encoding (ISO-8859-1).
Export Script Setup
Set Up Scripts in App
To start running export scripts on your payments, log into the Converge Virtual Terminal and select the Terminal > Advanced > System Setup option located under the Export Options section.
Set Location URLs
You can enter three URLs to specify where Converge should post approved, declined, and erroneous transactions.
These URLs can all be the same, or they can be different. The URL should support HTTPS protocol and should point to a secure server. (Example: https://www.example-merchant.com
).
The URLs you provide can point to a page that uses user authentication. To do this, specify the username and password required to access the page in the Export Options.
Limit Exports
Enter an approval URL to limit your export scripts to run on approved transactions. If you do not provide an approval URL, the script will execute for both approved and declined transactions.
Set Confirmation String
Converge provides an extra verification process to allow you to submit a confirmation string that Converge will check each export script for. If our system does not detect this string, it fails the export script and issues an alert email.
If you want to use a confirmation string, enter it into the indicated field. You must include a username and password for authentication to use a confirmation string.
When you have completed all fields, you must click Update to save your settings.
Once you have set up the export script with the correct web page, it will start sending the transaction data to that page after each applicable transaction finishes processing.
Allowed IP Addresses
To receive an export script’s results, you will need to create a list of allowed IP ranges:
- 62.17.112.80 to 62.17.112.95 (62.17.112.80 /28)
- 62.134.193.208 to 62.134.193.223 (62.134.193.208 /28)
- 65.201.175.80 to 65.201.175.95 (65.201.175.80 /28)
- 204.137.47.32 to 204.137.47.47 (204.137.47.32 /28)
Export Script Examples
This is an example of the script that gets posted back to the merchant destination
(https://www.merchantinventory.com/postscriptshere)
POST https://www.merchantinventory.com/postscriptshere HTTP/1.1Content- Length:803Host:www. merchantinventory:-1Content-Type: application/x-www- form-urlencodeduser-agent:Apache-HttpClient/4.2.2 (java 1.5)authorization:{}
ssl_email=&
ssl_cvv2_response=M&Custom3=&
ssl_ship_to_phone=&
ssl_last_name=&Custom1=&Custom2=&
ssl_ship_to_country=&
ssl_ship_to_s tate=&
ssl_account_balance=4.00&
ssl_ship_to_zip=&
ssl_company=&
ssl_result_message=APPROVAL&
ssl_country=&
ssl_city=&
ssl_phone=&
ssl_invoice_number=&
ssl_ship_to_address2=&
ssl_ship_to_address1=&
ssl_transaction_currency=USD&
ssl_txn_id=AA4843B-8464D502-E195-46B7-838C-160E218558CF&
ssl_result=0&
ssl_ship_to_company=&
ssl_avs_response=&
ssl_tran saction_type=SALE&
ssl_approval_code=CVI463&
ssl_ship_to_last_name=&
ssl_avs_zip=&
ssl_ship_to_city=&
ssl_dynamic_dba=Sch.Med*&
ssl_exp_date=1215&
ssl_ship_to_first_name=&
ssl_avs_address=&
ssl_salestax=&
ssl_description=&
ssl_add ress2=&
ssl_first_name=&
ssl_amount=4.00&
ssl_state=&
ssl_card_number=00**********0000&
ssl_txn_time=01/03/2014 04:18:42 PM
This is an example of a similar transaction but authenticated (username here is USER) so when Converge reaches a destination it must provide the USER and the password in order to be allowed to post the data in green:
POST https://api.demo.convergepay.com/VirtualMerchantDemo/trans.do HTTP/1.1Content-Length:1060Host:api.demo.convergepay.com:-1Content- Type: application/x-www-form-urlencodeduser-agent:Apache- HttpClient/4.2.2 (java 1.5)authorization:{BASIC =[principal: USER]}
ssl_email=&
ssl_cvv2_response=M&Custom3=&
ssl_ship_to_phone=&
ssl_last_name=&Custom1=&Custom2=&
ssl_ship_to_country=&
ssl_ship_to_state=&
ssl_account_ balance=4.00&
ssl_ship_to_zip=&
ssl_company=&
ssl_result_message=APPROVAL&s sl_country=&
ssl_city=&
ssl_phone=&
ssl_invoice_number=&
ssl_ship_to_address2=&
ssl_ship_to_address1=&
ssl_transaction_currency=USD&
ssl_txn_id=AA4983B-8464D602-E195-46B7-838C-160E218876CF&
ssl_result=0&
ssl_ship_to_company=&
ssl_avs_response=&
ssl_transaction_type=SALE&
ssl_approval_code=CVI463&
ssl_ship_to_last_name=&
ssl_a vs_zip=&
ssl_ship_to_city=&
ssl_dynamic_dba=Sch.Med*&
ssl_exp_date=1215&
ssl_ship_to_first_name=&
ssl_avs_address=&
ssl_salestax=&
ssl_description=&
ssl_address2=&
ssl_first_name=&
ssl_amount=4.00&
ssl_state=&
ssl_card_number=00**********0000&
ssl_txn_time=01/03/2014 04:22:11 PM