Getting Started

Welcome to Chargezoom Reseller API!

Authentication and Usage Overview

Chargezoom provides a API secret key to each Reseller Account and it can be used to create the access token which will be required in all request(s) as a token key in form data.

Steps to Create Secret Key:
  1. Login to Chargezoom Merchant Dashboard.
  2. Click on the Configuration > "API" link in the left navigation bar.
  3. There is an option to create the API secret key using "Add New" button. When Add New button is clicked then it will ask for the Name and Domain. Please enter any valid name and the merchant subdomain url.
  4. Use "API Key Production" secret as API secretKey in all the API(s).

Authentication

Using our Authentication API endpoint allows you to create your token for login, refresh your token, and gain access to your API controls.

Required step to generate original token and login to API.

Header Parameters
Key Description Required Type
secretKey API secret key Yes String
Body Parameters
Key Description Required Type Default Restrictions
resellerEmail Reseller Email Address Yes String - -
resellerPassword Reseller Password Yes String - -

URL

                                                    
                                                        https://resellerapi.payportal.com/Authentication/login

Request Example

                                                    
                                                        {
                                                            "resellerEmail": "test@chargezoom.com",
                                                            "resellerPassword": "abc123!@#"
                                                        }

Response Example

                                                    
                                                        {
                                                          "message": "Login success.",
                                                          "data": {
                                                            "token": "eyJ0eXAiOiJKVa....."
                                                          },
                                                          "code": 200
                                                        }

Required to generate a token using your last token you used. Tokens expire after 2 hours. It is recommended to generate a token or refresh your last token in an enterprise application before an endpoint call.

Header Parameters
Key Description Required Type
secretKey API secret key Yes String
Body Parameters
Key Description Required Type Default Restrictions
token Token received using the last token you received from refresh or generate. Yes String - -

URL

                                                    
                                                        https://resellerapi.payportal.com/Authentication/refreshToken

Request Example

                                                    
                                                        {
                                                            "token": "eyJ0eXAiOiJKVa......."
                                                        }

Response Example

                                                    
                                                        {
                                                          "message": "Token regenerated successfully.",
                                                          "data": {
                                                            "token": "eyJ0eXAiOiJKVa....."
                                                          },
                                                          "code": 200
                                                        }

Merchant Gateways

You can retrieve a list of Merchant Gateways. Then take which merchant gateway you want a merchant to have and add it to their available gateway list. As well delete a gateway from a merchant.

Retrieve a list of all merchant gateways available to be added to the merchant.

Header Parameters
Key Description Required Type
secretKey API secret key Yes String
token Token received using the last token you received from refresh or generate. Yes String

URL

                                                    
                                                        https://resellerapi.payportal.com/Resellers/merchantGateways

