Attached are a group of sample JSON requests for testing the API and below details regarding authentication and the flow the API requests. Access to Vantage’s merchant boarding system requires a list of IP addresses which should be allowed to access your credentials. If you change your IP addresses, please remember to provide a new list.

AUTHENTICATION

Authentication - https://testboarding.vantagepay.io/token
Authentication credentials:
client_id = Provided by Vantage
client_secret = Provided by Vantage
grant_type= client_credentials

Companies POST - https://testboarding.vantagepay.io/api/v1/companies
The https://testboarding.vantagepay.io/api/v1/companies SSN example is used to create Sole Proprietor accounts and requires the passing of the SSN in the EIN field under Account along with the first name, last name and DOB for the account.

                {
                    "companyName": "Vantage Sole Proprietor Test",
                    "email": "test@test.com",
                    "firstName": "Lucy",
                    "lastName": "Aacuba",
                    "homeAddress": "ABC 123 XYZ",
                    "homeCity": "PALMS",
                    "homeState": "CA",
                    "homeZip": "92274",
                    "political": false,
                    "previouslyAcceptCards": false,
                    "bankruptcy": false,
                    "currentlyAcceptingAch": false,
                    "accounts": [
                        {
                            "tierName": "Tier1",
                            "firstName": "Lucy",
                            "lastName": "Aacuba",
                            "dob": "1/1/1965",
                            "legalName": "Vantage Sole Proprietor Test",
                            "legalAddress": "2230 Towne Lake Parkway",
                            "legalCity": "Woodstock",
                            "legalState": "GA",
                            "legalZip": "30189",
                            "businessType": "SoleProprietor",
                            "ein": "123456789",
                            "webAddress": "www.vantagecard.com",
                            "dbaName": "Vantage Sole Proprietor Test",
                            "businessPhone": "770-928-5688",
                            "feeBankName": "Bank of America",
                            "feeBankPhone": "555-555-5555",
                            "feeAccountType": "Checking",
                            "feeRoutingNumber": "061000052",
                            "feeAccountNumber": "1234567890",
                            "fundingBankName": "Bank of America",
                            "fundingBankPhone": "555-555-5555",
                            "fundingAccountType": "Checking",
                            "fundingRoutingNumber": "061000052",
                            "fundingAccountNumber": "1234567890",
                            "clientCallbackUrl": "https://www.yourclientcallbackurl/token/1234567890",
                            "fees": [
                                {
                                    "description": "Custom Rate Description",
                                    "display": "3% flat rate"
                                },
                                {
                                    "description": "Custom ACH Fee",
                                    "display": "No fee"
                                }
                            ]
                        }
                    ]
                }
                

The https://testboarding.vantagepay.io/api/v1/companies EIN example is used for accounts that are not Sole Proprietor accounts. This request requires the passing of the federal tax id in the EIN field.

                {
                    "companyName": "Vantage Business Test",
                    "email": "test@test.com",
                    "firstName": "Lucy",
                    "lastName": "Aacuba",
                    "homeAddress": "ABC 123 XYZ",
                    "homeCity": "PALMS",
                    "homeState": "CA",
                    "homeZip": "92274",
                    "political": false,
                    "previouslyAcceptCards": false,
                    "bankruptcy": false,
                    "currentlyAcceptingAch": false,
                    "accounts": [
                        {
                            "tierName": "Tier1",
                            "legalName": "Vantage Business Test",
                            "legalAddress": "2230 Towne Lake Parkway",
                            "legalCity": "Woodstock",
                            "legalState": "GA",
                            "legalZip": "30189",
                            "businessType": "SoleProprietor",
                            "ein": "123456789",
                            "webAddress": "www.vantagecard.com",
                            "dbaName": "Vantage Business Test",
                            "businessPhone": "770-928-5688",
                            "feeBankName": "Bank of America",
                            "feeBankPhone": "555-555-5555",
                            "feeAccountType": "Checking",
                            "feeRoutingNumber": "061000052",
                            "feeAccountNumber": "1234567890",
                            "fundingBankName": "Bank of America",
                            "fundingBankPhone": "555-555-5555",
                            "fundingAccountType": "Checking",
                            "fundingRoutingNumber": "061000052",
                            "fundingAccountNumber": "1234567890",
                            "clientCallbackUrl": "https://www.yourclientcallbackurl/token/1234567890",
                            "fees": [
                                {
                                    "description": "Custom Rate Description",
                                    "display": "3% flat rate"
                                },
                                {
                                    "description": "Custom ACH Fee",
                                    "display": "No fee"
                                }
                            ]
                        }
                    ]
                }
                

Companies GET - https://testboarding.vantagepay.io/api/v1/companies
Returns a list of companies under your affiliate.

Company GET - https://testboarding.vantagepay.io/api/v1/companies/{CompanyId}
Returns a single Company with related Accounts

Account GET - https://testboarding.vantagepay.io/api/v1/accounts/{AccountId}
Returns a single Account

Request flow for creating a Merchant Account

1. Authenticate – using the /token endpoint
2. Company POST
   1. CompanyCreateRequest is where the information about the signer is passed. This is used in our KBA authentication process and Click to Agree Terms and Conditions section. The KBA/Agree to Terms section is hosted by us and can be reached using a link that’s passed back in the response from POST Company, GET Company and GET Account requests.
   2. AccountRequest is where merchant account information is passed. Sole Proprietor accounts require the SSN value passed in the EIN field along with the first name, last name and dob for the account. Also, passing a callbackUrl url in the AccountRequest will allow our server to notify your server when the merchant account is created.
