api.securepay.comapi.securepay.com

homehome home Overview API Supported Web Service Protocols Service URLs Service API Functions Service Request Object Service Response Values AVS Response Code ACH Transaction Top Version 2.0.2 Last Updated: 9/9/2020 Overview The SecurePay 2 Payment API is a web service that allows merchants to securely interface with SecurePay to process transactions. The web service is an extension of the SecurePay gateway product offering and allows merchants who already have websites or applications to easily integrate with the SecurePay gateway to accept credit card payment. The API can be used in most programming languages that support web services. This API document provides the necessary information to transmit payment processing information to SecurePay’s gateway servers directly from a web server or other application connected to the internet using the standard SOAP web service protocol. API If you plan to utilize the SecurePay API the minimum requirements have to be met and are as follows listed below. These requirements have to be met if these requirements are not been met than you will not be able to use the SecurePay API as an integration method for your integration needs. Active SecurePay account. SecurePay Merchant ID. Website or Integration method must use HTTPS Supported Web Service Protocols SOAP – Simple Object Access Protocol. Common, platform independent communication protocol. Service URLs Development – https://apidev.securepay.net Production – https://api.securepay.net Service API Functions Below are the supported service API function(s). ProcessTransaction – is used to process a card transaction. Service Request Object Property Required Type Description MerchantID Yes long A unique merchant identifier assigned to the Merchant by SecurePay. TransactionKey Yes string A passcode to add an additional layer of protection to your online transactions. This prevents anyone from creating an interface to your merchant account without your authorization. This feature can be modified in the Merchant Portal under the SecureGuard link on the navigation menu. CreateToken No boolean Allows the card number to be converted into an encrypted token which allows you to process the card holder’s transaction without the card number being required. TransactionType Yes Alphanumeric Allows the card number to be converted into an encrypted token which allows you to process the card holder’s transaction without the card number being required. SALE – Indicates a charge to be placed against a credit card account. CREDIT – Indicates a refund or credit” to be placed against a credit card account. PREAUTH – Indicates a pre-authorization on a Credit Card. This is a temporary hold on an Amount submitted by the Merchant. This is not a qualified transaction and if not closed with a FORCE transaction it will release the hold after 5-7 days depending on the card issuer. This can have a negative impact on the funds availability of the card holder and should be used appropriately. FORCE – Indicates a closure of a previously PREAUTH (pre-authorized) transaction. VOID – Indicates a reversal of a transaction conducted on the same business day. Amount Yes decimal The amount of the transaction. Needs to be decimal format to 2 decimal places, ranging from 0.01 to 1000000.00. CardNumber Yes string The account number of the credit card. The type of card that is acceptable depends what is setup for the SecurePay account profile. SecurePay accepts Visa, MasterCard, Discover, and American Express cards to be processed through our gateway. This parameter is also used to process Tokens and Swipe Track Data. No spaces, dashes or other special characters. IsSwipe Yes boolean Indicator for a swipe transaction. ExpirationDate Yes * string i.e. 0118 The expiration date of the credit card. No spaces, dashes or other special characters. Not required for swipe transactions. CVV2 Yes * string The 3 or 4 digit security code that is issued on the credit card. Not required for swipe transactions. OriginalTransactionID No long The transaction ID issued upon completion of processing a transaction. This is used to issue Voids on transactions to remove authorization but must be completed before transaction has been settled to a batch. ApprovalCode No string The response code issued from a transaction. This code indicates that the Transaction is approved and the Card may be honored. The code can also be used to issue Credits on transactions that have been settled to a batch. TestRequest No boolean Identifies a transaction as a test request, for integration purposes. CardName Yes * string The name issued on the credit card. Not required for swipe transactions. Street Yes * string The billing street address associated with the credit card. Not required for swipe transactions. City Yes * string The billing city associated with the credit card. Not required for swipe transactions. State Yes * string i.e. NY, GA The billing state associated with the credit card. Not required for swipe transactions. Zip Yes string i.e. 30022 The billing zip code associated with the credit card. Country Yes * string i.e. US The billing country associated with the credit card. Not required for swipe transactions. Phone No string i.e. 800-123-4567 The contact number for the credit card holder. Email No string The email address for the credit card holder. CustomField1 No string Ties to Custom Field #1 for the merchant account. This allows the merchant to tie their data to the transaction (Invoice ID, etc…).This can be configured in the Merchant Portal under the Account Information link. CustomField2 No string Ties to Custom Field #2 for the merchant account. This allows the merchant to tie their data to the transaction (Invoice ID, etc…). This can be configured in the Merchant Portal under the Account Information link. CustomField3 No string Ties to Custom Field #3 for the merchant account. This allows the merchant to tie their data to the transaction (Invoice ID, etc…). This can be configured in the Merchant Portal under the Account Information link. MerchantReceipt No boolean Indicates whether an email receipt will be sent to the merchant. CardHolderReceipt No boolean Indicates whether an email receipt will be sent to the card holder. IsRecurring No boolean Indicates whether to add the card information as a recurring billing account. RecurringAmount No * decimal The amount that will be charged on a recurring basis. Needs to be decimal format to 2 decimal places. This field is required if IsRecurring = 1. RecurringStartDate No * date i.e. 10/15/2014 The date to start the recurring billing cycle. This field is required if IsRecurring = 1. RecurringEndDate No * date The date to end recurring billing. This field is required if IsRecurring = 1. RecurringFrequency No * string The frequency that the recurring billing will occur. This field is required if is Recurring = 1. Weekly – reprocess the transaction weekly. Monthly – reprocess the transaction once, monthly. Bimonthly – reprocess the transaction every two weeks. Quarterly – reprocess the transaction once a quarter (every 3 months). Annually – reprocess the transaction once a year. Biannually – reprocess the transaction twice a year. IsAchTransaction Yes boolean Indicator for a ACH transaction AccountNumber string Customer Bank Account Number for ACH RoutingNumber string Customer Routing Number for ACH AccountType string Customer Account Type, Personal, Business BankAccountType string Customer Account Type, Saving, Checking NameOnAccount string Customer name on the Bank Account Service Request example: REST SOAP JSON XML - Request URL: {service-url}/TransactionService.svc/Json/ProcessTransaction - Request Data: { "TestRequest": "true", "MerchantID": "merchant-id", "CardNumber": "4012888818888", "ExpirationDate": "1220", "CardName": "Test", "Street": "950 North Point Pwk", "City": "Alpharetta", "State": "GA", "Zip": "30022", "Country": "US", "Email": "jmartin@olb.com",...