Response Example

                                                    
                                                        {
                                                          "message": "Gateway list",
                                                          "data": [
                                                            {
                                                              "gatewayID": "1",
                                                              "gatewayName": "NMI",
                                                              "gatewayUniqueId": "NMI_GATEWAY",
                                                              "gatewayRequiredFields": [
                                                                "nmiUserName",
                                                                "nmiPassword"
                                                              ]
                                                            },
                                                            {
                                                              "gatewayID": "2",
                                                              "gatewayName": "Authorize.net",
                                                              "gatewayUniqueId": "AUTHORIZE_GATEWAY",
                                                              "gatewayRequiredFields": [
                                                                "authorizeApiKey",
                                                                "authorizeTransactionId"
                                                              ]
                                                            },
                                                            {
                                                              "gatewayID": "3",
                                                              "gatewayName": "PayTrace",
                                                              "gatewayUniqueId": "PAYTRACE_GATEWAY",
                                                              "gatewayRequiredFields": [
                                                                "payTraceUserName",
                                                                "payTracePassword"
                                                              ]
                                                            },
                                                            {
                                                              "gatewayID": "4",
                                                              "gatewayName": "PayPal",
                                                              "gatewayUniqueId": "PAYPAL_GATEWAY",
                                                              "gatewayRequiredFields": [
                                                                "paypalApiUserName",
                                                                "paypalApiPassword"
                                                              ]
                                                            },
                                                            {
                                                              "gatewayID": "5",
                                                              "gatewayName": "Stripe",
                                                              "gatewayUniqueId": "STRIPE_GATEWAY",
                                                              "gatewayRequiredFields": [
                                                                "stripePublishableKey",
                                                                "stripeSecretApiKey"
                                                              ]
                                                            },
                                                            {
                                                              "gatewayID": "6",
                                                              "gatewayName": "USAePay",
                                                              "gatewayUniqueId": "USAEPAY_GATEWAY",
                                                              "gatewayRequiredFields": [
                                                                "UsaePayTransactionKey",
                                                                "UsaePayPin"
                                                              ]
                                                            },
                                                            {
                                                              "gatewayID": "7",
                                                              "gatewayName": "Heartland",
                                                              "gatewayUniqueId": "HEARTLAND_GATEWAY",
                                                              "gatewayRequiredFields": [
                                                                "heartlandPublicKey",
                                                                "heartlandSecretKey"
                                                              ]
                                                            },
                                                            {
                                                              "gatewayID": "8",
                                                              "gatewayName": "CyberSource",
                                                              "gatewayUniqueId": "CYBERSOURCE_GATEWAY",
                                                              "gatewayRequiredFields": [
                                                                "cyberMerchantId",
                                                                "cyberSerialNumber",
                                                                "cyberSecretKey"
                                                              ]
                                                            },
                                                            {
                                                              "gatewayID": "9",
                                                              "gatewayName": "Chargezoom",
                                                              "gatewayUniqueId": "CHARGEZOOM_GATEWAY",
                                                              "gatewayRequiredFields": [
                                                                "chargezoomUserName",
                                                                "chargezoomPassword"
                                                              ]
                                                            },
                                                            {
                                                              "gatewayID": "10",
                                                              "gatewayName": "iTransact",
                                                              "gatewayUniqueId": "ITRANSACT_GATEWAY",
                                                              "gatewayRequiredFields": [
                                                                "itransactUserName",
                                                                "itransactApiKey"
                                                              ]
                                                            },
                                                            {
                                                              "gatewayID": "11",
                                                              "gatewayName": "FluidPay",
                                                              "gatewayUniqueId": "FLUIDPAY_GATEWAY",
                                                              "gatewayRequiredFields": [
                                                                "fluidPayApiKey"
                                                              ]
                                                            },
                                                            {
                                                              "gatewayID": "12",
                                                              "gatewayName": "TSYS",
                                                              "gatewayUniqueId": "TSYS_GATEWAY",
                                                              "gatewayRequiredFields": [
                                                                "tsysApiUserId",
                                                                "tsysApiPassword",
                                                                "tsysGatewayMerchantId"
                                                              ]
                                                            },
                                                            {
                                                              "gatewayID": "13",
                                                              "gatewayName": "BASYS iQ Pro",
                                                              "gatewayUniqueId": "BASYS_GATEWAY",
                                                              "gatewayRequiredFields": [
                                                                "basysApiKey"
                                                              ]
                                                            },
                                                            {
                                                              "gatewayID": "14",
                                                              "gatewayName": "CardPointe",
                                                              "gatewayUniqueId": "CARDPOINTE_GATEWAY"
                                                            },
                                                            {
                                                              "gatewayID": "15",
                                                              "gatewayName": "PayArc Payment",
                                                              "gatewayUniqueId": "PAYARC_GATEWAY",
                                                              "gatewayRequiredFields": [
                                                                "payarcSecretKey"
                                                              ]
                                                            },
                                                            {
                                                              "gatewayID": "16",
                                                              "gatewayName": "EPX",
                                                              "gatewayUniqueId": "EPX_GATEWAY"
                                                            },
                                                            {
                                                              "gatewayID": "17",
                                                              "gatewayName": "Maverick",
                                                              "gatewayUniqueId": "MAVERICK_GATEWAY",
                                                              "gatewayRequiredFields": [
                                                                "maverickAccessToken",
                                                                "maverickTerminalId"
                                                              ]
                                                            },
                                                            {
                                                              "gatewayID": "18",
                                                              "gatewayName": "Intuit",
                                                              "gatewayUniqueId": "INTUIT_GATEWAY",
                                                              "gatewayRequiredFields": [
                                                                "intuitClientId",
                                                                "intuitClientSecret"
                                                              ]
                                                            },
                                                            {
                                                              "gatewayID": "25",
                                                              "gatewayName": "Cardknox",
                                                              "gatewayUniqueId": "CARDKNOX_GATEWAY",
                                                              "gatewayRequiredFields": [
                                                                "cardknoxApiKey"
                                                              ]
                                                            }
                                                          ]
                                                        }