3. KBA Authentication/Agree to Terms & Conditions – these pages are hosted by us and can be reached using the agreementUrl passed back in the POST Company, GET Company and GET Account requests.
4. Company GET – returns the Company entity based on the id passed in url. Related Accounts are included in the response.
5. Account GET – returns the Account entity based on the id passed in the url. The account includes information on status and will include the ProPay Account Number and Profile Id once the merchant account is created in the ProPay System.

Merchant Account Number and Profile Id

Account Number and Profile Id used with Protect Pay requests will be returned from the Vantage Boarding API following the completing of the underwriting process. The following JSON formatted request will be sent as a POST to the callback URL on your server.

                {
                    "CompanyId": 1,
                    "AccountId": 1,
                    "ExternalId": "ExternalId",
                    "LegalName": "Legal Name",
                    "DBAName": "DBAName",
                    "AccountStatus": 0, ['Pending' = 0, 'Open' = 1, 'Closed' = 2, 'Disagree' = 3, 'Declined' = 4, 'Hold' = 5]
                    "AgreeToTerms": true,
                    "Approved": true,
                    "MerchantAccountNumber": "700000000",
                    "MerchantProfileId": "3000000",
                    "TierName": "Tier1",
                    "FundAt": 0, ['Default' = 0, 'Booking' = 1, 'Event' = 2]
                    "Message": "",
                    "AptexxAccount": {
                        "TargetId": 1234
                    },
                    "Targets": [
                        {
                            "TargetId": 123456,
                            "TargetName": "Rent",
                            "ClientTargetId": 12345
                        }
                    ]
                }
                

TRANSACTION PROCESSING API

Important

The ProtectPay API and Payer Management Interface (PMI) solutions are to be used for payment method tokenization and processing. Using the ProPay API to process payments or tokenizing cards directly without the use of a PMI may increase your PCI validation requirements.

Access to ProPay’s real-time processing system will not work unless ProPay is provided with a list of IP addresses which should be allowed to access your credentials. If you change your IP addresses, and fail to supply ProPay with a new list, your system for processing using ProPay’s API will cease to function. (You will receive the 59 response)

Payment Processing SDK

• Payment Processing with ProtectPay

ProtectPay API Credentials
Affiliate Name: Vantage - Provided by Vantage
Affiliate ID = Provided by Vantage
AuthenticationToken = Provided by Vantage
BillerAccountId = Provided by Vantage
MerchantProfileId = Status passed back from Vantage Boarding API (i.e. Open)
Available tiers for ProPay account signups (additional tiers are available in production): Tier1, Tier2 and Tier3

Transaction processing

Recommended Integration: Use the ProtectPay API to create tokens and process
Use of ProtectPay API alone can help protect sensitive data in cases where you would otherwise store it. As such, use of a PMI is recommended. Furthermore, if you elect to forego use of a PMI, you must work with your relationship manager to ensure you understand compliance obligations based on your choice to integrate without a PMI.

1. Create PayerID (ProtectPay API 4.2.1)
   • This will return a static value that should be saved on your system for future transactions for this consumer
2. Process a Payment Method (Auth and capture) (ProtectPay 4.5.4)
3. Create a Payment Method (ProtectPay 4.3.1)
   • This returns a payment method (token) that should be saved along with the Payer ID as both values are required to process a transaction. You may save several payment methods for a single payer.
   • Pass Protected Flag as “true” to enroll card for updates in EnsureBill
4. Delete Payment Method (ProtectPay 4.3.4) / Delete Payer (ProtectPay 4.3.3)
   • Deleting a Payer will Delete all associated Payment Methods (this is not required)
   • Deleting Payment Methods may decrease your processing costs
   • It is recommended to monitor your usage of Payment Methods and regularly delete unnecessary Payment Methods
5. Edit a Payment Method (ProtectPay 4.3.3) for EnsureBill.
   • Mark Protected Flag to “true” to enroll in EnsureBill.
   • Mark Protected Flag to “false” to unenroll from EnsureBill.
   • Only necessary when changing the enrollment status of an existing Payment Method in EnsureBill or in conjunction with the Hosted Payments Page.

Voids and Refunds

Use the ProtectPay API to process voids and refunds

1. Process a void (ProtectPay 4.6.1)
2. Process a refund (ProtectPay 4.6.2)

More on Voids and refunds

1. A void cancels a transaction. A refund creates a new one (with a separate transaction ID)
2. In the case of a refund, a new transaction number will be returned to you.
3. Captured transactions may be voidable, use the API function to determine if the transaction is voidable before making this request.
4. When a transaction is not eligible for void, a refund will be attempted (even when you send an explicit void request using the ProtectPay API). Always check the status of a transaction before requesting a void.
5. Do not refund ACH transactions until enough time has passed for receiving notice of an ACH payment reject (typically 2-5 days depending on the payer’s bank).

Transaction processing Limits

Vantage uses monthly and per-transaction limits on merchant account processing to control risk. Make sure that your integration supports recognizing a “limit exceeded” response from the API and that you know to work with your relationship manager when that occurs. Please also work with your relationship manager to ensure you are set with appropriate limits, and that you have a plan in place for exceeding the same.

Additional support and sample code availability

To see available sample code, please email me with your preferred programming language.

Documentation

• Transaction Reporting API: https://reporting.vantagepay.io/docs/
• Document Upload API: https://reporting.vantagepay.io/documentupload/docs/

The API key to access = TBA
Using affiliate id = TBA

Please note that we will need to provide you with LIVE ProPay Transaction Processing Credentials and a LIVE Merchant Profile ID in order to perform LIVE Test Transactions that will generate LIVE data through the TX Reporting API.