Use this endpoint to add a supported merchant gateway to an existing merchants account for use. It is also required to add the gatewayRequiredFields that are provided in the supported merchant gateway response. They are included below the body parameters for each gateway.

Header Parameters
Key Description Required Type
secretKey API secret key Yes String
token Token received using the last token you received from refresh or generate. Yes String
Body Parameters
Key Description Required Type Default Restrictions
merchantId Merchant Id Yes integer - -
gatewayIdentifier Gateway Identifier Yes String - Gateway Identifier ie. NMI_GATEWAY, AUTHORIZE_GATEWAY. Check Merchant Gateways API to see the list of Gateways and their Identifier
friendlyName Gateway friendly name Yes String - -
setAsDefault 0 or 1, 1=>Yes, 0=>No Yes integer - -
gatewayRequiredFields
Key Description Required Type
nmiUserName NMI_USER_NAME Yes String
nmiPassword NMI_USER_PASSWORD Yes String
Key Description Required Type
authorizeApiKey AUTHORIZE_API_KEY Yes String
authorizeTransactionKey AUTHORIZE_TRANSACTION_KEY Yes String
Key Description Required Type
payTraceUserName PAYTRACE_USER_NAME Yes String
payTracePassword PAYTRACE_USER_PASSWORD Yes String
Key Description Required Type
paypalApiUserName PAYTRACE_USER_NAME Yes String
paypalApiPassword PAYPAL_USER_PASSWORD Yes String
Key Description Required Type
stripePublishableKey STRIPE_PUBLISHABLE_KEY Yes String
stripeSecretApiKey STRIPE_SECRET_KEY Yes String
Key Description Required Type
UsaePayTransactionKey USAEPAY_TRANSACTION_KEY Yes String
UsaePayPin USAEPAY_PIN Yes String
Key Description Required Type
heartlandPublicKey HEARTLAND_PUBLIC_KEY Yes String
heartlandSecretKey HEARTLAND_SECRET_KEY Yes String
Key Description Required Type
cyberMerchantId CYBERSOURCE_MERCHANT_ID Yes String
cyberAPIKeyID CYBERSOURCE_API_KEY_ID Yes String
cyberSecretKey CYBERSOURCE_SECRET_KEY Yes String
Key Description Required Type
chargezoomUserName CHARGEZOOM_USER_NAME Yes String
chargezoomPassword CHARGEZOOM_USER_PASSWORD Yes String
Key Description Required Type
itransactUserName ITRANSACT_USER_NAME Yes String
itransactApiKey ITRANSACT_API_KEY Yes String
Key Description Required Type
fluidPayApiKey FLUIDPAY_API_KEY Yes String
Key Description Required Type
tsysApiUserId TSYS_API_USER_ID Yes String
tsysApiPassword TSYS_API_PASSWORD Yes String
tsysGatewayMerchantId TSYS_GATEWAY_MERCHANT_ID Yes String
Key Description Required Type
siteVariable SITE_VARIABLE Yes String
cardpointeUsername CP_USER_NAME Yes String
cardpointePassword CP_PASSWORD Yes String
Key Description Required Type
payarcSecretKey PAYARC_SECRET_KEY Yes String
Key Description Required Type
EPXCustNBR EPX_CUST_NBR Yes String
EPXMerchNBR EPX_MERCH_NBR Yes String
EPXDBANBR EPX_DBA_NBR Yes String
EPXterminal EPX_TERMINAL Yes String
Key Description Required Type
maverickAccessToken MAVERICK_ACCESS_TOKEN Yes String
maverickTerminalId MAVERICK_TERMINAL_ID Yes String
Key Description Required Type
cardknoxApiKey CARDKNOX_API_KEY Yes String

URL

                                                    
                                                        https://resellerapi.payportal.com/Resellers/addNewGateway

Request Example

                                                    
                                                        {
                                                            "merchantId": 123,
                                                            "gatewayIdentifier": "NMI_GATEWAY",
                                                            "friendlyName": "my production nmi gateway",
                                                            "setAsDefault": 1,
                                                            "nmiUserName": "demo",
                                                            "nmiPassword": "password"
                                                        }

Response Example

                                                    
                                                        {
                                                          "message": "New gateway added successfully.",
                                                          "data": {
                                                            "gatewayId": 478
                                                          },
                                                          "code": 200
                                                        }

Use this endpoint to update a merchants payment gateway. It is also required to add the gatewayRequiredFields that are provided in the supported merchant gateway response. They are included below the body parameters for each gateway.

Header Parameters
Key Description Required Type
secretKey API secret key Yes String
token Token received using the last token you received from refresh or generate. Yes String
Body Parameters
Key Description Required Type Default Restrictions
merchantId Merchant Id Yes integer - -
gatewayIdentifier Gateway Identifier Yes String - Gateway Identifier ie. NMI_GATEWAY, AUTHORIZE_GATEWAY. Check Merchant Gateways API to see the list of Gateways and their Identifier
friendlyName Gateway friendly name Yes String - -
setAsDefault 0 or 1, 1=>Yes, 0=>No Yes integer - -
gatewayRequiredFields
Key Description Required Type
nmiUserName NMI_USER_NAME Yes String
nmiPassword NMI_USER_PASSWORD Yes String
Key Description Required Type
authorizeApiKey AUTHORIZE_API_KEY Yes String
authorizeTransactionKey AUTHORIZE_TRANSACTION_KEY Yes String
Key Description Required Type
payTraceUserName PAYTRACE_USER_NAME Yes String
payTracePassword PAYTRACE_USER_PASSWORD Yes String
Key Description Required Type
paypalApiUserName PAYTRACE_USER_NAME Yes String
paypalApiPassword PAYPAL_USER_PASSWORD Yes String
Key Description Required Type
stripePublishableKey STRIPE_PUBLISHABLE_KEY Yes String
stripeSecretApiKey STRIPE_SECRET_KEY Yes String
Key Description Required Type
UsaePayTransactionKey USAEPAY_TRANSACTION_KEY Yes String
UsaePayPin USAEPAY_PIN Yes String
Key Description Required Type
heartlandPublicKey HEARTLAND_PUBLIC_KEY Yes String
heartlandSecretKey HEARTLAND_SECRET_KEY Yes String
Key Description Required Type
cyberMerchantId CYBERSOURCE_MERCHANT_ID Yes String
cyberAPIKeyID CYBERSOURCE_API_KEY_ID Yes String
cyberSecretKey CYBERSOURCE_SECRET_KEY Yes String
Key Description Required Type
chargezoomUserName CHARGEZOOM_USER_NAME Yes String
chargezoomPassword CHARGEZOOM_USER_PASSWORD Yes String
Key Description Required Type
itransactUserName ITRANSACT_USER_NAME Yes String
itransactApiKey ITRANSACT_API_KEY Yes String
Key Description Required Type
fluidPayApiKey FLUIDPAY_API_KEY Yes String
Key Description Required Type
tsysApiUserId TSYS_API_USER_ID Yes String
tsysApiPassword TSYS_API_PASSWORD Yes String
tsysGatewayMerchantId TSYS_GATEWAY_MERCHANT_ID Yes String
Key Description Required Type
siteVariable SITE_VARIABLE Yes String
cardpointeUsername CP_USER_NAME Yes String
cardpointePassword CP_PASSWORD Yes String
Key Description Required Type
payarcSecretKey PAYARC_SECRET_KEY Yes String
Key Description Required Type
EPXCustNBR EPX_CUST_NBR Yes String
EPXMerchNBR EPX_MERCH_NBR Yes String
EPXDBANBR EPX_DBA_NBR Yes String
EPXterminal EPX_TERMINAL Yes String
Key Description Required Type
maverickAccessToken MAVERICK_ACCESS_TOKEN Yes String
maverickTerminalId MAVERICK_TERMINAL_ID Yes String
Key Description Required Type
cardknoxApiKey CARDKNOX_API_KEY Yes String

URL

                                                    
                                                        https://resellerapi.payportal.com/Resellers/updateGateway

Request Example

                                                    
                                                        {
                                                            "gatewayId": 456,
                                                            "merchantId": 123,
                                                            "gatewayIdentifier": "NMI_GATEWAY",
                                                            "friendlyName": "my production nmi gateway",
                                                            "setAsDefault": 1,
                                                            "nmiUserName": "demo",
                                                            "nmiPassword": "password"
                                                        }

Response Example

                                                    
                                                        {
                                                          "message": "New gateway added successfully.",
                                                          "data": {
                                                            "gatewayId": 478
                                                          },
                                                          "code": 200
                                                        }

Merchant Controls

Create a merchant under your reseller account.

Header Parameters
Key Description Required Type
secretKey API secret key Yes String
token Token received using the last token you received from refresh or generate. Yes String
Body Parameters
Key Description Required Type Default Restrictions
gatewayOpt gateway option No integer - -
merchantEmail Merchant Email Yes String - -
firstName Merchant first name Yes String - -
lastName Merchant last name Yes String - -
companyName Merchant company name Yes String - -
merchantContact Merchant Contact Yes integer - -
merchantAddress1 Merchant address1 No String - -
merchantAddress2 Merchant address2 No String - -
merchantCity Merchant city No String - -
merchantState Merchant state No String - -
merchantZipCode Merchant zip code No integer - -
merchantCountry Merchant country No string - -
portalUrl Merchant portal URL Yes string - -
tagline Merchant tagline No string - -
merchantPassword Merchant password Yes string - -
plans Merchant plan Yes string - -
merchantMID Merchant MID NO string NULL MAX LENGTH [ 60 ]

URL

                                                    
                                                        https://resellerapi.payportal.com/Resellers/createMerchant

Request Example

                                                    
                                                        {
                                                            "gatewayOpt": "",
                                                            "merchantEmail": "lacytest@cztester.com",
                                                            "firstName": "Lacy",
                                                            "lastName": "Black",
                                                            "companyName": "Lacy Black",
                                                            "merchantContact": "2589631475",
                                                            "merchantAddress1": "CA Test",
                                                            "merchantAddress2": "CA Test",
                                                            "merchantCity": "CAS",
                                                            "merchantState": "CAS",
                                                            "merchantZipCode": "147852",
                                                            "merchantCountry": "USA",
                                                            "portalUrl": "test.com",
                                                            "tagline": "test",
                                                            "merchantPassword": "Test@123",
                                                            "plans": "18",
                                                            "merchantMID": "SAMPLE-MERCHANT-ID-1234"
                                                        }

Response Example

                                                    
                                                        {
                                                          "message": "Merchant created successfully.",
                                                          "data": {
                                                            "merchantId": "268",
                                                            "companyName": "Lacy Black",
                                                            "firstName": "Lacy",
                                                            "lastName": "Black"
                                                          },
                                                          "code": 200
                                                        }

Update a merchant under your reseller account.

Header Parameters
Key Description Required Type
secretKey API secret key Yes String
token Token received using the last token you received from refresh or generate. Yes String
Body Parameters
Key Description Required Type Default Restrictions
gatewayOpt gateway option No integer - -
merchantEmail Merchant Email Yes String - -
firstName Merchant first name Yes String - -
lastName Merchant last name Yes String - -
companyName Merchant company name Yes String - -
merchantContact Merchant Contact No integer - -
merchantAddress1 Merchant address1 No String - -
merchantAddress2 Merchant address2 No String - -
merchantCity Merchant city No String - -
merchantState Merchant state No String - -
merchantZipCode Merchant zip code No integer - -
merchantCountry Merchant country No string - -
portalUrl Merchant portal URL Yes string - -
tagline Merchant tagline No string - -
merchantPassword Merchant password Yes string - -
merchantId Merchant Id Yes integer - -
plans Merchant plan Yes string - -
merchantAlternateContact Merchant Alternate Contact No integer - -

URL

                                                    
                                                        https://resellerapi.payportal.com/Resellers/updateMerchant

Request Example

                                                    
                                                    {
                                                        "merchantEmail": "lacy@cztester.com",
                                                        "firstName": "Lacy",
                                                        "lastName": "Black",
                                                        "companyName": "Lacy Black",
                                                        "merchantContact": "1478523698",
                                                        "merchantAddress1": "CA Test",
                                                        "merchantAddress2": "CA Test",
                                                        "merchantCity": "CAS",
                                                        "merchantState": "CAS",
                                                        "merchantZipcode": "147852",
                                                        "merchantCountry": "USA",
                                                        "portalUrl": "test",
                                                        "tagline": "test",
                                                        "merchantPassword": "Test@123",
                                                        "merchantId": "268",
                                                        "plans": "18",
                                                        "merchantAlternateContact": "258963147
                                                    }

Response Example

                                                    
                                                        {
                                                          "message": "success",
                                                          "data": "Successfully Updated",
                                                          "code": 200
                                                        }

Update a merchant under your reseller account.

Header Parameters
Key Description Required Type
secretKey API secret key Yes String
token Token received using the last token you received from refresh or generate. Yes String

URL

                                                    
                                                        https://resellerapi.payportal.com/Resellers/merchantList

Response Example

                                                    
                                                        {
                                                            "message": "success",
                                                            "data": [
                                                                {
                                                                    "merchantId": "240",
                                                                    "merchantEmail": "raj.mander@cztester.com",
                                                                    "firstName": "Raj",
                                                                    "lastName": "Mander",
                                                                    "companyName": "Mander LLC",
                                                                    "merchantContact": "9493019414",
                                                                    "merchantAddress1": "18500 Von Karman Ave",
                                                                    "merchantAddress2": "Suite 300",
                                                                    "merchantCity": "Irvine",
                                                                    "merchantState": "CA",
                                                                    "merchantZipCode": "92612",
                                                                    "merchantCountry": "US",
                                                                    "agentID": "12345",
                                                                    "plan_id": "75",
                                                                    "weburl": "https://www.rajllc.com",
                                                                    "portalUrl": "https://portal.rajllc.com",
                                                                    "customerHelp": "support@cztester.com",
                                                                    "merchantMID": "SAMPLE-MERCHANT-ID-1234"
                                                                }
                                                            ],
                                                            "code": 200
                                                        }

Enable a merchant under your reseller account.

Header Parameters
Key Description Required Type
secretKey API secret key Yes String
token Token received using the last token you received from refresh or generate. Yes String
Body Parameters
Key Description Required Type Default Restrictions
merchantId Merchant Id Yes integer - -

URL

                                                    
                                                        https://resellerapi.payportal.com/Resellers/enableMerchant

Request Example

                                                    
                                                    {
                                                        "merchantId": 123
                                                    }

Response Example

                                                    
                                                        {
                                                          "message": "Merchant Successfully Activated",
                                                          "data": "",
                                                          "code": 200
                                                        }

Suspend or Resume a merchant under your reseller account.

Header Parameters
Key Description Required Type
secretKey API secret key Yes String
token Token received using the last token you received from refresh or generate. Yes String
Body Parameters
Key Description Required Type Default Restrictions
merchantId Merchant Id Yes integer - -

URL

                                                    
                                                        https://resellerapi.payportal.com/Resellers/suspendMerchant

Request Example

                                                    
                                                    { 
                                                        "merchantId": 123
                                                    }

Response Example

                                                    
                                                        {
                                                          "message": "success",
                                                          "data": "Your account suspended",
                                                          "code": 200
                                                        }

Disable a merchant under your reseller account.

Header Parameters
Key Description Required Type
secretKey API secret key Yes String
token Token received using the last token you received from refresh or generate. Yes String
Body Parameters
Key Description Required Type Default Restrictions
merchantId Merchant Id Yes integer - -

URL

                                                    
                                                        https://resellerapi.payportal.com/Resellers/disableMerchant

Request Example

                                                    
                                                    { 
                                                        "merchantId": 123
                                                    }

Response Example

                                                    
                                                        {
                                                          "message": "Merchant Successfully Disabled",
                                                          "data": "",
                                                          "code": 200
                                                        }

Retrieve merchant plans attached to their account.

Header Parameters
Key Description Required Type
secretKey API secret key Yes String
token Token received using the last token you received from refresh or generate. Yes String

URL

                                                    
                                                        https://resellerapi.payportal.com/Resellers/getPlans

Response Example

                                                    
                                                        {
                                                          "plans": [
                                                            {
                                                              "plan_id": "18",
                                                              "plan_name": "ES_INT_MA"
                                                            }
                                                          ],
                                                          "message": "Success",
                                                          "code": 200
                                                        }

For Merchant Onboarding you can identify what accounting package they are assigned. It is also required to add the gatewayRequiredFields that are provided in the supported merchant gateway response. They are included below the body parameters for each gateway.

Header Parameters
Key Description Required Type
secretKey API secret key Yes String
token Token received using the last token you received from refresh or generate. Yes String
Body Parameters
Key Description Required Type Default Restrictions
merchantId Merchant Id Yes integer - -
accountingPackage Non Accountinng Package Only Yes string - QUICKBOOK_ONLINE, QUICKBOOK_DEKTOP, FRESHBOOKS, XERO, NO_ACCOUNTING_PKG
gatewayIdentifier Gateway Identifier Yes string - Gateway Identifier ie. NMI_GATEWAY, AUTHORIZE_GATEWAY. Check Merchant Gateways API to see the list of Gateways and their Identifier
friendlyName Gateway friendly name Yes string - -
merchantMID Merchant MID NO string NULL MAX LENGTH [ 60 ]
gatewayRequiredFields
Key Description Required Type
nmiUserName NMI_USER_NAME Yes String
nmiPassword NMI_USER_PASSWORD Yes String
Key Description Required Type
authorizeApiKey AUTHORIZE_API_KEY Yes String
authorizeTransactionKey AUTHORIZE_TRANSACTION_KEY Yes String
Key Description Required Type
payTraceUserName PAYTRACE_USER_NAME Yes String
payTracePassword PAYTRACE_USER_PASSWORD Yes String
Key Description Required Type
paypalApiUserName PAYTRACE_USER_NAME Yes String
paypalApiPassword PAYPAL_USER_PASSWORD Yes String
Key Description Required Type
stripePublishableKey STRIPE_PUBLISHABLE_KEY Yes String
stripeSecretApiKey STRIPE_SECRET_KEY Yes String
Key Description Required Type
UsaePayTransactionKey USAEPAY_TRANSACTION_KEY Yes String
UsaePayPin USAEPAY_PIN Yes String
Key Description Required Type
heartlandPublicKey HEARTLAND_PUBLIC_KEY Yes String
heartlandSecretKey HEARTLAND_SECRET_KEY Yes String
Key Description Required Type
cyberMerchantId CYBERSOURCE_MERCHANT_ID Yes String
cyberAPIKeyID CYBERSOURCE_API_KEY_ID Yes String
cyberSecretKey CYBERSOURCE_SECRET_KEY Yes String
Key Description Required Type
chargezoomUserName CHARGEZOOM_USER_NAME Yes String
chargezoomPassword CHARGEZOOM_USER_PASSWORD Yes String
Key Description Required Type
itransactUserName ITRANSACT_USER_NAME Yes String
itransactApiKey ITRANSACT_API_KEY Yes String
Key Description Required Type
fluidPayApiKey FLUIDPAY_API_KEY Yes String
Key Description Required Type
tsysApiUserId TSYS_API_USER_ID Yes String
tsysApiPassword TSYS_API_PASSWORD Yes String
tsysGatewayMerchantId TSYS_GATEWAY_MERCHANT_ID Yes String
Key Description Required Type
siteVariable SITE_VARIABLE Yes String
cardpointeUsername CP_USER_NAME Yes String
cardpointePassword CP_PASSWORD Yes String
Key Description Required Type
payarcSecretKey PAYARC_SECRET_KEY Yes String
Key Description Required Type
EPXCustNBR EPX_CUST_NBR Yes String
EPXMerchNBR EPX_MERCH_NBR Yes String
EPXDBANBR EPX_DBA_NBR Yes String
EPXterminal EPX_TERMINAL Yes String
Key Description Required Type
maverickAccessToken MAVERICK_ACCESS_TOKEN Yes String
maverickTerminalId MAVERICK_TERMINAL_ID Yes String
Key Description Required Type
cardknoxApiKey CARDKNOX_API_KEY Yes String

URL

                                                    
                                                        https://resellerapi.payportal.com/Resellers/merchantOnBoarding

Request Example

                                                    
                                                    {
                                                        "merchantId": 123,
                                                        "accountingPackage": "NO_ACCOUNTING_PKG",
                                                        "gatewayIdentifier": "NMI_GATEWAY",
                                                        "friendlyName": "test name",
                                                        "nmiUserName": "demo",
                                                        "nmiPassword": "password",
                                                        "merchantMID": "SAMPLE-MERCHANT-ID",
                                                    }

Response Example

                                                    
                                                        {
                                                          "message": "Merchant Onboarding success",
                                                          "data": "",
                                                          "code": 200
                                                        }

You can reset the merchant password with their original password.

Header Parameters
Key Description Required Type
secretKey API secret key Yes String
token Token received using the last token you received from refresh or generate. Yes String
Body Parameters
Key Description Required Type Default Restrictions
merchantId Merchant Id Yes integer - -
currentPassword Merchant Old Password Yes string - -
newPassword Merchant New Password Yes string - -

URL

                                                    
                                                        https://resellerapi.payportal.com/Resellers/resetPassword

Request Example

                                                    
                                                    { 
                                                        "merchantId": 123,
                                                        "currentPassword": "test123@",
                                                        "newPassword": "test421@"
                                                    }

Response Example

                                                    
                                                        {
                                                          "message": "SUCCESS",
                                                          "data": "Password has been changed successfully",
                                                          "code": 200
                                                        }

To access Merchant API controls it requires you to create a Merchant API Secret Key. A merchant can create a secret key if their account plan supports API usage. Depending on your reseller account your merchants may or may not have direct API access.

Header Parameters
Key Description Required Type
secretKey API secret key Yes String
token Token received using the last token you received from refresh or generate. Yes String
Body Parameters
Key Description Required Type Default Restrictions
merchantId Merchant Id Yes integer - -

URL

                                                    
                                                        https://resellerapi.payportal.com/Resellers/createMerchantSecretKey

Request Example

                                                    
                                                    { 
                                                        "merchantId": 123
                                                    }

Response Example

                                                    
                                                        {
                                                          "message": "SUCCESS",
                                                          "data": "8662072ba227......",
                                                          "code": 200
                                                        }

Connect Accounting Button

Add a connect accounting button/link to your website. This allows your merchants to connect their accounting software to Chargezoom. Chargezoom offers a two-way sync between data on Chargezoom and data on their accounting package. This allows you to retrieve their accounting software data from Chargezoom and push data back to their accounting software through Chargezoom. This includes open invoices, customers, and more.

Reseller Steps to Integration:
  1. Create a Merchant and save the Merchant ID
  2. Create a Merchant API Key using the Merchant ID and save the Merchant API Key
  3. Create The Link on your website passing the Merchant ID and Merchant API Key to it.
  4. Integrate to Chargezoom using the Merchant API.

The Link

                                            
                                                https://resellerapi.payportal.com/Connect?key={MERCHANT API KEY}&merchantID={MERCHANT ID}

There are two ways to integrate The Link:

  • Create a link that opens a new tab to the URL
  • Create a pop-up to the URL
Using the example below we will define the Merchant ID as ABC123 and the Merchant API Key as XYZ321

Pop-Up Example

                                                    
                                                        <button onClick="connectAccounting('ABC123', 'XYZ321');">Sync Accounting Package</button>
<script>
	function connectAccounting(mid, mapik) {
		window.open('http://resellerapi.payportal.com/Connect?key='+mapik+'&merchantID='+mid,'winname',"directories=0,titlebar=0,toolbar=0,location=0,status=0,menubar=0,scrollbars=no,resizable=no,width=900,height=500");
	}
</script>

New Tab Example

                                                    
                                                        <a href="https://resellerapi.payportal.com/Connect?key=XYZ321&merchantID=ABC123" target="_blank">Sync Accounting Package</a>
Merchant Integration Demo

Syncing Account Data

Chargezoom initiates a sync between accounting softwares every 30 minutes. Dataset and sync times vary between merchants. We recommend setting up a cron job to run as fast as every 30 minutes to retrieve new data through our Merchant API if you wish to save this data on your own application. To update data on their accounting software you must push the changes to Chargezoom which will sync with their accounting software.

To check if your merchant has connected to their accounting package you can use the Merchant List API to generate a list of your merchants. The field "is_integrate": 1 represents that the merchant has integrated their accounting package.

Below is the data we retrieve by Accounting Software:

  • Quickbooks Online
    • Retrieve tax related data.
    • Retreieve account related data.
    • Retrieve customer related data.
    • Retrieve items related data.
    • Retrieve credit related data.
    • Retrieve open invoice related data.
    • Retrieve payment related data.