Help
RSS
API
Feed
Maltego
Contact
Domain > developer.payportal.com
×
More information on this domain is in
AlienVault OTX
Is this malicious?
Yes
No
DNS Resolutions
Date
IP Address
2020-06-11
52.86.64.213
(
ClassC
)
2025-10-26
34.54.29.67
(
ClassC
)
Port 443
HTTP/1.1 200 OKdate: Sun, 26 Oct 2025 05:03:36 GMTserver: istio-envoyvary: Accept-Encodingcontent-type: text/html; charsetUTF-8x-envoy-upstream-service-time: 40Via: 1.1 googleAlt-Svc: h3:443; ma2592000,h3-29:443; ma2592000Transfer-Encoding: chunked !doctype html>html langen>head> !-- Required meta tags --> meta charsetutf-8> meta nameviewport contentwidthdevice-width, initial-scale1, shrink-to-fityes> link relshortcut icon href/resources/img/fav-icon-new.png typeimage/x-icon> !-- Bootstrap CSS --> link relstylesheet href/resources/assets/bootstrap/css/bootstrap.min.css> link relstylesheet href/resources/assets/bootstrap/css/bootstrap-select.min.css> !-- icon css--> link relstylesheet href/resources/assets/elagent-icon/style.css> link relstylesheet href/resources/assets/prism/prism.css> link relstylesheet href/resources/assets/prism/prism-coy.css> link relstylesheet href/resources/css/style-main.css> link relstylesheet href/resources/css/responsive.css> title>Chargezoom Merchant API Documentation/title> style> .post-type { color: #ff8700; } .get-type { color: #009b04; } .language-json { max-height: 500px; } table { font-size: .95em !important; } thead { background: #4da1ff !important; } td { font-size: .95em !important; } tr { font-size: .95em !important; } th { font-size: .95em !important; } .test.remove .doc_left_sidebarlis { padding-top: 0px !important; } .fixed { position: fixed; width: 250px; } .right-divider-border { border-right: 1px solid #f0f2f5; } .c_head { color: black !important; } h5 { color: black !important; } h2 { color: black !important; } .toggle_btn { color: black !important; } .navbar-nav .nav-link { font-size: 1em !important; } .navbar-nav .nav-item { font-size: 1em !important; } .nav_title { background: none !important; } preclass*language- > code { border-left: 5px solid #4da1ff !important; } .ordered-list li::before { background: #4da1ff !important; } /style>/head>body classdoc full-width-doc sticky-nav-doc onepage-doc data-spyscroll data-target.navbar data-offset-120>style> li.nav-item:last-child { padding-bottom: 12px; } .doc-sidebar aside::-webkit-scrollbar { display: none; } .toggle_btn:before { right: 10px; }/style> div classbody_wrapper sticky_menu> section classdoc_documentation_area onepage_doc_area idsticky_doc> div classoverlay_bg>/div> div classcontainer-fluid pl-60 pr-60> div classrow doc-container mt-0 pt-0 > div classcol-lg-2 pt-4 doc_mobile_menu doc-sidebar display_none right-divider-border> aside styleposition: fixed; width: 14%; overflow: auto; height: -webkit-fill-available;> h3 classnav_title>a classnavbar-brand header_logo logo-width-100 href#> img classfirst_logo sticky_logo main_logo img-fluid srcresources/img/cz-new-logo.svg altlogo> img classwhite_logo img-fluid srcresources/img/cz-new-logo.svg altlogo> /a>/h3> div classscroll> ul classlist-unstyled nav-sidebar doc-nav> li classnav-item active> a href#doc classnav-link>Getting Started/a> /li> li classnav-item> a href#Authentication classnav-link>Authentication/a> span classicon> i classicon_plus>/i> i classicon_minus-06>/i> /span> ul classlist-unstyled dropdown_nav> li classnav-item>a href#generate-token classnav-link>Generate Token/a>/li> li classnav-item>a href#refresh-token classnav-link>Refresh Token/a>/li> li classnav-item>a href#get-api-profile classnav-link>Get API Profile/a>/li> /ul> /li> li classnav-item> a href#PaymentGateways classnav-link>Payment Gateways/a> span classicon> i classicon_plus>/i> i classicon_minus-06>/i> /span> ul classlist-unstyled dropdown_nav> li classnav-item>a href#gateway-types classnav-link>Get Gateway Types/a>/li> li classnav-item>a href#merchant-gateway-data classnav-link>Get Merchant Gateway Data/a>/li> li classnav-item>a href#single-gateway-data classnav-link>Get Single Gateway Data/a>/li> li classnav-item>a href#add-merchant-gateway classnav-link>Add Merchant Gateway/a>/li> li classnav-item>a href#edit-merchant-gateway classnav-link>Edit Merchant Gateway/a>/li> /ul> /li> li classnav-item> a href#General classnav-link>General Settings/a> span classicon> i classicon_plus>/i> i classicon_minus-06>/i> /span> ul classlist-unstyled dropdown_nav> li classnav-item>a href#create-payment-term classnav-link>Create Payment Term/a>/li> li classnav-item>a href#edit-payment-term classnav-link>Edit Payment Term/a>/li> li classnav-item>a href#get-payment-term classnav-link>Get Payment Term/a>/li> li classnav-item>a href#get-invoice-prefix classnav-link>Get Invoice Prefix/a>/li> li classnav-item>a href#set-invoice-prefix-number classnav-link>Set Invoice Prefix Number/a>/li> li classnav-item>a href#get-customer-portal classnav-link>Get Customer Portal/a>/li> li classnav-item>a href#customer-portal-setup classnav-link>Customer Portal Setup/a>/li> li classnav-item>a href#tax-list classnav-link>Tax List/a>/li> /ul> /li> li classnav-item> a href#Customers classnav-link>Customers/a> span classicon> i classicon_plus>/i> i classicon_minus-06>/i> /span> ul classlist-unstyled dropdown_nav> li classnav-item>a href#create-customer classnav-link>Create Customer/a>/li> li classnav-item>a href#edit-customer classnav-link>Edit Customer/a>/li> li classnav-item>a href#get-customer-data classnav-link>Get Customer Data/a>/li> li classnav-item>a href#get-customer-data-legacy classnav-link>Get Customer Data (Legacy)/a>/li> li classnav-item>a href#get-single-customer-data classnav-link>Get Single Customer Data/a>/li> li classnav-item>a href#activate-deactivate-customer classnav-link>Activate/Deactivate/a>/li> li classnav-item>a href#create-payment-method classnav-link>Create Payment Method/a>/li> li classnav-item>a href#edit-payment-method classnav-link>Edit Payment Method/a>/li> li classnav-item>a href#get-payment-methods classnav-link>Get Payment Methods/a>/li> li classnav-item>a href#get-single-payment-method classnav-link>Get Single Payment Method/a>/li> li classnav-item>a href#delete-payment-method classnav-link>Delete Payment Method/a>/li> li classnav-item>a href#create-customer-note classnav-link>Create Customer Note/a>/li> li classnav-item>a href#get-customer-notes classnav-link>Get Customer Notes/a>/li> li classnav-item>a href#delete-customer-note classnav-link>Delete Customer Note/a>/li> li classnav-item>a href#request-custom-portal classnav-link>Request Custom Portal/a>/li> /ul> /li> li classnav-item> a href#Invoices classnav-link>Invoices/a> span classicon> i classicon_plus>/i> i classicon_minus-06>/i> /span> ul classlist-unstyled dropdown_nav> li classnav-item>a href#pay-invoice classnav-link>Pay Invoice/a>/li> li classnav-item>a href#pay-invoice-offline-legacy classnav-link>Pay Invoice (Offline)/a>/li> li classnav-item>a href#pay-invoice-offline classnav-link>Pay Invoice (Offline)(Legacy)/a>/li> li classnav-item>a href#batch-pay-offline classnav-link>Pay Invoice (Offline Batch)/a>/li> li classnav-item>a href#invoice-detail classnav-link>Invoice Detail/a>/li> li classnav-item>a href#void-invoice classnav-link>Void Invoice/a>/li> li classnav-item>a href#list-all-invoices classnav-link>List All Invoices/a>/li> li classnav-item>a href#list-all-invoices-legacy classnav-link>List All Invoices (Legacy)/a>/li> li classnav-item>a href#create-invoice classnav-link>Create Invoice/a>/li> li classnav-item>a href#legacy-create-invoice classnav-link>Create Invoice (Legacy)/a>/li> li classnav-item>a href#edit-invoice classnav-link>Edit Invoice/a>/li> li classnav-item>a href#update-invoice classnav-link>Update Invoice/a>/li> li classnav-item>a href#legacy-update-invoice classnav-link> Update Invoice (Legacy)/a>/li> li classnav-item>a href#resend-invoice-email classnav-link> Resend Invoice Email (Batch)/a>/li> /ul> /li> li classnav-item> a href#Subscriptions classnav-link>Subscriptions/a> span classicon> i classicon_plus>/i> i classicon_minus-06>/i> /span> ul classlist-unstyled dropdown_nav> li classnav-item>a href#create-subscription-template classnav-link>Create Subscription Template/a>/li> li classnav-item>a href#get-subscription-template classnav-link>Get All Subscription Templates/a>/li> li classnav-item>a href#create-subscription classnav-link>Create Subscription/a>/li> li classnav-item>a href#get-subscriptions classnav-link>Get All Subscriptions/a>/li> li classnav-item>a href#delete-subscription classnav-link>Delete Subscription/a>/li> li classnav-item>a href#get-dunning classnav-link>Get Dunning Management/a>/li> li classnav-item>a href#create-dunning classnav-link>Create/Edit Dunning Management/a>/li> /ul> /li> li classnav-item> a href#Payments classnav-link>Payments/a> span classicon> i classicon_plus>/i> i classicon_minus-06>/i> /span> ul classlist-unstyled dropdown_nav> li classnav-item>a href#create-sale-transaction classnav-link>Create Sale Transaction/a>/li> li classnav-item>a href#create-authorize-payment classnav-link>Create Authorize Payment/a>/li> li classnav-item>a href#create-auth-capture-transaction classnav-link>Create Auth Capture Transaction/a>/li> li classnav-item>a href#create-refund-transaction classnav-link>Create Refund Transaction/a>/li> li classnav-item>a href#create-void-transaction classnav-link>Create Void Transaction/a>/li> li classnav-item>a href#get-transactions classnav-link>Get Transactions/a>/li> li classnav-item>a href#get-transactions-legacy classnav-link>Get Transactions (Legacy)/a>/li> li classnav-item>a href#payment-unlink-transaction classnav-link>Unlink Invoice Transaction/a>/li> /ul> /li> li classnav-item> a href#ProductsServices classnav-link>Products & Services/a> span classicon> i classicon_plus>/i> i classicon_minus-06>/i> /span> ul classlist-unstyled dropdown_nav> li classnav-item>a href#create-item classnav-link>Create Item/a>/li> li classnav-item>a href#get-item-details classnav-link>Get Item Details/a>/li> li classnav-item>a href#get-all-items classnav-link>Get All Items/a>/li> li classnav-item>a href#get-all-items-legacy classnav-link>Get All Items (Legacy)/a>/li> li classnav-item>a href#update-item-status classnav-link>Update Item Status/a>/li> li classnav-item>a href#update-item classnav-link>Update Item/a>/li> /ul> /li> /ul> /div> /aside> /div> div classcol-lg-10 col-md-10> nav classnavbar navbar-expand-lg menu_one dark_menu sticky-nav> div classcontainer-fluid pl-3 pr-60> button classnavbar-toggler collapsed typebutton data-togglecollapse data-target#navbarSupportedContent aria-controlsnavbarSupportedContent aria-expandedfalse aria-labelToggle navigation> span classmenu_toggle> span classhamburger> span>/span> span>/span> span>/span> /span> span classhamburger-cross> span>/span> span>/span> /span> /span> /button> div classcollapse navbar-collapse idnavbarSupportedContent stylepadding-top:8px; padding-left: 30px;> ul classnavbar-nav menu> li classnav-item dropdown submenu active> a href/ classnav-link dropdown-toggle>Merchant API Documentation/a> /li> li classnav-item dropdown submenu > a href/reseller classnav-link dropdown-toggle>Reseller API Documentation/a> /li> /ul> /div> /div>/nav> div classdocumentation_info pt-3> article iddoc> div classshortcode_title> h2>Getting Started/h2> p classpt-3>span>Welcome to Chargezoom Merchant API!/span>/p> /div> h5>Authentication and Usage Overview/h5> p>Chargezoom provides a API secret key to each Merchant Account and it can be used to create the access token which will be required in all request(s) as a token key./p> h5>Steps to Create Secret Key:/h5> ol classordered-list> li>Login to Chargezoom Merchant Dashboard./li> li>Click on the Configuration > API link in the left navigation bar./li> li>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./li> li>Use API Key Production secret as API secretKey in all the API(s)./li> /ol> div classborder_bottom mt-5>/div> /article> article classdocumentation_body doc-section idAuthentication> div classshortcode_title> h2>Authentication/h2> p classpb-4>Using our Authentication API endpoint allows you to create your token for login, refresh your token, and gain access to your API controls./p> /div> div classborder_bottom>/div> div classtour_item idgenerate-token> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Generate Token/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Generate access token./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/authentication/token/create /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "code": 200, "token": "eyJ0eXAiOi.....", "message": "Token generated successfully." } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idrefresh-token> h4 classc_head load-order-2 idhead>span classget-type>GET/span> Refresh Token/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Refresh existing access token. (Note: must be done within two hours of existing tokens creation.)/p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/authentication/token/refresh /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "code": 200, "token": "eyJ0eXAiOi.....", "message": "Token regenerated successfully." } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idget-api-profile> h4 classc_head load-order-2 idhead>span classget-type>GET/span> Get API Profile/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieve Merchant/User Login profile information./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/authentication/profile /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "code": 200, "data": { "merchID": "2", "firstName": "NAP", "lastName": "Local", "merchantEmail": "nap@cztester.com", "companyName": "NAP Local", "resellerID": "1", "agentID": "0" }, "message": "Merchant profile data" } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> /article> article classdocumentation_body doc-section idPaymentGateways> div classshortcode_title> h2>Payment Gateways/h2> p classpb-4>Control your merchant payment gateways. Retrieve gateways, add, or edit your merchant gateway./p> /div> div classborder_bottom>/div> div classtour_item idgateway-types> h4 classc_head load-order-2 idhead>span classget-type>GET/span> Get Gateway Types/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieves all supported Payment Gateways./h5> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/gateway/type/list /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Gateway list", "data": { "gatewayTypeID": "1", "gatewayName": "NMI", "gatewayUniqueId": "NMI_GATEWAY", "gatewayRequiredFields": "nmiUserName", "nmiPassword" , "supportedPaymentMethods": "Credit Card", "ACH" }, { "gatewayTypeID": "2", "gatewayName": "Authorize.net", "gatewayUniqueId": "AUTHORIZE_GATEWAY", "gatewayRequiredFields": "authorizeApiKey", "authorizeTransactionKey" , "supportedPaymentMethods": "Credit Card", "ACH" }, { "gatewayTypeID": "3", "gatewayName": "PayTrace", "gatewayUniqueId": "PAYTRACE_GATEWAY", "gatewayRequiredFields": "payTraceUserName", "payTracePassword" , "supportedPaymentMethods": "Credit Card", "ACH" }, { "gatewayTypeID": "4", "gatewayName": "PayPal", "gatewayUniqueId": "PAYPAL_GATEWAY", "gatewayRequiredFields": "paypalApiUserName", "paypalApiPassword" , "supportedPaymentMethods": "Credit Card" }, { "gatewayTypeID": "5", "gatewayName": "Stripe", "gatewayUniqueId": "STRIPE_GATEWAY", "gatewayRequiredFields": "stripePublishableKey", "stripeSecretApiKey" , "supportedPaymentMethods": "Credit Card" }, { "gatewayTypeID": "6", "gatewayName": "USAePay", "gatewayUniqueId": "USAEPAY_GATEWAY", "gatewayRequiredFields": "UsaePayTransactionKey", "UsaePayPin" , "supportedPaymentMethods": "Credit Card" }, { "gatewayTypeID": "7", "gatewayName": "Heartland", "gatewayUniqueId": "HEARTLAND_GATEWAY", "gatewayRequiredFields": "heartlandPublicKey", "heartlandSecretKey" , "supportedPaymentMethods": "Credit Card" }, { "gatewayTypeID": "8", "gatewayName": "CyberSource", "gatewayUniqueId": "CYBERSOURCE_GATEWAY", "gatewayRequiredFields": "cyberMerchantId", "cyberAPIKeyID", "cyberSecretKey" , "supportedPaymentMethods": "Credit Card" }, { "gatewayTypeID": "9", "gatewayName": "Chargezoom", "gatewayUniqueId": "CHARGEZOOM_GATEWAY", "gatewayRequiredFields": "chargezoomUserName", "chargezoomPassword" , "supportedPaymentMethods": "Credit Card" }, { "gatewayTypeID": "10", "gatewayName": "iTransact", "gatewayUniqueId": "ITRANSACT_GATEWAY", "gatewayRequiredFields": "itransactUserName", "itransactApiKey" , "supportedPaymentMethods": "Credit Card" }, { "gatewayTypeID": "11", "gatewayName": "FluidPay", "gatewayUniqueId": "FLUIDPAY_GATEWAY", "gatewayRequiredFields": "fluidPayApiKey" , "supportedPaymentMethods": "Credit Card" }, { "gatewayTypeID": "12", "gatewayName": "TSYS", "gatewayUniqueId": "TSYS_GATEWAY", "gatewayRequiredFields": "tsysApiUserId", "tsysApiPassword", "tsysGatewayMerchantId" , "supportedPaymentMethods": "Credit Card" }, { "gatewayTypeID": "13", "gatewayName": "BASYS iQ Pro", "gatewayUniqueId": "BASYS_GATEWAY", "gatewayRequiredFields": "basysApiKey" , "supportedPaymentMethods": "Credit Card" }, { "gatewayTypeID": "14", "gatewayName": "CardPointe", "gatewayUniqueId": "CARDPOINTE_GATEWAY", "gatewayRequiredFields": "basysApiKey" , "supportedPaymentMethods": "Credit Card" }, { "gatewayTypeID": "15", "gatewayName": "PayArc Payment", "gatewayUniqueId": "PAYARC_GATEWAY", "gatewayRequiredFields": "payarcSecretKey" , "supportedPaymentMethods": "Credit Card" }, { "gatewayTypeID": "16", "gatewayName": "EPX", "gatewayUniqueId": "EPX_GATEWAY", "gatewayRequiredFields": "payarcSecretKey" , "supportedPaymentMethods": "Credit Card" }, { "gatewayTypeID": "18", "gatewayName": "Intuit", "gatewayUniqueId": "INTUIT_GATEWAY", "gatewayRequiredFields": "intuitClientId", "intuitClientSecret" , "supportedPaymentMethods": "Credit Card" }, { "gatewayTypeID": "19", "gatewayName": "Tilled", "gatewayUniqueId": "TILLED_GATEWAY", "gatewayRequiredFields": "intuitClientId", "intuitClientSecret" , "supportedPaymentMethods": "Credit Card" }, { "gatewayTypeID": "20", "gatewayName": "Square Payment", "gatewayUniqueId": "SQUARE_GATEWAY", "gatewayRequiredFields": "intuitClientId", "intuitClientSecret" , "supportedPaymentMethods": "Credit Card" }, { "gatewayTypeID": "25", "gatewayName": "Cardknox", "gatewayUniqueId": "CARDKNOX_GATEWAY", "gatewayRequiredFields": "cardknoxApiKey" , "supportedPaymentMethods": "Credit Card" "ACH" } , "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idmerchant-gateway-data> h4 classc_head load-order-2 idhead>span classget-type>GET/span> Get All Merchant Gateway Data/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieves a list of Payment Gateways added./h5> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/gateway/all /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Gateway list", "data": { "gatewayID": "155", "gatewayFriendlyName": "NMI", "gatewayUsername": "demo", "gatewayPassword": "password", "gatewaySignature": "", "extra_field_1": "", "gatewayType": "1", "gatewayMerchantID": "NMI-101", "defaultGateway": "0", "isCC": "1", "isACH": "1" } , "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idsingle-gateway-data> h4 classc_head load-order-2 idhead>span classget-type>GET/span> Get Single Gateway Data/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieves Merchant Gateway details by the Merchant Gateway ID/p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/gateway/{gatewayID} /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Gateway list", "data": { "gatewayID": "155", "gatewayFriendlyName": "NMI", "gatewayUsername": "demo", "gatewayPassword": "password", "gatewaySignature": "", "extra_field_1": "", "gatewayType": "1", "gatewayMerchantID": "NMI-101", "defaultGateway": "0", "isCC": "1", "isACH": "1" }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idadd-merchant-gateway> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Add Merchant Gateway/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Add a new gateway. Each gateway accepts different request parameters. Request Parameters can be found below. You can retrieve the gatewayIdentifier by running the a href#gateway-types>Get Gateway Types/a> endpoint and using the gatewayUniqueId. /p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> br> h5>Body Parameters/h5> div classtoggle_shortcode> a classtoggle_btn collapsed data-togglecollapse href#collapse1 rolebutton aria-expandedfalse aria-controlscollapse1>NMI Gateway/a> div classcollapse multi-collapse idcollapse1> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>nmiUserName/td> td>NMI_USER_NAME/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>nmiPassword/td> td>NMI_USER_PASSWORD/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse2 rolebutton aria-expandedfalse aria-controlscollapse2>Authorize Gateway/a> div classcollapse multi-collapse idcollapse2> div classcard card-body toggle_body p-0> table classm-0 table table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>authorizeApiKey/td> td>AUTHORIZE_API_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>authorizeTransactionKey/td> td>AUTHORIZE_TRANSACTION_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse3 rolebutton aria-expandedfalse aria-controlscollapse3>Paytrace Gateway/a> div classcollapse multi-collapse idcollapse3> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>payTraceUserName/td> td>PAYTRACE_USER_NAME/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>payTracePassword/td> td>PAYTRACE_USER_PASSWORD/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse4 rolebutton aria-expandedfalse aria-controlscollapse4>Paypal Gateway/a> div classcollapse multi-collapse idcollapse4> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>paypalApiUserName/td> td>PAYTRACE_USER_NAME/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>paypalApiPassword/td> td>PAYPAL_USER_PASSWORD/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse5 rolebutton aria-expandedfalse aria-controlscollapse5>Stripe Gateway/a> div classcollapse multi-collapse idcollapse5> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>stripePublishableKey/td> td>STRIPE_PUBLISHABLE_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>stripeSecretApiKey/td> td>STRIPE_SECRET_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse6 rolebutton aria-expandedfalse aria-controlscollapse6>USAePay Gateway/a> div classcollapse multi-collapse idcollapse6> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>UsaePayTransactionKey/td> td>USAEPAY_TRANSACTION_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>UsaePayPin/td> td>USAEPAY_PIN/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse7 rolebutton aria-expandedfalse aria-controlscollapse7>Heartland Gateway/a> div classcollapse multi-collapse idcollapse7> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>heartlandPublicKey/td> td>HEARTLAND_PUBLIC_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>heartlandSecretKey/td> td>HEARTLAND_SECRET_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse8 rolebutton aria-expandedfalse aria-controlscollapse8>CyberSource Gateway/a> div classcollapse multi-collapse idcollapse8> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>cyberMerchantId/td> td>CYBERSOURCE_MERCHANT_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>cyberAPIKeyID/td> td>CYBERSOURCE_API_KEY_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>cyberSecretKey/td> td>CYBERSOURCE_SECRET_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse9 rolebutton aria-expandedfalse aria-controlscollapse9>Chargezoom Gateway/a> div classcollapse multi-collapse idcollapse9> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>chargezoomUserName/td> td>CHARGEZOOM_USER_NAME/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>chargezoomPassword/td> td>CHARGEZOOM_USER_PASSWORD/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse10 rolebutton aria-expandedfalse aria-controlscollapse10>iTRANSACT Gateway/a> div classcollapse multi-collapse idcollapse10> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>itransactUserName/td> td>ITRANSACT_USER_NAME/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itransactApiKey/td> td>ITRANSACT_API_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse11 rolebutton aria-expandedfalse aria-controlscollapse11>FluidPay Gateway/a> div classcollapse multi-collapse idcollapse11> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>fluidPayApiKey/td> td>FLUIDPAY_API_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse12 rolebutton aria-expandedfalse aria-controlscollapse12>TSYS Gateway/a> div classcollapse multi-collapse idcollapse12> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>tsysApiUserId/td> td>TSYS_API_USER_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>tsysApiPassword/td> td>TSYS_API_PASSWORD/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>tsysGatewayMerchantId/td> td>TSYS_GATEWAY_MERCHANT_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse13 rolebutton aria-expandedfalse aria-controlscollapse13>CardPointe Gateway/a> div classcollapse multi-collapse idcollapse13> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>siteVariable/td> td>SITE_VARIABLE/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>cardpointeUsername/td> td>CP_USER_NAME/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>cardpointePassword/td> td>CP_PASSWORD/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse14 rolebutton aria-expandedfalse aria-controlscollapse14>PayArc Gateway/a> div classcollapse multi-collapse idcollapse14> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>payarcSecretKey/td> td>PAYARC_SECRET_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse15 rolebutton aria-expandedfalse aria-controlscollapse15>EPX Gateway/a> div classcollapse multi-collapse idcollapse15> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>EPXCustNBR/td> td>EPX_CUST_NBR/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>EPXMerchNBR/td> td>EPX_MERCH_NBR/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>EPXDBANBR/td> td>EPX_DBA_NBR/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>EPXterminal/td> td>EPX_TERMINAL/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse16 rolebutton aria-expandedfalse aria-controlscollapse16>Maverick Gateway/a> div classcollapse multi-collapse idcollapse16> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>maverickAccessToken/td> td>MAVERICK_ACCESS_TOKEN/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>maverickTerminalId/td> td>MAVERICK_TERMINAL_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>maverickDba/td> td>Maverick DBA ID (only required if you use ACH)/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse17 rolebutton aria-expandedfalse aria-controlscollapse17>Cardknox Gateway/a> div classcollapse multi-collapse idcollapse17> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>cardknoxApiKey/td> td>CARDKNOX_API_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> /div> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/gateway/create /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "gatewayIdentifier": "NMI_GATEWAY", "friendlyName": "NMI test", "nmiUserName": "chucknorris", "nmiPassword": "kittykat123", "setAsDefault": "N", "isCC": "Y", "isACH": "Y" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Gateway added successfully", "data": { "gatewayId": { "gatewayID": "2468", "gatewayFriendlyName": "NMI test", "gatewayUsername": "chucknorris", "gatewayPassword": "kittykat123", "gatewaySignature": "", "extra_field_1": "", "gatewayType": "1", "gatewayMerchantID": "", "defaultGateway": "0", "isCC": "1", "isACH": "1" } }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idedit-merchant-gateway> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Edit Merchant Gateway/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Modify a merchant gateway. Each gateway requires a unique dataset sent in the request. Refer to below for an example of each dataset. You can retrieve the gatewayIdentifier by running the a href#gateway-types>Get Gateway Types/a> endpoint and using the gatewayUniqueId./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> br> h5>Body Parameters/h5> div classtoggle_shortcode> a classtoggle_btn collapsed data-togglecollapse href#collapse17 rolebutton aria-expandedfalse aria-controlscollapse17>NMI Gateway/a> div classcollapse multi-collapse idcollapse17> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayId/td> td>Gateway ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>nmiUserName/td> td>NMI_USER_NAME/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>nmiPassword/td> td>NMI_USER_PASSWORD/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse18 rolebutton aria-expandedfalse aria-controlscollapse18>Authorize Gateway/a> div classcollapse multi-collapse idcollapse18> div classcard card-body toggle_body p-0> table classm-0 table table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayId/td> td>Gateway ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>authorizeApiKey/td> td>AUTHORIZE_API_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>authorizeTransactionKey/td> td>AUTHORIZE_TRANSACTION_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse19 rolebutton aria-expandedfalse aria-controlscollapse19>Paytrace Gateway/a> div classcollapse multi-collapse idcollapse19> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayId/td> td>Gateway ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>payTraceUserName/td> td>PAYTRACE_USER_NAME/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>payTracePassword/td> td>PAYTRACE_USER_PASSWORD/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse20 rolebutton aria-expandedfalse aria-controlscollapse20>Paypal Gateway/a> div classcollapse multi-collapse idcollapse20> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayId/td> td>Gateway ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>paypalApiUserName/td> td>PAYTRACE_USER_NAME/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>paypalApiPassword/td> td>PAYPAL_USER_PASSWORD/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse21 rolebutton aria-expandedfalse aria-controlscollapse21>Stripe Gateway/a> div classcollapse multi-collapse idcollapse21> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayId/td> td>Gateway ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>stripePublishableKey/td> td>STRIPE_PUBLISHABLE_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>stripeSecretApiKey/td> td>STRIPE_SECRET_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse22 rolebutton aria-expandedfalse aria-controlscollapse22>USAePay Gateway/a> div classcollapse multi-collapse idcollapse22> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayId/td> td>Gateway ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>UsaePayTransactionKey/td> td>USAEPAY_TRANSACTION_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>UsaePayPin/td> td>USAEPAY_PIN/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse23 rolebutton aria-expandedfalse aria-controlscollapse23>Heartland Gateway/a> div classcollapse multi-collapse idcollapse23> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayId/td> td>Gateway ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>heartlandPublicKey/td> td>HEARTLAND_PUBLIC_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>heartlandSecretKey/td> td>HEARTLAND_SECRET_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse24 rolebutton aria-expandedfalse aria-controlscollapse24>CyberSource Gateway/a> div classcollapse multi-collapse idcollapse24> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayId/td> td>Gateway ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>cyberMerchantId/td> td>CYBERSOURCE_MERCHANT_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>cyberAPIKeyID/td> td>CYBERSOURCE_API_KEY_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>cyberSecretKey/td> td>CYBERSOURCE_SECRET_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse25 rolebutton aria-expandedfalse aria-controlscollapse25>Chargezoom Gateway/a> div classcollapse multi-collapse idcollapse25> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayId/td> td>Gateway ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>chargezoomUserName/td> td>CHARGEZOOM_USER_NAME/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>chargezoomPassword/td> td>CHARGEZOOM_USER_PASSWORD/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse26 rolebutton aria-expandedfalse aria-controlscollapse26>iTRANSACT Gateway/a> div classcollapse multi-collapse idcollapse26> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayId/td> td>Gateway ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>itransactUserName/td> td>ITRANSACT_USER_NAME/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itransactApiKey/td> td>ITRANSACT_API_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse27 rolebutton aria-expandedfalse aria-controlscollapse27>FluidPay Gateway/a> div classcollapse multi-collapse idcollapse27> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayId/td> td>Gateway ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>fluidPayApiKey/td> td>FLUIDPAY_API_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse28 rolebutton aria-expandedfalse aria-controlscollapse28>TSYS Gateway/a> div classcollapse multi-collapse idcollapse28> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayId/td> td>Gateway ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>tsysApiUserId/td> td>TSYS_API_USER_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>tsysApiPassword/td> td>TSYS_API_PASSWORD/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>tsysGatewayMerchantId/td> td>TSYS_GATEWAY_MERCHANT_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse29 rolebutton aria-expandedfalse aria-controlscollapse29>CardPointe Gateway/a> div classcollapse multi-collapse idcollapse29> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayId/td> td>Gateway ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>siteVariable/td> td>SITE_VARIABLE/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>cardpointeUsername/td> td>CP_USER_NAME/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>cardpointePassword/td> td>CP_PASSWORD/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse30 rolebutton aria-expandedfalse aria-controlscollapse30>PayArc Gateway/a> div classcollapse multi-collapse idcollapse30> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayId/td> td>Gateway ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>payarcSecretKey/td> td>PAYARC_SECRET_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse31 rolebutton aria-expandedfalse aria-controlscollapse31>EPX Gateway/a> div classcollapse multi-collapse idcollapse31> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayId/td> td>Gateway ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>EPXCustNBR/td> td>EPX_CUST_NBR/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>EPXMerchNBR/td> td>EPX_MERCH_NBR/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>EPXDBANBR/td> td>EPX_DBA_NBR/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>EPXterminal/td> td>EPX_TERMINAL/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse32 rolebutton aria-expandedfalse aria-controlscollapse32>Maverick Gateway/a> div classcollapse multi-collapse idcollapse32> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayId/td> td>Gateway ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>maverickAccessToken/td> td>MAVERICK_ACCESS_TOKEN/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>maverickTerminalId/td> td>MAVERICK_TERMINAL_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>maverickDba/td> td>Maverick DBA ID (only required if you use ACH)/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse33 rolebutton aria-expandedfalse aria-controlscollapse33>Cardknox Gateway/a> div classcollapse multi-collapse idcollapse33> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>gatewayId/td> td>Gateway ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayIdentifier/td> td>GATEWAY_UNIQUE_ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>friendlyName/td> td>Friendly Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Gateway as Default/td> td>No/td> td>String/td> td>N/td> td>Y,N/td> /tr> tr> td>cardknoxApiKey/td> td>CARDKNOX_API_KEY/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>isCC/td> td>Is Credit Card Accepted/td> td>Yes/td> td>String/td> td>Y/td> td>Y,N/td> /tr> tr> td>isACH/td> td>Is ACH Accepted/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> /div> /div> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/gateway/edit /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "gatewayIdentifier": "<GATEWAY_UNIQUE_ID>", "friendlyName": "<GATEWAY_FRIENDLY_NAME>", "gatewayId": "<GATEWAY_ID>", "nmiUserName": "<NMI_USER_NAME>", "nmiPassword": "<NMI_USER_PASSWORD>", "setAsDefault": "N", "isCC": "Y", "isACH": "Y" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Gateway updated successfully", "data": { "gatewayId": { "gatewayID": "1", "gatewayFriendlyName": "<GATEWAY_FRIENDLY_NAME>", "gatewayUsername": "<NMI_USER_NAME>", "gatewayPassword": "<NMI_USER_PASSWORD>", "gatewaySignature": "", "extra_field_1": "", "gatewayType": "1", "gatewayMerchantID": "", "defaultGateway": "0", "isCC": "1", "isACH": "1" } }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> /article> article classdocumentation_body doc-section idGeneral> div classshortcode_title> h2>General Settings/h2> p classpb-4>General endpoint calls such as create a payment term, edit a payment term, retrieving payment terms, retrieving invoice prefix, set invoice prefix number, retrieving customer portal, creating a customer portal, and retrieving tax list./p> /div> div classborder_bottom>/div> div classtour_item idcreate-payment-term> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Create Payment Term/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Create a payment term./h5> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>termName/td> td>Display name for term./td> td>Yes/td> td>String/td> td>-/td> td>Unique/td> /tr> tr> td>termDays/td> td>Number of days in the term./td> td>Yes/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Default/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/settings/payment_term/create /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "termName": "NET-12", "termDays": "12", "setAsDefault": "N" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Payment Term Created Successfully", "data": { "termID": 654, "termName": "NET-12", "termDays": "12", "setAsDefault": 0 }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idedit-payment-term> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Edit Payment Term/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Edit a payment term./h5> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>termID/td> td>Term ID/td> td>Yes/td> td>Int/td> td>-/td> td>-/td> /tr> tr> tr> td>termName/td> td>Display name for term./td> td>Yes/td> td>String/td> td>-/td> td>Unique/td> /tr> tr> td>termDays/td> td>Number of days in the term./td> td>Yes/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>setAsDefault/td> td>Set Default/td> td>Yes/td> td>String/td> td>N/td> td>Y,N/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/settings/payment_term/edit /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "termName": "TERM_NAME", "termDays": "12", "termID": "2109" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Payment Term Updated Successfully", "data": { "termID": "126", "termName": "Due on Receipt", "termDays": "0", "setAsDefault": 0 }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idget-payment-term> h4 classc_head load-order-2 idhead>span classget-type>GET/span> Get Payment Term/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieve all payment terms available for the merchant./h5> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/settings/payment_term/all /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Payment Term Details", "data": { "termID": "126", "termName": "Due on Receipt", "termDays": "0", "setAsDefault": "0" }, { "termID": "127", "termName": "Net 10", "termDays": "10", "setAsDefault": "0" }, { "termID": "128", "termName": "Net 15", "termDays": "15", "setAsDefault": "0" }, { "termID": "129", "termName": "Net 30", "termDays": "30", "setAsDefault": "0" }, { "termID": "654", "termName": "NET-12", "termDays": "12", "setAsDefault": "0" } , "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idget-invoice-prefix> h4 classc_head load-order-2 idhead>span classget-type>GET/span> Get Invoice Prefix/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieve the invoice prefix & postfix for the invoice reference number./h5> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/settings/invoice_prefix /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Merchant Settings", "data": { "prefix": "CZU", "postfix": "107" }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idset-invoice-prefix-number> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Set Invoice Prefix Number/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Create a prefix number to generate invoices./h5> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>prefix/td> td>Invoice Reference Number - Prefix/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>postfix/td> td>Invoice Reference Number - Postfix/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/settings/invoice_prefix/edit /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "prefix": "CZU", "postfix": "108" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Merchant Settings", "data": { "prefix": "CZU", "postfix": "108" }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idget-customer-portal> h4 classc_head load-order-2 idhead>span classget-type>GET/span> Get Customer Portal/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieve the merchant customer portal settings./h5> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/settings/customer_portal /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Merchant Settings", "data": { "prefix": "CZU", "postfix": "107" }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idcustomer-portal-setup> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Customer Portal Setup/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Update the merchant customer portal settings./h5> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>enablePortal/td> td>Setting to Enable/Disable Customer Portal/td> td>Yes/td> td>String/td> td>0/td> td> 0,1 /td> /tr> tr> td>portalUrlPrefix/td> td>Customer Portal URL Prefix/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>helpText/td> td>-/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>termServiceURL/td> td>-/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>allowEditContact/td> td>This allows customer to edit the details using customer portal. ( Set 1 to allow the customer to Edit Details. )/td> td>Yes/td> td>Int/td> td>0/td> td> 0,1 /td> /tr> tr> td>showPaymentInfo/td> td>This allow customer to show and edit the payment details using customer portal. ( Set 1 to allow the customer to Show & Edit Details. )/td> td>Yes/td> td>Int/td> td>0/td> td> 0,1 /td> /tr> tr> td>showSubscriptions/td> td>This will list customers subscriptions on landing page. ( Set 1 to allow the customer to Show customer subscriptions. )/td> td>Yes/td> td>Int/td> td>0/td> td> 0,1 /td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/settings/customer_portal/setup /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "enablePortal": "1", "portalUrlPrefix": "dashboard", "helpText": "", "allowEditContact": "0", "showPaymentInfo": "0", "showSubscriptions": "0", "termServiceURL": "https:\/\/merchantsite.com\/terms.html" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "data": { "enablePortal": "1", "portalUrlPrefix": "dashboard", "helpText": "", "allowEditContact": "0", "showPaymentInfo": "0", "showSubscriptions": "0", "termServiceURL": "https://merchantsite.com/terms.html", "portalURL": "https://demos.payportal.com/customer/" }, "message": "Merchant Settings", "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idtax-list> h4 classc_head load-order-2 idhead>span classget-type>GET/span> Tax List/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieve list of available taxes for the merchant./h5> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/settings/taxes /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Merchant Settings", "data": { "taxID": "4", "friendlyName": "Arizona", "taxRate": "18", "taxStatus": "1" }, { "taxID": "5", "friendlyName": "Arizona State DEPT", "taxRate": "2.5", "taxStatus": "1" }, { "taxID": "2", "friendlyName": "California", "taxRate": "8", "taxStatus": "1" }, { "taxID": "6", "friendlyName": "IST", "taxRate": "2.5", "taxStatus": "1" }, { "taxID": "7", "friendlyName": "SID", "taxRate": "2.3", "taxStatus": "1" }, { "taxID": "3", "friendlyName": "Tucson", "taxRate": "9.1", "taxStatus": "1" } , "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> /article> article classdocumentation_body doc-section idCustomers> div classshortcode_title> h2>Customers/h2> p classpb-4>Manage your merchants customers through our customers object. This API endpoint allows you to create customers, get customer data, manage a customer, and their payment methods./p> /div> div classborder_bottom>/div> div classtour_item idcreate-customer> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Create Customer/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Create a new customer./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>customerFullName/td> td>Customer Full Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>customerCompanyName/td> td>Customer Company Name/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>externalCustomerId/td> td>externalCustomerId/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>customerFirstName/td> td>Customer First Name/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>customerLastName/td> td>Customer Last Name/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>customerContact/td> td>Customer Contact Number/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>customerEmail/td> td>Customer Email Address/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bAddress1/td> td>Customer Business Address Line1/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bAddress2/td> td>Customer Business Address Line2/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCity/td> td>Customer Business Address City/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bState/td> td>Customer Business Address State/Province/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bZipcode/td> td>Customer Business Address ZipCode/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCountry/td> td>Customer Business Address Country/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sAddress1/td> td>Customer Shipping Address Line 1/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sAddress2/td> td>Customer Shipping Address Line 2/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sCity/td> td>Customer Shipping Address City/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sState/td> td>Customer Shipping Address State/Province/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sZipcode/td> td>Customer Shipping Address ZipCode/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sCountry/td> td>Customer Shipping Address Country/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/customer/create /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "customerCompanyName": "John Doe LLC", "customerFullName": "John Doe", "externalCustomerId": "EXT-CUST-123", "customerFirstName": "John", "customerLastName": "Doe", "customerContact": "(123)-456-7890", "customerEmail": "john.doe@cztester.com", "bAddress1": "", "bAddress2": "", "bCity": "", "bState": "", "bZipcode": "", "bCountry": "", "sAddress1": "", "sAddress2": "", "sCity": "", "sState": "", "sZipcode": "", "sCountry": "" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Customer details successfully saved", "data": { "customerId": "103", "customerFirstName": "John", "customerLastName": "Doe", "customerCompanyName": "John Doe LLC", "customerFullName": "John Doe LLC", "externalCustomerId": "EXT-CUST-123", "customerContact": "(123)-456-7890", "customerEmail": "john.doe@cztester.com", "customerActiveStatus": 1, "customerCreatedAt": "2022-03-28 09:03:42" }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idedit-customer> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Edit Customer/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Update a customer information./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>customerFullName/td> td>Customer Full Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>customerCompanyName/td> td>Customer Company Name/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>externalCustomerId/td> td>externalCustomerId/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>customerFirstName/td> td>Customer First Name/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>customerLastName/td> td>Customer Last Name/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>customerContact/td> td>Customer Contact Number/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>customerEmail/td> td>Customer Email Address/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bAddress1/td> td>Customer Business Address Line1/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bAddress2/td> td>Customer Business Address Line2/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCity/td> td>Customer Business Address City/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bState/td> td>Customer Business Address State/Province/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bZipcode/td> td>Customer Business Address ZipCode/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCountry/td> td>Customer Business Address Country/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sAddress1/td> td>Customer Shipping Address Line 1/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sAddress2/td> td>Customer Shipping Address Line 2/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sCity/td> td>Customer Shipping Address City/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sState/td> td>Customer Shipping Address State/Province/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sZipcode/td> td>Customer Shipping Address ZipCode/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sCountry/td> td>Customer Shipping Address Country/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/customer/edit/{customerID} /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "customerCompanyName": "John Doe Houses", "customerFullName": "John Doe Houses", "externalCustomerId": "EXT-CUST-124", "customerFirstName": "John", "customerLastName": "Doe", "customerContact": "", "bAddress1": "", "bAddress2": "", "bCity": "", "bState": "", "bZipcode": "", "bCountry": "", "sAddress1": "", "sAddress2": "", "sCity": "", "sState": "", "sZipcode": "", "sCountry": "" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Customer details successfully saved", "data": { "customerId": "1", "customerFirstName": "John", "customerLastName": "Doe", "customerCompanyName": "John Doe Houses", "externalCustomerId": "EXT-CUST-124", "customerFullName": "John Doe Houses", "customerContact": "(123) 123-4567", "customerEmail": "john.doe@cztester.com", "customerActiveStatus": 1, "customerCreatedAt": "2020-08-12 18:48:43", "sAddress1": "123 Beach St.", "sCity": "Huntington Beach", "sState": "CA", "sZipcode": "92649", "sCountry": "US", "bAddress1": "123 Beach St.", "bAddress2": "", "bCity": "Huntington Beach", "bState": "CA", "bZipcode": "92649", "bCountry": "US" }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idget-customer-data> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Get Customer Data/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieve a list of customers./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>page/td> td>Page Number (Starting - 0)/td> td>Yes/td> td>Int/td> td>0/td> td>-/td> /tr> tr> td>limit/td> td>Listing Limit Count/td> td>Yes/td> td>Int/td> td>100/td> td>-/td> /tr> tr> td>search/td> td>*Filter Customer by customerFirstName, customerLastName, customerCompanyName, customerFullName, customerEmail, externalCustomerId */td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>timeModified/td> td>Date must be yyyy-mm-dd format. Such as 2024-01-30 etc./td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/v1/customer/get_customer_data /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "page": "0", "limit": "100" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Customer Detail", "data": { "customerId": "1", "customerFirstName": "John", "customerLastName": "Doe", "customerCompanyName": "John Doe Houses", "externalCustomerId": "SHA-12345", "customerFullName": "John Doe Houses", "customerContact": "(123) 123-4567", "customerEmail": "john.doe@cztester.com", "customerActiveStatus": 1, "customerCreatedAt": "2020-08-12 18:48:43", "sAddress1": "123 Beach St.", "sCity": "Huntington Beach", "sState": "CA", "sZipcode": "92649", "sCountry": "US", "bAddress1": "123 Beach St.", "bAddress2": "", "bCity": "Huntington Beach", "bState": "CA", "bZipcode": "92649", "bCountry": "US" } , "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idget-customer-data-legacy> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Get Customer Data (Legacy)/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieve a list of customers./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>page/td> td>Page Number (Starting - 0)/td> td>Yes/td> td>Int/td> td>0/td> td>-/td> /tr> tr> td>limit/td> td>Listing Limit Count/td> td>Yes/td> td>Int/td> td>100/td> td>-/td> /tr> tr> td>search/td> td>*Filter Customer by customerFirstName, customerLastName, customerCompanyName, customerFullName, customerEmail, externalCustomerId */td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/customer/get_customer_data /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "page": "0", "limit": "100" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Customer Detail", "data": { "customerId": "1", "customerFirstName": "John", "customerLastName": "Doe", "customerCompanyName": "John Doe Houses", "externalCustomerId": "SHA-12345", "customerFullName": "John Doe Houses", "customerContact": "(123) 123-4567", "customerEmail": "john.doe@cztester.com", "customerActiveStatus": 1, "customerCreatedAt": "2020-08-12 18:48:43", "sAddress1": "123 Beach St.", "sCity": "Huntington Beach", "sState": "CA", "sZipcode": "92649", "sCountry": "US", "bAddress1": "123 Beach St.", "bAddress2": "", "bCity": "Huntington Beach", "bState": "CA", "bZipcode": "92649", "bCountry": "US" } , "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idget-single-customer-data> h4 classc_head load-order-2 idhead>span classget-type>GET/span> Get Single Customer Details/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieve a specific customers information/p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/customer/{customerID} /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Customer Detail", "data": { "customerId": "1", "customerFirstName": "John", "customerLastName": "Doe", "customerCompanyName": "John Doe Houses", "externalCustomerId": "EXT-CUST-123", "customerFullName": "John Doe Houses", "customerContact": "(123) 123-4567", "customerEmail": "john.doe@cztester.com", "customerActiveStatus": 1, "customerCreatedAt": "2020-08-12 18:48:43", "sAddress1": "123 Beach St.", "sCity": "Huntington Beach", "sState": "CA", "sZipcode": "92649", "sCountry": "US", "bAddress1": "123 Beach St.", "bAddress2": "", "bCity": "Huntington Beach", "bState": "CA", "bZipcode": "92649", "bCountry": "US" }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idactivate-deactivate-customer> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Activate / Deactivate Customer/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Activate or Deactivate a customer status./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>customerActiveStatus/td> td>Customer Active Status (Set 1 to Activate the customer)/td> td>Yes/td> td>Int/td> td>0/td> td> 0,1 /td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/customer/status/{customerID} /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "customerActiveStatus": "1" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Customer Detail", "data": { "customerId": "83", "customerFirstName": "Chargezoom", "customerLastName": "Test", "customerCompanyName": "Chargezoom Test", "customerFullName": "Chargezoom Test", "externalCustomerId": "EXT-CUST-123", "customerContact": "", "customerEmail": "chargezoom.test@cztester.com", "customerActiveStatus": "1", "customerCreatedAt": "2021-09-07 01:35:47", "sAddress1": "10 Street", "sAddress2": "", "sCity": "Tucson", "sState": "CA", "sZipcode": "85023", "sCountry": "USA", "bAddress1": "10 Street", "bAddress2": "", "bCity": "Tucson", "bState": "CA", "bZipcode": "85023", "bCountry": "USA" }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idcreate-payment-method> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Create Payment Method/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Create an ACH or Card payment method for a customer./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>defaultCard/td> td>Flag to set credit card default/td> td>Yes/td> td>Int/td> td>0/td> td>0,1/td> /tr> tr> td>paymentMethod/td> td>Payment Method Type ( 1 for Credit Card & 2 for ACH)/td> td>Yes/td> td>Int/td> td>-/td> td>1,2/td> /tr> tr> td>customerId/td> td>Customer ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bAddress1/td> td>Customer Business Address Line1/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bAddress2/td> td>Customer Business Address Line2/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCity/td> td>Customer Business Address City/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bState/td> td>Customer Business Address State/Province/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bZipcode/td> td>Customer Business Address ZipCode/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCountry/td> td>Customer Business Address Country/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bPhone/td> td>Customer Business Phone/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse33 rolebutton aria-expandedfalse aria-controlscollapse33>Payment Method: 1 (Credit Card)/a> div classcollapse multi-collapse idcollapse33> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>cardNumber/td> td>Customer Credit Card Number/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>cardCvv/td> td>Customer Credit Card CVV/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>expMonth/td> td>Customer Credit Card Expiry Month/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>expYear/td> td>Customer Credit Card Expiry Year/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse34 rolebutton aria-expandedfalse aria-controlscollapse34>Payment Method: 2 (ACH)/a> div classcollapse multi-collapse idcollapse34> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>eaccountName/td> td>Customer ACH Account Holder Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>eaccountNumber/td> td>Customer ACH Account Number/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>erouteNumber/td> td>Customer ACH Account Routing Number/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>eaccountType/td> td>Customer ACH Account Type/td> td>Yes/td> td>String/td> td>-/td> td>checking,saving/td> /tr> tr> td>eaccountHolderType/td> td>Customer ACH Account Holder Type/td> td>Yes/td> td>String/td> td>-/td> td>business,personal/td> /tr> /tbody> /table> /div> /div> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/customer/card/create /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "defaultCard": "0", "paymentMethod": "2", "customerId": "1", "eaccountName": "John Doe", "eaccountNumber": "123123123", "erouteNumber": "123123123", "eaccountType": "checking", "eaccountHolderType": "business", "bAddress1": "87026", "bAddress2": "US", "bCity": "Dallas", "bState": "TX", "bCountry": "United States", "bPhone": "8745859654", "bZipcode": "54781", "defaultCard": "0" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Payment Term Created Successfully", "data": { "cardId": 1244 }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idedit-payment-method> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Edit Payment Method/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Create an ACH or Card payment method for a customer./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>cardId/td> td>Card ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>defaultCard/td> td>Flag to set credit card default/td> td>Yes/td> td>Int/td> td>0/td> td>0,1/td> /tr> tr> td>paymentMethod/td> td>Payment Method Type ( 1 for Credit Card & 2 for ACH)/td> td>Yes/td> td>Int/td> td>-/td> td>1,2/td> /tr> tr> td>customerId/td> td>Customer ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bAddress1/td> td>Customer Business Address Line1/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bAddress2/td> td>Customer Business Address Line2/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCity/td> td>Customer Business Address City/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bState/td> td>Customer Business Address State/Province/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bZipcode/td> td>Customer Business Address ZipCode/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCountry/td> td>Customer Business Address Country/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bPhone/td> td>Customer Business Phone/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse33 rolebutton aria-expandedfalse aria-controlscollapse33>Payment Method: 1 (Credit Card)/a> div classcollapse multi-collapse idcollapse33> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>cardNumber/td> td>Customer Credit Card Number/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>cardCvv/td> td>Customer Credit Card CVV/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>expMonth/td> td>Customer Credit Card Expiry Month/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>expYear/td> td>Customer Credit Card Expiry Year/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse34 rolebutton aria-expandedfalse aria-controlscollapse34>Payment Method: 2 (ACH)/a> div classcollapse multi-collapse idcollapse34> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>eaccountName/td> td>Customer ACH Account Holder Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>eaccountNumber/td> td>Customer ACH Account Number/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>erouteNumber/td> td>Customer ACH Account Routing Number/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>eaccountType/td> td>Customer ACH Account Type/td> td>Yes/td> td>String/td> td>-/td> td>checking,saving/td> /tr> tr> td>eaccountHolderType/td> td>Customer ACH Account Holder Type/td> td>Yes/td> td>String/td> td>-/td> td>business,personal/td> /tr> /tbody> /table> /div> /div> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/customer/card/edit /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "paymentMethod": "1", "cardId": "622", "customerId": "1", "cardNumber": "4111111111111111", "cardCvv": "1234", "expMonth": "03", "expYear": "2025", "bAddress1": "87026", "bAddress2": "US", "bCity": "Dallas", "bState": "TX", "bCountry": "United States", "bPhone": "8745859654", "bZipcode": "54781", "defaultCard": "1" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Payment Term Created Successfully", "data": { "cardId": 622 }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idget-payment-methods> h4 classc_head load-order-2 idhead>span classget-type>GET/span> Get Payment Methods/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retreive a customers Credit Card/ACH information using customerID./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/customer/card/{customerID} /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Card details fetched successfully.", "data": { "cardId": "622", "cardFriendlyName": "Echeck - 3124", "cardNumber": "", "expMonth": "0", "expYear": "0", "eaccountNumber": "123123124", "erouteNumber": "123123123", "eaccountName": "John Doe", "eaccountType": "checking", "eaccountHolderType": "business", "bAddress1": "", "bAddress2": "", "bCity": "Dallas", "bState": "TX", "bZipcode": "54781", "bCountry": "United States", "userContact": "" } , "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idget-single-payment-method> h4 classc_head load-order-2 idhead>span classget-type>GET/span> Get Single Payment Method Data/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieve customer Credit Card/ACH details using the combination of customerID & cardID./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/customer/card/{customerID}/{cardID} /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Card details fetched successfully.", "data": { "cardId": "1112", "cardFriendlyName": "Visa - 1234", "cardNumber": "5439", "expMonth": "1", "expYear": "22", "eaccountNumber": null, "erouteNumber": null, "eaccountName": null, "eaccountType": null, "eaccountHolderType": null, "bAddress1": "123 Beach St.", "bAddress2": "", "bCity": "Huntington Beach", "bState": "CA", "bZipcode": "92649", "bCountry": "US", "userContact": "(123) 132-1234" }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item iddelete-payment-method> h4 classc_head load-order-2 idhead>span classget-type>GET/span> Delete Customers Payment Method/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Delete customer Credit Card/ACH details using the combination of customerID & cardID. If the cardId exists for a subscription then it cannot be removed./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/customer/card/{customerId}/{cardId}/delete /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Card details successfully removed.", "data": null, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idcreate-customer-note> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Create Customer Note/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Create customer notes./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>customerId/td> td>Customer ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>noteText/td> td>Note Text/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/customer/note/create /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "customerId": "1", "noteText": "Invoice related details as a note" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Private Note Created Successfully", "data": 32, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idget-customer-notes> h4 classc_head load-order-2 idhead>span classget-type>GET/span> Get Customer Notes/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieve customer notes./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/customer/get_notes/{customerID} /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Note list", "data": { "noteText": "NOTE SAMPLE - 1", "id": "1" }, { "noteText": "NOTE SAMPLE - 2", "id": "2" } , "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item iddelete-customer-note> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Delete Customer Note/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieve customer notes./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>customerId/td> td>Customer ID you wish to remove the note from/td> td>Yes/td> td>String/td> /tr> tr> td>noteId/td> td>The Note Id you wish to remove./td> td>Yes/td> td>String/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/customer/note/{customerID}/{noteID}/delete /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "customerId" : "CUS-1234567-PFDYE4", "noteId" : "537" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Note deleted Successfully", "data": null, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idrequest-custom-portal> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Request Customer Portal/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Manage customer portal. /p> ol classordered-list> li>Activate and send customer portal link to the customer. (customerPortalStatus required to set Activate)/li> li>Resend customer portal link to the customer. (customerPortalStatus required to set Resend)/li> li>Disable customer portal link for the customer. (customerPortalStatus required to set Deactivate)/li> /ol> br> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>customerPortalStatus/td> td>Customer Portal Status/td> td>Yes/td> td>String/td> td>-/td> td>Deactivate, Activate, Resend/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/customer/portal_status/{customerID} /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "customerPortalStatus": "Activate" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Customer Detail", "data": { "customerId": "83", "customerFirstName": "Chargezoom", "customerLastName": "Test", "customerCompanyName": "Chargezoom Test", "externalCustomerId": "EXT-CUST-123", "customerFullName": "Chargezoom Test", "customerContact": "", "customerEmail": "chargezoom.test@cztester.com", "customerActiveStatus": "1", "customerCreatedAt": "2021-09-07 01:35:47", "sAddress1": "10 Street", "sAddress2": "", "sCity": "Tucson", "sState": "CA", "sZipcode": "85023", "sCountry": "USA", "bAddress1": "10 Street", "bAddress2": "", "bCity": "Tucson", "bState": "CA", "bZipcode": "85023", "bCountry": "USA" }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> /article> article classdocumentation_body doc-section idInvoices> div classshortcode_title> h2>Invoices/h2> p classpb-4>Manage your customer invoices./p> /div> div classborder_bottom>/div> div classtour_item idpay-invoice> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Pay Invoice/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Process payment for the invoice using various input parameters:/p> ol classordered-list> li>Using the saved details./li> li>Using the new credit card details./li> li>Using the new ACH account details./li> /ol> br> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> p classpt-4 pb-4>One of the following is needed to process the request: the invoice reference number, the invoice ID, or the invoice external ID./p> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse35 rolebutton aria-expandedfalse aria-controlscollapse35>Saved Payment Details/a> div classcollapse multi-collapse idcollapse35> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>invoiceId/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>externalInvoiceId/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>invoiceRefNo/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> tr> td>gatewayId/td> td>Gateway ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>payAmount/td> td>Amount to be process for the invoice/td> td>Yes/td> td>float/td> td>-/td> td>-/td> /tr> tr> td>paymentMethod/td> td>Payment Method Type ( 1 for Credit Card & 2 for ACH)/td> td>Yes/td> td>Int/td> td>-/td> td>1,2/td> /tr> tr> td>cardID/td> td>Card ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCountry/td> td>Country field should have a valid ISO 3166 country code/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>applySurcharge/td> td>Surcharge ( 1 for Enable & 0 for Disable)/td> td>No/td> td>boolean/td> td>-/td> td>1,0/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse36 rolebutton aria-expandedfalse aria-controlscollapse36>New Card & Payment Method : 1 ( Credit Card )/a> div classcollapse multi-collapse idcollapse36> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>invoiceId/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>externalInvoiceId/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>invoiceRefNo/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayId/td> td>Gateway ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>payAmount/td> td>Amount to be process for the invoice/td> td>Yes/td> td>float/td> td>-/td> td>-/td> /tr> tr> td>paymentMethod/td> td>Payment Method Type ( 1 for Credit Card & 2 for ACH)/td> td>Yes/td> td>Int/td> td>-/td> td>1,2/td> /tr> tr> td>cardID/td> td>Card ID/td> td>Yes/td> td>String/td> td>new1/td> td>new1/td> /tr> tr> td>cardNumber/td> td>Customer Credit Card Number/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>cardCvv/td> td>Customer Credit Card CVV/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>expMonth/td> td>Customer Credit Card Expiry Month/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>expYear/td> td>Customer Credit Card Expiry Year/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bAddress1/td> td>Customer Business Address Line1/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bAddress2/td> td>Customer Business Address Line2/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCity/td> td>Customer Business Address City/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bState/td> td>Customer Business Address State/Province/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bZipcode/td> td>Customer Business Address ZipCode/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCountry/td> td>Country field should have a valid ISO 3166 country code/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bPhone/td> td>Customer Business Phone/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>applySurcharge/td> td>Surcharge ( 1 for Enable & 0 for Disable)/td> td>No/td> td>boolean/td> td>-/td> td>1,0/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse37 rolebutton aria-expandedfalse aria-controlscollapse37>New ACH & Payment Method : 2 ( ACH )/a> div classcollapse multi-collapse idcollapse37> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>invoiceId/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>externalInvoiceId/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>invoiceRefNo/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayId/td> td>Gateway ID/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>payAmount/td> td>Amount to be process for the invoice/td> td>Yes/td> td>float/td> td>-/td> td>-/td> /tr> tr> td>paymentMethod/td> td>Payment Method Type ( 1 for Credit Card & 2 for ACH)/td> td>Yes/td> td>Int/td> td>-/td> td>1,2/td> /tr> tr> td>cardID/td> td>Card ID/td> td>Yes/td> td>String/td> td>new1/td> td>new1/td> /tr> tr> td>eaccountName/td> td>Customer ACH Account Holder Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>eaccountNumber/td> td>Customer ACH Account Number/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>erouteNumber/td> td>Customer ACH Account Routing Number/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>eaccountType/td> td>Customer ACH Account Type/td> td>Yes/td> td>String/td> td>-/td> td>checking,saving/td> /tr> tr> td>eaccountHolderType/td> td>Customer ACH Account Holder Type/td> td>Yes/td> td>String/td> td>-/td> td>business,personal/td> /tr> tr> td>bAddress1/td> td>Customer Business Address Line1/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bAddress2/td> td>Customer Business Address Line2/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCity/td> td>Customer Business Address City/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bState/td> td>Customer Business Address State/Province/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bZipcode/td> td>Customer Business Address ZipCode/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCountry/td> td>Country field should have a valid ISO 3166 country code/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bPhone/td> td>Customer Business Phone/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/invoice/process_payment /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "invoiceId": "INV-1234567-Z9YEK4", "externalInvoiceId": "NOP-5963", "invoiceRefNo": "CZs10095", "gatewayId": "303", "payAmount": "5.00", "paymentMethod": "1", "cardId": "new1", "cardNumber": "4111111111111111", "cardCvv": "1234", "expMonth": "02", "expYear": "2025", "bAddress1": "87026", "bAddress2": "US", "bCity": "Dallas", "bState": "TX", "bCountry": "United States", "bPhone": "8745859654", "bZipcode": "54781", "customerContact": "", "applySurcharge": "1" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "data": { "transactionID": "1234567896", "invoiceData": { "invoiceID": "INV-1234567-Z9YEK4", "externalInvoiceId": "NOP-5963", "refNumber": "CZs10095", "BalanceRemaining": "420.00", "DueDate": "2022-02-22", "IsPaid": "false", "AppliedAmount": "-85.00", "taxID": "1", "totalTax": "40.40", "taxRate": "8.00", "TimeCreated": "2022-02-07 07:27:28", "fullName": "John Doe", "firstName": "Doe", "lastName": "John", "userEmail": "john.doe@cztester.com", "phoneNumber": "", "companyName": "John Doe", "CustomerListID": "CUS-1234567-D01VWE", "ship_address1": "10 Street", "ship_address2": "", "ship_city": "Tucson", "ship_state": "AZ", "ship_country": "US", "ship_zipcode": "85023", "address1": "10 Street", "address2": "", "City": "Tucson", "State": "AZ", "Country": "US", "zipCode": "85023", "invoiceItem": { "itemDescription": " aaa ", "itemQty": "1", "itemPrice": "505", "Name": "PP2", "itemTax": "0" } } }, "message": "Payment Successful", "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idpay-invoice-offline-legacy> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Pay Invoice (Offline)/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Pay an invoice using an offline payment (such as a check received)./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> p classpt-4 pb-4>One of the following is needed to process the request: the invoice reference number, the invoice ID, or the invoice external ID./p> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>invoiceId/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>externalInvoiceId/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>invoiceRefNo/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>paymentDate/td> td>Date must be a string containing an English date format. Such as 2000 September 10, now, next Thursday etc. or ISO 8601/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>payAmount/td> td>The amount the check was for./td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>checkNumber/td> td>The unique check number received./td> td>Yes/td> td>String/td> td>-/td> td>Must be unique/td> tr> td>paymentType/td> td>The payment type such as CHECK,CREDIT,CASH,OTHER./td> td>Yes/td> td>String/td> td>-/td> td>CHECK,CREDIT,CASH,OTHER/td> /tr> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/v1/invoice/process_payment_offline /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "invoiceId": "INV-1234567-Z9YEK4", "paymentDate": "2024-12-03", "payAmount": "5.00", "checkNumber": "CK123456789" "externalInvoiceId": "MAH-1259" "invoiceRefNo": "CZs10095" "paymentType": "CHECK" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "data": { "transactionID": "1234567896", "invoiceData": { "invoiceID": "INV-1234567-Z9YEK4", "externalInvoiceId": "MAH-1259", "refNumber": "CZs10095", "BalanceRemaining": "420.00", "DueDate": "2022-02-22", "IsPaid": "false", "AppliedAmount": "-85.00", "taxID": "1", "totalTax": "40.40", "taxRate": "8.00", "TimeCreated": "2022-02-07 07:27:28", "fullName": "John Doe", "firstName": "Doe", "lastName": "John", "userEmail": "john.doe@cztester.com", "phoneNumber": "", "companyName": "John Doe", "CustomerListID": "CUS-1234567-D01VWE", "ship_address1": "10 Street", "ship_address2": "", "ship_city": "Tucson", "ship_state": "AZ", "ship_country": "US", "ship_zipcode": "85023", "address1": "10 Street", "address2": "", "City": "Tucson", "State": "AZ", "Country": "US", "zipCode": "85023", "invoiceItem": { "itemDescription": " aaa ", "itemQty": "1", "itemPrice": "505", "Name": "PP2", "itemTax": "0" } } }, "message": "Payment Successful", "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idpay-invoice-offline> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Pay Invoice (Offline)(Legacy)/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Pay an invoice using an offline payment (such as a check received)./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> p classpt-4 pb-4>One of the following is needed to process the request: the invoice reference number, the invoice ID, or the invoice external ID./p> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>invoiceId/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>externalInvoiceId/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>invoiceRefNo/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>paymentDate/td> td>Date must be a string containing an English date format. Such as 2000 September 10, now, next Thursday etc. or ISO 8601/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>payAmount/td> td>The amount the check was for./td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>checkNumber/td> td>The unique check number received./td> td>Yes/td> td>String/td> td>-/td> td>Must be unique/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/invoice/process_payment_offline /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "invoiceId": "INV-1234567-Z9YEK4", "paymentDate": "2024-12-03", "payAmount": "5.00", "checkNumber": "CK123456789" "externalInvoiceId": "MAH-1259" "invoiceRefNo": "CZs10095" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "data": { "transactionID": "1234567896", "invoiceData": { "invoiceID": "INV-1234567-Z9YEK4", "externalInvoiceId": "MAH-1259", "refNumber": "CZs10095", "BalanceRemaining": "420.00", "DueDate": "2022-02-22", "IsPaid": "false", "AppliedAmount": "-85.00", "taxID": "1", "totalTax": "40.40", "taxRate": "8.00", "TimeCreated": "2022-02-07 07:27:28", "fullName": "John Doe", "firstName": "Doe", "lastName": "John", "userEmail": "john.doe@cztester.com", "phoneNumber": "", "companyName": "John Doe", "CustomerListID": "CUS-1234567-D01VWE", "ship_address1": "10 Street", "ship_address2": "", "ship_city": "Tucson", "ship_state": "AZ", "ship_country": "US", "ship_zipcode": "85023", "address1": "10 Street", "address2": "", "City": "Tucson", "State": "AZ", "Country": "US", "zipCode": "85023", "invoiceItem": { "itemDescription": " aaa ", "itemQty": "1", "itemPrice": "505", "Name": "PP2", "itemTax": "0" } } }, "message": "Payment Successful", "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idbatch-pay-offline> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Pay Invoice (Offline Batch)/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Pay multiple invoice using an offline payment (such as a check received)./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> p classpt-4>This API accept array of the below data./p> p classpb-4>One of the following is needed to process the request: the invoice reference number, the invoice ID, or the invoice external ID./p> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>invoiceId/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>externalInvoiceId/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>invoiceRefNo/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>paymentDate/td> td>Date must be a string containing an English date format. Such as 2000 September 10, now, next Thursday etc. or ISO 8601/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>payAmount/td> td>The amount the check was for./td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>checkNumber/td> td>The unique check number received./td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>paymentType/td> td>The payment type such as CHECK,CREDIT,CASH,OTHER./td> td>Yes/td> td>String/td> td>-/td> td>CHECK,CREDIT,CASH,OTHER/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/batch/invoice/offline_payment /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "invoiceId": "INV-1234567-Z9YEK4", "paymentDate": "2024-12-03", "payAmount": "5.00", "checkNumber": "CK123456789", "externalInvoiceId": "MAH-1259", "invoiceRefNo": "CZs10095", "paymentType": "CHECK" }, { "invoiceId": "INV-2345678-XY9PK1", "paymentDate": "2024-12-04", "payAmount": "10.00", "checkNumber": "CK987654321", "externalInvoiceId": "MAH-1260", "invoiceRefNo": "CZs10096", "paymentType": "CREDIT" }, { "invoiceId": "INV-3456789-AB3MNO", "paymentDate": "2024-12-05", "payAmount": "20.00", "checkNumber": "CK543216789", "externalInvoiceId": "MAH-1261", "invoiceRefNo": "CZs10097", "paymentType": "CASH" }, { "invoiceId": "INV-4567890-RT6QW2", "paymentDate": "2024-12-06", "payAmount": "15.00", "checkNumber": "CK654321987", "externalInvoiceId": "MAH-1262", "invoiceRefNo": "CZs10098", "paymentType": "OTHER" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "data": { "data": { "transactionID": 235062, "invoiceData": { "invoiceId": "INV-1234567-Z9YEK4", "externalInvoiceId": "MAH-1259", "customerId": "CUS-12345-67890", "invoiceStatus": "Paid", "invoiceRefrence": "CZs10095", "invoiceDueDate": "2024-11-15", "invoiceBalance": "0.00", "invoiceAppliedAmount": "5.00", "invoiceTotal": "5.00", "invoiceTimeCreated": "2024-11-01 10:15:30", "invoiceTaxData": { "taxId": "210", "taxRate": "5.00", "taxName": "Standard Tax" } , "totalTax": "0.25", "paylink": "https://payportalstg.com/customer/update_payment/abcd1234efgh5678", "comments": "Invoice settled via check", "invoiceItem": { "itemLineID": "123456", "itemID": "PRO-12345-67890", "itemRefID": null, "itemtotalAmount": "5.00", "itemQty": "1", "itemDescription": "Consulting Services", "itemPrice": "5.0000000", "itemName": "Consulting Fee", "itemTaxApplied": "0", "itemTaxType": null } } }, "message": "Offline Payment", "code": 200 }, { "data": { "invoiceId": "INV-2345678-XY9PK1", "payAmount": 10.00, "paymentDate": "2024-12-04", "checkNumber": "CK987654321" }, "message": "Invalid Invoice Payment Request", "code": 400 }, { "data": { "transactionID": 235063, "invoiceData": { "invoiceId": "INV-3456789-AB3MNO", "externalInvoiceId": "MAH-1261", "customerId": "CUS-67890-12345", "invoiceStatus": "Overdue", "invoiceRefrence": "CZs10097", "invoiceDueDate": "2024-11-10", "invoiceBalance": "15.00", "invoiceAppliedAmount": "20.00", "invoiceTotal": "35.00", "invoiceTimeCreated": "2024-11-02 11:30:45", "invoiceTaxData": { "taxId": "211", "taxRate": "10.00", "taxName": "Special Tax" } , "totalTax": "1.50", "paylink": "https://payportalstg.com/customer/update_payment/wxyz9876ijkl4321", "comments": "Partial payment made via cash", "invoiceItem": { "itemLineID": "654321", "itemID": "PRO-67890-12345", "itemRefID": null, "itemtotalAmount": "35.00", "itemQty": "1", "itemDescription": "Annual Subscription", "itemPrice": "35.0000000", "itemName": "Subscription Fee", "itemTaxApplied": "0", "itemTaxType": null } } }, "message": "Offline Payment", "code": 200 } , "message": "Invoice offline batch processing completed successfully.", "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idinvoice-detail> h4 classc_head load-order-2 idhead>span classget-type>GET/span> Invoice Detail/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieve invoice details./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Request Parameter/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>requestId/td> td>One of these can be used as the requestId to retrieve the invoice details: invoiceId, invoiceRefNo, or externalInvoiceId./td> td>String/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/invoice/{requestId} /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "data": { "invoiceId": "392", "externalInvoiceId": "QWL-4123", "invoiceRefrence": "1042", "invoiceDueDate": "2022-02-03", "invoiceBalance": "50.00", "invoiceAppliedAmount": "0.00", "invoiceTotal": "57.28", "invoiceTimeCreated": "2022-01-03 22:08:25", "invoiceTaxData": { "taxId": "3", "taxRate": "9.10", "totalTax": "4.78", "taxName": "Tucson Tax" } , "transactionData": { "tnxID": "123456789", "tnxAmount": "1.50", "tnxDate": "2022-03-17 06:59:29", "tnxStatus": "SUCCESS", "tnxCustomerId": "1", "tnxType": "sale", "tnxGatewayId": "155", "tnxCode": "100", "tnxPaymentMethod": 1, "tnxCustomDataFields": { "payment_type": " - " }, "tnxReferenceMemo": "", "tnxUserStatus": "1" }, { "tnxID": "1263456798", "tnxAmount": "5.78", "tnxDate": "2022-03-17 07:00:49", "tnxStatus": "SUCCESS", "tnxCustomerId": "1", "tnxType": "sale", "tnxGatewayId": "155", "tnxCode": "100", "tnxPaymentMethod": 1, "tnxCustomDataFields": { "payment_type": " - " }, "tnxReferenceMemo": "", "tnxUserStatus": "1" } , "invoiceItem": { "itemLineID": "17834", "itemID": "1", "itemRefID": "19", "itemtotalAmount": "52.50", "itemQty": "1", "itemDescription": null, "itemPrice": "52.50", "itemName": "Bitbucket Service", "itemTaxApplied": "1" } , "comments": "Pay invoice online at https://payby.cc/UNG1Y0ZO906" }, "paylink": "https://payportal.com/customer/update_payment/dHo4NDEyMTE0cnYxPTI4MTA-/SU5WLTE2NzM0NTM3NTYtM1lUSjJF", "message": "Invoice Detail", "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idvoid-invoice> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Void Invoice./h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Void an invoice./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> p classpt-4 pb-4>One of the following is needed to process the request: the invoice reference number, the invoice ID, or the invoice external ID./p> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>invoiceID/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>externalInvoiceId/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>invoiceRefNo/td> td>Invoice Id,externalInvoiceId or invoiceRefNo one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/invoice/void /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "invoiceID" : "INV-187592-AN49BA" "externalInvoiceId" : "FAL-4455" "invoiceRefNo" : "CZU1090" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Invoice voided succcessfully", "data": { "invoiceId": "INV-1234567-A9DSYR", "externalInvoiceId": "FAL-4455", "customerId": "CUS-1234567-DS8TVB", "invoiceStatus": "Voided", "invoiceRefrence": "CZU1090", "invoiceDueDate": "2022-11-03", "invoiceBalance": "37.00", "invoiceAppliedAmount": "0.00", "invoiceTotal": "37.00", "invoiceTimeCreated": "2022-11-03 14:20:01", "invoiceTaxData": null, "totalTax": "0.00", "invoiceItem": { "itemLineID": "8813162", "itemID": "PRO-615691-E4M5SP", "itemRefID": null, "itemtotalAmount": "37.00", "itemQty": "2", "itemDescription": "API Invoice Item", "itemPrice": "18.5", "itemName": "ACER-ASPIRE-XU507U", "itemTaxApplied": "0", "itemTaxType": null } }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idlist-all-invoices> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> List All Invoices/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieve list of invoices./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>page/td> td>Page count starting with 0/td> td>Yes/td> td>Int/td> td>0/td> td>-/td> /tr> tr> td>limit/td> td>Limit count starting with 0/td> td>Yes/td> td>Int/td> td>100/td> td>-/td> /tr> tr> td>includeItems/td> td>Include Items on list result/td> td>No/td> td>Int/td> td> 1 /td> td> 0,1 /td> /tr> tr> td>customerId/td> td>Filter: customerId/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>search/td> td>Filter: Search Value/td> td>No/td> td>String/td> td>-/td> td>Search looks for customer full name, reference number, due date, total payment, balance remaining, invoiceID and externalInvoiceId./td> /tr> tr> td>invoiceStatus/td> td>Filter: Search Invoice Depends on their status/td> td>No/td> td>String/td> td>-/td> td>If empty, retrieves open. Other options are: All, Unpaid, Past Due, Paid, Cancelled, Failed, Partial, open./td> /tr> tr> td>timeModified/td> td>Date must be yyyy-mm-dd format. Such as 2024-01-30 etc./td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/v1/invoice/all /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "page": 0, "limit": 100 } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Invoice List", "data": { "invoiceId": "INV-1234567-FW6XVN", "externalInvoiceId":"SHA-789456", "customerId": "CUST-3497-FWVN", "invoiceStatus": "Paid", "invoiceRefrence": "CZ10001", "invoiceDueDate": "2020-02-22", "invoiceBalance": "0.00", "invoiceAppliedAmount": "1,250.00", "invoiceTotal": "1,250.00", "invoiceTimeCreated": "2020-01-23 00:07:05", "invoiceTaxData": null, "totalTax": null, "invoiceItem": { "itemLineID": "8963794", "itemID": "PRO-645336-L1PGJV", "itemRefID": null, "itemtotalAmount": "1,250.00", "itemQty": "1", "itemDescription": "Customer Support", "itemPrice": "1250", "itemName": "Support Customer ", "itemTaxApplied": "0", "itemTaxType": null } , "comments": "Pay invoice online at https://payby.cc/iZC1w0NU701" }, { "invoiceId": "INV-1234567-V4PLDY", "externalInvoiceId":"PQR-847598", "customerId": "CUST-8577-PSW", "invoiceStatus": "Paid", "invoiceRefrence": "CZ10002", "invoiceDueDate": "2020-02-11", "invoiceBalance": "0.00", "invoiceAppliedAmount": "1,250.50", "invoiceTotal": "1,250.50", "invoiceTimeCreated": "2020-02-11 03:02:26", "invoiceTaxData": null, "totalTax": null, "invoiceItem": { "itemLineID": "8307970", "itemID": "PRO-858856-BOCNSI", "itemRefID": null, "itemtotalAmount": "0.00", "itemQty": "1", "itemDescription": "PP3", "itemPrice": "0", "itemName": "PP3", "itemTaxApplied": "0", "itemTaxType": null }, { "itemLineID": "8847325", "itemID": "PRO-645336-L1PGJV", "itemRefID": null, "itemtotalAmount": "1,250.00", "itemQty": "1", "itemDescription": "Customer Support", "itemPrice": "1250", "itemName": "Support Customer ", "itemTaxApplied": "0", "itemTaxType": null }, { "itemLineID": "8107711", "itemID": "PRO-548121-2I7E9O", "itemRefID": null, "itemtotalAmount": "0.50", "itemQty": "1", "itemDescription": "PP2", "itemPrice": "0.5", "itemName": "PP2", "itemTaxApplied": "0", "itemTaxType": null }, { "itemLineID": "5206504", "itemID": "PRO-855327-G24LX3", "itemRefID": null, "itemtotalAmount": "0.00", "itemQty": "1", "itemDescription": "Something", "itemPrice": "0", "itemName": "Something", "itemTaxApplied": "0", "itemTaxType": null } , "comments": "Pay invoice online at https://payby.cc/iVG1w0ZO108" }, { "invoiceId": "INV-4747957-W7TE3R", "externalInvoiceId":"ZAP-741225", "customerId": "CUST-1427-NASA", "invoiceStatus": "Paid", "invoiceRefrence": "CZ10003", "invoiceDueDate": "2020-02-11", "invoiceBalance": "0.00", "invoiceAppliedAmount": "1,250.50", "invoiceTotal": "1,250.50", "invoiceTimeCreated": "2020-02-11 03:03:16", "invoiceTaxData": null, "totalTax": null, "invoiceItem": { "itemLineID": "7253795", "itemID": "PRO-858856-BOCNSI", "itemRefID": null, "itemtotalAmount": "0.00", "itemQty": "1", "itemDescription": "PP3", "itemPrice": "0", "itemName": "PP3", "itemTaxApplied": "0", "itemTaxType": null }, { "itemLineID": "7552402", "itemID": "PRO-645336-L1PGJV", "itemRefID": null, "itemtotalAmount": "1,250.00", "itemQty": "1", "itemDescription": "Customer Support", "itemPrice": "1250", "itemName": "Support Customer ", "itemTaxApplied": "0", "itemTaxType": null }, { "itemLineID": "5037685", "itemID": "PRO-548121-2I7E9O", "itemRefID": null, "itemtotalAmount": "0.50", "itemQty": "1", "itemDescription": "PP2", "itemPrice": "0.5", "itemName": "PP2", "itemTaxApplied": "0", "itemTaxType": null }, { "itemLineID": "7870625", "itemID": "PRO-855327-G24LX3", "itemRefID": null, "itemtotalAmount": "0.00", "itemQty": "1", "itemDescription": "Something", "itemPrice": "0", "itemName": "Something", "itemTaxApplied": "0", "itemTaxType": null } , "comments": "Pay invoice online at https://payby.cc/iHG1Y0ZO109" }, { "invoiceId": "INV-1234567-P8IAJL", "externalInvoiceId":"AQW-852036", "customerId": "CUST-1234-FNAS", "invoiceStatus": "Paid", "invoiceRefrence": "CZ10007", "invoiceDueDate": "2020-03-16", "invoiceBalance": "0.00", "invoiceAppliedAmount": "1,250.50", "invoiceTotal": "1,250.50", "invoiceTimeCreated": "2020-03-16 04:15:16", "invoiceTaxData": null, "totalTax": null, "invoiceItem": { "itemLineID": "6422972", "itemID": "PRO-645336-L1PGJV", "itemRefID": null, "itemtotalAmount": "1,250.00", "itemQty": "1", "itemDescription": "Customer Support", "itemPrice": "1250", "itemName": "Support Customer ", "itemTaxApplied": "0", "itemTaxType": null }, { "itemLineID": "6989372", "itemID": "PRO-548121-2I7E9O", "itemRefID": null, "itemtotalAmount": "0.50", "itemQty": "1", "itemDescription": " aaa", "itemPrice": "0.5", "itemName": "PP2", "itemTaxApplied": "0", "itemTaxType": null } , "comments": "Pay invoice online at https://payby.cc/pHLK1Y0ZO189" } , "code": 200 } /code> /pre> /div> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idlist-all-invoices-legacy> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> List All Invoices (Legacy)/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieve list of invoices./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>page/td> td>Page count starting with 0/td> td>Yes/td> td>Int/td> td>0/td> td>-/td> /tr> tr> td>limit/td> td>Limit count starting with 0/td> td>Yes/td> td>Int/td> td>100/td> td>-/td> /tr> tr> td>includeItems/td> td>Include Items on list result/td> td>No/td> td>Int/td> td> 1 /td> td> 0,1 /td> /tr> tr> td>customerId/td> td>Filter: customerId/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>search/td> td>Filter: Search Value/td> td>No/td> td>String/td> td>-/td> td>Search looks for customer full name, reference number, due date, total payment, balance remaining, invoiceID and externalInvoiceId./td> /tr> tr> td>invoiceStatus/td> td>Filter: Search Invoice Depends on their status/td> td>No/td> td>String/td> td>-/td> td>If empty, retrieves open. Other options are: All, Unpaid, Past Due, Paid, Cancelled, Failed, Partial, open./td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/invoice/all /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "page": 0, "limit": 100 } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Invoice List", "data": { "invoiceId": "INV-1234567-FW6XVN", "externalInvoiceId":"SHA-789456", "customerId": "CUST-3497-FWVN", "invoiceStatus": "Paid", "invoiceRefrence": "CZ10001", "invoiceDueDate": "2020-02-22", "invoiceBalance": "0.00", "invoiceAppliedAmount": "1,250.00", "invoiceTotal": "1,250.00", "invoiceTimeCreated": "2020-01-23 00:07:05", "invoiceTaxData": null, "totalTax": null, "invoiceItem": { "itemLineID": "8963794", "itemID": "PRO-645336-L1PGJV", "itemRefID": null, "itemtotalAmount": "1,250.00", "itemQty": "1", "itemDescription": "Customer Support", "itemPrice": "1250", "itemName": "Support Customer ", "itemTaxApplied": "0", "itemTaxType": null } , "comments": "Pay invoice online at https://payby.cc/iZC1w0NU701" }, { "invoiceId": "INV-1234567-V4PLDY", "externalInvoiceId":"PQR-847598", "customerId": "CUST-8577-PSW", "invoiceStatus": "Paid", "invoiceRefrence": "CZ10002", "invoiceDueDate": "2020-02-11", "invoiceBalance": "0.00", "invoiceAppliedAmount": "1,250.50", "invoiceTotal": "1,250.50", "invoiceTimeCreated": "2020-02-11 03:02:26", "invoiceTaxData": null, "totalTax": null, "invoiceItem": { "itemLineID": "8307970", "itemID": "PRO-858856-BOCNSI", "itemRefID": null, "itemtotalAmount": "0.00", "itemQty": "1", "itemDescription": "PP3", "itemPrice": "0", "itemName": "PP3", "itemTaxApplied": "0", "itemTaxType": null }, { "itemLineID": "8847325", "itemID": "PRO-645336-L1PGJV", "itemRefID": null, "itemtotalAmount": "1,250.00", "itemQty": "1", "itemDescription": "Customer Support", "itemPrice": "1250", "itemName": "Support Customer ", "itemTaxApplied": "0", "itemTaxType": null }, { "itemLineID": "8107711", "itemID": "PRO-548121-2I7E9O", "itemRefID": null, "itemtotalAmount": "0.50", "itemQty": "1", "itemDescription": "PP2", "itemPrice": "0.5", "itemName": "PP2", "itemTaxApplied": "0", "itemTaxType": null }, { "itemLineID": "5206504", "itemID": "PRO-855327-G24LX3", "itemRefID": null, "itemtotalAmount": "0.00", "itemQty": "1", "itemDescription": "Something", "itemPrice": "0", "itemName": "Something", "itemTaxApplied": "0", "itemTaxType": null } , "comments": "Pay invoice online at https://payby.cc/iVG1w0ZO108" }, { "invoiceId": "INV-4747957-W7TE3R", "externalInvoiceId":"ZAP-741225", "customerId": "CUST-1427-NASA", "invoiceStatus": "Paid", "invoiceRefrence": "CZ10003", "invoiceDueDate": "2020-02-11", "invoiceBalance": "0.00", "invoiceAppliedAmount": "1,250.50", "invoiceTotal": "1,250.50", "invoiceTimeCreated": "2020-02-11 03:03:16", "invoiceTaxData": null, "totalTax": null, "invoiceItem": { "itemLineID": "7253795", "itemID": "PRO-858856-BOCNSI", "itemRefID": null, "itemtotalAmount": "0.00", "itemQty": "1", "itemDescription": "PP3", "itemPrice": "0", "itemName": "PP3", "itemTaxApplied": "0", "itemTaxType": null }, { "itemLineID": "7552402", "itemID": "PRO-645336-L1PGJV", "itemRefID": null, "itemtotalAmount": "1,250.00", "itemQty": "1", "itemDescription": "Customer Support", "itemPrice": "1250", "itemName": "Support Customer ", "itemTaxApplied": "0", "itemTaxType": null }, { "itemLineID": "5037685", "itemID": "PRO-548121-2I7E9O", "itemRefID": null, "itemtotalAmount": "0.50", "itemQty": "1", "itemDescription": "PP2", "itemPrice": "0.5", "itemName": "PP2", "itemTaxApplied": "0", "itemTaxType": null }, { "itemLineID": "7870625", "itemID": "PRO-855327-G24LX3", "itemRefID": null, "itemtotalAmount": "0.00", "itemQty": "1", "itemDescription": "Something", "itemPrice": "0", "itemName": "Something", "itemTaxApplied": "0", "itemTaxType": null } , "comments": "Pay invoice online at https://payby.cc/iHG1Y0ZO109" }, { "invoiceId": "INV-1234567-P8IAJL", "externalInvoiceId":"AQW-852036", "customerId": "CUST-1234-FNAS", "invoiceStatus": "Paid", "invoiceRefrence": "CZ10007", "invoiceDueDate": "2020-03-16", "invoiceBalance": "0.00", "invoiceAppliedAmount": "1,250.50", "invoiceTotal": "1,250.50", "invoiceTimeCreated": "2020-03-16 04:15:16", "invoiceTaxData": null, "totalTax": null, "invoiceItem": { "itemLineID": "6422972", "itemID": "PRO-645336-L1PGJV", "itemRefID": null, "itemtotalAmount": "1,250.00", "itemQty": "1", "itemDescription": "Customer Support", "itemPrice": "1250", "itemName": "Support Customer ", "itemTaxApplied": "0", "itemTaxType": null }, { "itemLineID": "6989372", "itemID": "PRO-548121-2I7E9O", "itemRefID": null, "itemtotalAmount": "0.50", "itemQty": "1", "itemDescription": " aaa", "itemPrice": "0.5", "itemName": "PP2", "itemTaxApplied": "0", "itemTaxType": null } , "comments": "Pay invoice online at https://payby.cc/pHLK1Y0ZO189" } , "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idcreate-invoice> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Create Invoice/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Create an invoice. Creating an invoice requires setting the invoice date, customerId or externalCustomerId, and invoiceLineItem. The invoiceLineItem field is an array and defined below the Body Parameters./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>customerId/td> td>customerId or externalCustomerId one of them are required/td> td>No/td> td>String/td> /tr> tr> td>externalCustomerId/td> td>customerId or externalCustomerId one of them are required/td> td>No/td> td>String/td> /tr> tr> td>invoiceDate/td> td>Invoice Date - Date must be yyyy-mm-dd format. Such as 2024-01-30 etc./td> td>Yes/td> td>String/td> /tr> tr> td>externalInvoiceId/td> td>externalInvoiceId/td> td>No/td> td>String/td> /tr> tr> td>invoiceRefNo/td> td>invoiceRefNo/td> td>No/td> td>String/td> /tr> tr> td>invoicePaytermDays/td> td>Invoice Payterm Days. If you use invoiceDate with invoicePaytermDays it will use the invoiceDueDate as the base date and add `invoicePaytermDays` number to the invoice date for the payment due date./td> td>No/td> td>integer/td> /tr> tr> td>invoiceLineItem/td> td>Item Data/td> td>Yes/td> td>Array/td> /tr> tr> td>bAddress1/td> td>Customer Business Address Line1/td> td>No/td> td>String/td> /tr> tr> td>bAddress2/td> td>Customer Business Address Line2/td> td>No/td> td>String/td> /tr> tr> td>bCity/td> td>Customer Business Address City/td> td>No/td> td>String/td> /tr> tr> td>bState/td> td>Customer Business Address State/Province/td> td>No/td> td>String/td> /tr> tr> td>bCountry/td> td>Customer Business Address Country/td> td>No/td> td>String/td> /tr> tr> td>bZipcode/td> td>Customer Business Address ZipCode/td> td>No/td> td>String/td> /tr> tr> td>sAddress1/td> td>Customer Shipping Address Line 1/td> td>No/td> td>String/td> /tr> tr> td>sAddress2/td> td>Customer Shipping Address Line 2/td> td>No/td> td>String/td> /tr> tr> td>sCity/td> td>Customer Shipping Address City/td> td>No/td> td>String/td> /tr> tr> td>sState/td> td>Customer Shipping Address State/Province/td> td>No/td> td>String/td> /tr> tr> td>sCountry/td> td>Customer Shipping Address Country/td> td>No/td> td>String/td> /tr> tr> td>sZipcode/td> td>Customer Shipping Address ZipCode/td> td>No/td> td>String/td> /tr> tr> td>taxID/td> td>Tax ID Associated from the list of taxes in your account. If your account is Freshbooks or XERO this does not apply to you./td> td>No/td> td>Integer/td> /tr> tr> td>sendEmail/td> td>Send an email with invoicebr>Values 0,1/td> td>No/td> td>Integer/td> td>-/td> /tr> /tbody> /table> h5>invoiceLineItem Array Parameters/h5> p>Based on what accounting package integration you have we integrate differently for invoiceLineItem. /p> a classtoggle_btn mt-1 collapsed data-togglecollapse href#invlinitem-1 rolebutton aria-expandedfalse aria-controlsinvlinitem-1>QBO/QBD/NAP Connected/a> div classcollapse multi-collapse idinvlinitem-1> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemListID/td> td>This is the unique ID for the product or service provided. Which must be an active service or product attached to your merchant account./td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemRate/td> td>The USD amount for the item/service./td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemQuantity/td> td>Quantity of item/service./td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemDescription/td> td>Description attached to the line item for the service/product. Required but can be empty./td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemTax/td> td>If you set itemTax to 1 for the line item then tax will be applied to it based on the taxID you provided./td> td>No/td> td>Integer/td> td>0/td> td>1,0/td> /tr> /tbody> /table> /div> /div> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/v1/invoice/create /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "customerId": "CUS-1234567-DS8TVB", "externalCustomerId": "EXT-CUST-123", "invoiceDate": "2024-01-30", "externalInvoiceId": "SHA-789456", "invoiceRefNo": "KEY 154", "invoiceLineItem": { "itemListID": "PRO-615691-E4M5SP", "externalItemId": "EXT-ITEM-E4M5SP", "itemRate": 18.5, "itemQuantity": 2, "itemDescription": "API Invoice Item" } } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Invoice details saved succcessfully", "data": { "invoiceId": "INV-1234567-A9DSYR", "externalInvoiceId":"SHA-789456", "customerId": "CUS-1234744-DS8TVB", "externalCustomerId": "EXT-CUST-123", "invoiceStatus": "Open", "invoiceRefrence": "CZU1090", "invoiceDueDate": "2022-11-03", "invoiceBalance": "37.00", "invoiceAppliedAmount": "0.00", "invoiceTotal": "37.00", "invoiceTimeCreated": "2022-11-03 14:20:01", "invoiceTaxData": null, "totalTax": "0.00", "invoiceItem": { "itemLineID": "8813162", "itemID": "PRO-615691-E4M5SP", "externalItemId": "EXT-ITEM-E4M5SP", "itemRefID": null, "itemtotalAmount": "37.00", "itemQty": "2", "itemDescription": "API Invoice Item", "itemPrice": "18.5", "itemName": "ACER-ASPIRE-XU507U", "itemTaxApplied": "0", "itemTaxType": null } , "paylink": "https://payportal.com/customer/update_payment/dHo4NDEyMTE0cnYxPTI4MTA-/SU5WLTE2NzM0NTM3NTYtM1lUSjJF" }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idlegacy-create-invoice> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Create Invoice (Legacy)/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Create an invoice. Creating an invoice requires setting the invoice date, customerId or externalCustomerId, and invoiceLineItem. The invoiceLineItem field is an array and defined below the Body Parameters./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>customerId/td> td>customerId or externalCustomerId one of them are required/td> td>No/td> td>String/td> /tr> tr> td>externalCustomerId/td> td>customerId or externalCustomerId one of them are required/td> td>No/td> td>String/td> /tr> tr> td>invoiceDate/td> td>Invoice Date - Date must be yyyy-mm-dd format. Such as 2024-01-30 etc./td> td>Yes/td> td>String/td> /tr> tr> td>externalInvoiceId/td> td>externalInvoiceId/td> td>No/td> td>String/td> /tr> tr> td>invoiceRefNo/td> td>invoiceRefNo/td> td>No/td> td>String/td> /tr> tr> td>invoicePaytermDays/td> td>Invoice Payterm Days. If you use invoiceDate with invoicePaytermDays it will use the invoiceDueDate as the base date and add `invoicePaytermDays` number to the invoice date for the payment due date./td> td>No/td> td>integer/td> /tr> tr> td>invoiceLineItem/td> td>Item Data/td> td>Yes/td> td>Array/td> /tr> tr> td>bAddress1/td> td>Customer Business Address Line1/td> td>No/td> td>String/td> /tr> tr> td>bAddress2/td> td>Customer Business Address Line2/td> td>No/td> td>String/td> /tr> tr> td>bCity/td> td>Customer Business Address City/td> td>No/td> td>String/td> /tr> tr> td>bState/td> td>Customer Business Address State/Province/td> td>No/td> td>String/td> /tr> tr> td>bCountry/td> td>Customer Business Address Country/td> td>No/td> td>String/td> /tr> tr> td>bZipcode/td> td>Customer Business Address ZipCode/td> td>No/td> td>String/td> /tr> tr> td>sAddress1/td> td>Customer Shipping Address Line 1/td> td>No/td> td>String/td> /tr> tr> td>sAddress2/td> td>Customer Shipping Address Line 2/td> td>No/td> td>String/td> /tr> tr> td>sCity/td> td>Customer Shipping Address City/td> td>No/td> td>String/td> /tr> tr> td>sState/td> td>Customer Shipping Address State/Province/td> td>No/td> td>String/td> /tr> tr> td>sCountry/td> td>Customer Shipping Address Country/td> td>No/td> td>String/td> /tr> tr> td>sZipcode/td> td>Customer Shipping Address ZipCode/td> td>No/td> td>String/td> /tr> tr> td>taxID/td> td>Tax ID Associated from the list of taxes in your account. If your account is Freshbooks or XERO this does not apply to you./td> td>No/td> td>Integer/td> /tr> /tbody> /table> h5>invoiceLineItem Array Parameters/h5> p>Based on what accounting package integration you have we integrate differently for invoiceLineItem. /p> a classtoggle_btn mt-1 collapsed data-togglecollapse href#invlinitem-1 rolebutton aria-expandedfalse aria-controlsinvlinitem-1>QBO/QBD/NAP Connected/a> div classcollapse multi-collapse idinvlinitem-1> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemListID/td> td>This is the unique ID for the product or service provided. Which must be an active service or product attached to your merchant account./td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemRate/td> td>The USD amount for the item/service./td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemQuantity/td> td>Quantity of item/service./td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemDescription/td> td>Description attached to the line item for the service/product. Required but can be empty./td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemTax/td> td>If you set itemTax to 1 for the line item then tax will be applied to it based on the taxID you provided./td> td>No/td> td>Integer/td> td>0/td> td>1,0/td> /tr> /tbody> /table> /div> /div> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/invoice/create /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "customerId": "CUS-1234567-DS8TVB", "externalCustomerId": "EXT-CUST-123", "invoiceDate": "2024-01-30", "externalInvoiceId": "SHA-789456", "invoiceRefNo": "KEY 154", "sendEmail": 1, "invoiceLineItem": { "itemListID": "PRO-615691-E4M5SP", "externalItemId": "EXT-ITEM-E4M5SP", "itemRate": 18.5, "itemQuantity": 2, "itemDescription": "API Invoice Item" } } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Invoice details saved succcessfully", "data": { "invoiceId": "INV-1234567-A9DSYR", "externalInvoiceId":"SHA-789456", "customerId": "CUS-1234744-DS8TVB", "externalCustomerId": "EXT-CUST-123", "invoiceStatus": "Open", "invoiceRefrence": "CZU1090", "invoiceDueDate": "2022-11-03", "invoiceBalance": "37.00", "invoiceAppliedAmount": "0.00", "invoiceTotal": "37.00", "invoiceTimeCreated": "2022-11-03 14:20:01", "invoiceTaxData": null, "totalTax": "0.00", "invoiceItem": { "itemLineID": "8813162", "itemID": "PRO-615691-E4M5SP", "externalItemId": "EXT-ITEM-E4M5SP", "itemRefID": null, "itemtotalAmount": "37.00", "itemQty": "2", "itemDescription": "API Invoice Item", "itemPrice": "18.5", "itemName": "ACER-ASPIRE-XU507U", "itemTaxApplied": "0", "itemTaxType": null } , "paylink": "https://payportal.com/customer/update_payment/dHo4NDEyMTE0cnYxPTI4MTA-/SU5WLTE2NzM0NTM3NTYtM1lUSjJF" }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idedit-invoice> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Edit Invoice/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Edit an invoice is the mechanism to make changes to an invoice. Edit an invoice requires setting the invoice date, customerId or externalCustomerId, and invoiceLineItem. The invoiceLineItem field is an array and defined below the Body Parameters. This function compares the Request body to the existing invoice and makes changes to any deltas which exist./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> p classpt-4 pb-4>One of the following is needed to process the request: the invoice reference number, the invoice ID, or the invoice external ID./p> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>invoiceId/td> td>invoiceId/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>customerId/td> td>customerId or externalCustomerId one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>externalCustomerId/td> td>customerId or externalCustomerId one of them are required/td> td>No/td> td>String/td> /tr> tr> td>externalInvoiceId/td> td>externalInvoiceId/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>invoiceRefNo/td> td>invoiceRefNo can be used to update the invoice, reference number can not be change after the invoice generated./td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>invoicePaytermDays/td> td>Invoice Payterm Days. If you use invoiceDate with invoicePaytermDays it will use the invoiceDueDate as the base date and add `invoicePaytermDays` number to the invoice date for the payment due date./td> td>No/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>invoiceDate/td> td>Invoice Date - Date must be yyyy-mm-dd format. Such as 2024-01-30 etc./td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>invoiceLineItem/td> td>Item Data/td> td>Yes/td> td>Array/td> td>-/td> td>-/td> /tr> tr> td>bAddress1/td> td>Customer Business Address Line1/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bAddress2/td> td>Customer Business Address Line2/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCity/td> td>Customer Business Address City/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bState/td> td>Customer Business Address State/Province/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCountry/td> td>Customer Business Address Country/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bZipcode/td> td>Customer Business Address ZipCode/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sAddress1/td> td>Customer Shipping Address Line 1/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sAddress2/td> td>Customer Shipping Address Line 2/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sCity/td> td>Customer Shipping Address City/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sState/td> td>Customer Shipping Address State/Province/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sCountry/td> td>Customer Shipping Address Country/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sZipcode/td> td>Customer Shipping Address ZipCode/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/v1/invoice/edit /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "customerId": "CUS-1234567-DS8TVB", "externalCustomerId": "EXT-CUST-123", "invoiceId": "INV-1234567-TSL015", "invoiceDate": "2024-01-30", "externalInvoiceId": "SHA-789456", "invoiceRefNo": "KEY 153", "invoiceLineItem": { "itemListID": "PRO-615691-E4M5SP", "externalItemId": "EXT-ITEM-E4M5SP", "itemRate": 18.5, "itemQuantity": 2, "itemDescription": "API Invoice Item" } } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Invoice details saved succcessfully", "data": { "invoiceId": "INV-1234657-TSL015", "externalInvoiceId":"SHA-789456", "customerId": "CUS-1234657-DS8TVB", "externalCustomerId": "EXT-CUST-123", "invoiceStatus": "Open", "invoiceRefrence": "CZU1091", "invoiceDueDate": "2022-11-03", "invoiceBalance": "37.00", "invoiceAppliedAmount": "0.00", "invoiceTotal": "37.00", "invoiceTimeCreated": "2022-11-03 14:40:41", "invoiceTaxData": null, "totalTax": "0.00", "invoiceItem": { "itemLineID": "8962863", "itemID": "PRO-615691-E4M5SP", "externalItemId": "EXT-ITEM-E4M5SP", "itemRefID": null, "itemtotalAmount": "37.00", "itemQty": "2", "itemDescription": "API Invoice Item", "itemPrice": "18.5", "itemName": "ACER-ASPIRE-XU507U", "itemTaxApplied": "0", "itemTaxType": null } }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idupdate-invoice> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Update Invoice/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Update an invoice is a purely additive request which inserts new line items into an existing invoice. Updating an invoice requires setting the invoiceLineItem. The invoiceLineItem field is an array and defined below the Body Parameters and is purely additive in that it does not affect any existing line items./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> p classpt-4 pb-4>One of the following is needed to process the request: the invoice reference number, the invoice ID, or the invoice external ID./p> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>invoiceId/td> td>invoiceId/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>externalInvoiceId/td> td>externalInvoiceId/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>invoiceRefNo/td> td>invoiceRefNo can be used to update the invoice, reference number can not be change after the invoice generated./td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>invoiceLineItem/td> td>Item Data/td> td>Yes/td> td>Array/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/v1/invoice/update /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "invoiceId": "INV-1234567-TSL015", "invoiceLineItem": { "itemListID": "PRO-615691-E4M5SP", "externalItemId": "EXT-ITEM-E4M5SP", "itemRate": 18.5, "itemQuantity": 2, "itemDescription": "API Invoice Item" } } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Invoice details saved succcessfully", "data": { "invoiceId": "INV-1234657-TSL015", "externalInvoiceId":"SHA-789456", "customerId": "CUS-1234657-DS8TVB", "externalCustomerId": "EXT-CUST-123", "invoiceStatus": "Open", "invoiceRefrence": "CZU1091", "invoiceDueDate": "2022-11-03", "invoiceBalance": "37.00", "invoiceAppliedAmount": "0.00", "invoiceTotal": "37.00", "invoiceTimeCreated": "2022-11-03 14:40:41", "invoiceTaxData": null, "totalTax": "0.00", "invoiceItem": { "itemLineID": "8962863", "itemID": "PRO-615691-E4M5SP", "externalItemId": "EXT-ITEM-E4M5SP", "itemRefID": null, "itemtotalAmount": "37.00", "itemQty": "2", "itemDescription": "API Invoice Item", "itemPrice": "18.5", "itemName": "ACER-ASPIRE-XU507U", "itemTaxApplied": "0", "itemTaxType": null } }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idlegacy-update-invoice> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Update Invoice (Legacy)/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Update an invoice. Updating an invoice requires setting the invoice date, customerId or externalCustomerId, and invoiceLineItem. The invoiceLineItem field is an array and defined below the Body Parameters./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> p classpt-4 pb-4>One of the following is needed to process the request: the invoice reference number, the invoice ID, or the invoice external ID./p> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>invoiceId/td> td>invoiceId/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>customerId/td> td>customerId or externalCustomerId one of them are required/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>externalCustomerId/td> td>customerId or externalCustomerId one of them are required/td> td>No/td> td>String/td> /tr> tr> td>externalInvoiceId/td> td>externalInvoiceId/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>invoiceRefNo/td> td>invoiceRefNo can be used to update the invoice, reference number can not be change after the invoice generated./td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>invoicePaytermDays/td> td>Invoice Payterm Days. If you use invoiceDate with invoicePaytermDays it will use the invoiceDueDate as the base date and add `invoicePaytermDays` number to the invoice date for the payment due date./td> td>No/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>invoiceDate/td> td>Invoice Date - Date must be yyyy-mm-dd format. Such as 2024-01-30 etc./td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>invoiceLineItem/td> td>Item Data/td> td>Yes/td> td>Array/td> td>-/td> td>-/td> /tr> tr> td>bAddress1/td> td>Customer Business Address Line1/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bAddress2/td> td>Customer Business Address Line2/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCity/td> td>Customer Business Address City/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bState/td> td>Customer Business Address State/Province/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCountry/td> td>Customer Business Address Country/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bZipcode/td> td>Customer Business Address ZipCode/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sAddress1/td> td>Customer Shipping Address Line 1/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sAddress2/td> td>Customer Shipping Address Line 2/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sCity/td> td>Customer Shipping Address City/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sState/td> td>Customer Shipping Address State/Province/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sCountry/td> td>Customer Shipping Address Country/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>sZipcode/td> td>Customer Shipping Address ZipCode/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>taxID/td> td>Tax ID Associated from the list of taxes in your account. If your account is Freshbooks or XERO this does not apply to you./td> td>No/td> td>Integer/td> td>-/td> td>-/td> /tr> /tbody> /table> h5>invoiceLineItem Array Parameters/h5> p>Based on what accounting package integration you have we integrate differently for invoiceLineItem. /p> a classtoggle_btn mt-1 collapsed data-togglecollapse href#invlinitem-2 rolebutton aria-expandedfalse aria-controlsinvlinitem-2>QBO/QBD/NAP Connected/a> div classcollapse multi-collapse idinvlinitem-2> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemListID/td> td>This is the unique ID for the product or service provided. Which must be an active service or product attached to your merchant account./td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemRate/td> td>The USD amount for the item/service./td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemQuantity/td> td>Quantity of item/service./td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemDescription/td> td>Description attached to the line item for the service/product. Required but can be empty./td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemTax/td> td>If you set itemTax to 1 for the line item then tax will be applied to it based on the taxID you provided./td> td>No/td> td>Integer/td> td>0/td> td>1,0/td> /tr> /tbody> /table> /div> /div> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/invoice/update /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "customerId": "CUS-1234567-DS8TVB", "externalCustomerId": "EXT-CUST-123", "invoiceId": "INV-1234567-TSL015", "invoiceDate": "2024-01-30", "externalInvoiceId": "SHA-789456", "invoiceRefNo": "KEY 153", "invoiceLineItem": { "itemListID": "PRO-615691-E4M5SP", "externalItemId": "EXT-ITEM-E4M5SP", "itemRate": 18.5, "itemQuantity": 2, "itemDescription": "API Invoice Item" } } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Invoice details saved succcessfully", "data": { "invoiceId": "INV-1234657-TSL015", "externalInvoiceId":"SHA-789456", "customerId": "CUS-1234657-DS8TVB", "externalCustomerId": "EXT-CUST-123", "invoiceStatus": "Open", "invoiceRefrence": "CZU1091", "invoiceDueDate": "2022-11-03", "invoiceBalance": "37.00", "invoiceAppliedAmount": "0.00", "invoiceTotal": "37.00", "invoiceTimeCreated": "2022-11-03 14:40:41", "invoiceTaxData": null, "totalTax": "0.00", "invoiceItem": { "itemLineID": "8962863", "itemID": "PRO-615691-E4M5SP", "externalItemId": "EXT-ITEM-E4M5SP", "itemRefID": null, "itemtotalAmount": "37.00", "itemQty": "2", "itemDescription": "API Invoice Item", "itemPrice": "18.5", "itemName": "ACER-ASPIRE-XU507U", "itemTaxApplied": "0", "itemTaxType": null } }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idresend-invoice-email> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Resend Invoice Email (Batch)/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>This endpoint allows you to resend invoice emails based on their status. Emails can only be sent for invoices with the following statuses: Open, Overdue, and Paid.br> Send emails for up to 25 invoices in a single batch request.The body of the request is an array containing the details of the invoices. See the Body Parameters section for structure and fields. /p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> p classpt-4 pb-4>One of the following is needed to process the request: the invoice reference number, the invoice ID, or the invoice external ID./p> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>invoiceIDs/td> td>invoiceIDs/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>externalInvoiceIds/td> td>externalInvoiceIds/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>invoiceRefNumbers/td> td>invoiceRefNumbers/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>templateID/td> td>Template ID/td> td>No/td> td>Integer/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/invoice/resend-email /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "invoiceIDs": "INV-1731402158-B28IPW-142886043", "INV-1731402158-B28IPW-142886043", "INV-1731402158-AQMBFS-411012241", "INV-1725606336-ZXGOVN-214273765" , "externalInvoiceIds": "1037-external-id", "1024-red-external" , "invoiceRefNumbers": "1041", "1037-1" , "templateID": 12345 } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "data": { "message": "Email to Red Rock Diner was sent successfully! ", "data": { "invoiceId": "INV-1708067466-46GART-661196664", "externalInvoiceId": "1024-red-external", "invoiceRefrence": "1024-red-2" }, "code": 200 }, { "message": "Email to Smith Ron was sent successfully! ", "data": { "invoiceId": "INV-1709530799-LE845R-236882193", "externalInvoiceId": null, "invoiceRefrence": "1041" }, "code": 200 }, { "message": "Email to Sonnenschein Family Store was sent successfully! ", "data": { "invoiceId": "INV-1725606336-ZXGOVN-214273765", "externalInvoiceId": "1037-external-id", "invoiceRefrence": "1037-1" }, "code": 200 }, { "message": "Email to Sonnenschein Family Store was sent successfully! ", "data": { "invoiceId": "INV-1731402158-AQMBFS-411012241", "externalInvoiceId": null, "invoiceRefrence": "1037" }, "code": 200 }, { "message": "Email address not available", "data": { "invoiceId": "INV-1731402158-B28IPW-142886043", "externalInvoiceId": null, "invoiceRefrence": "1041" }, "code": 500 } } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> /article> article classdocumentation_body doc-section idSubscriptions> div classshortcode_title> h2>Subscriptions/h2> p classpb-4>Manage your customer subscriptions./p> /div> div classborder_bottom>/div> div classtour_item idcreate-subscription-template> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Create Subscription Template/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Create a subscription template for a customer./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>strong>planId/strong>/td> td>Plan ID/td> td>Yes/td> td>Integer/td> td>-/td> td>-/td> /tr> tr> td>strong>planName/strong>/td> td>Plan Name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>strong>durationList/strong>/td> td>Duration/td> td>Yes/td> td>String/td> td>-/td> td>Pass 0 if it is having unlimited recurrence./td> /tr> tr> td>strong>payCycle/strong>/td> td>Pay Cycle/td> td>Yes/td> td>String/td> td>-/td> td>Pay cycle options: 1wk, 2wk, mon, qtr, six, yrl, 2yr and 3yr./td> /tr> tr> td>strong>gatewayId/strong>/td> td>Gateway ID/td> td>Yes/td> td>Integer/td> td>-/td> td>Merchant configured gateway Id./td> /tr> tr> td>strong>autoPay/strong>/td> td>Auto Pay/td> td>Yes/td> td>Integer/td> td>-/td> td>Either 1 or 0. br>1 means Yes and 0 means No./td> /tr> tr> td>strong>emailRecurrance/strong>/td> td>Email recurrence/td> td>Yes/td> td>Integer/td> td>-/td> td>Either 1 or 0. br>1 means Yes and 0 means No./td> /tr> tr> td>strong>freeTrial/strong>/td> td>Free Trial/td> td>Yes/td> td>Integer/td> td>-/td> td>If more than 0 then plan cycle will be free for that many recurrences./td> /tr> tr> td>strong>shortUrl/strong>/td> td>URL/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>strong>billingInfo/strong>/td> td>Billing Info/td> td>Yes/td> td>Integer/td> td>-/td> td>Either 1 or 0. br>1 means Yes and 0 means No./td> /tr> tr> td>strong>requireShipping/strong>/td> td>Shipping Required/td> td>Yes/td> td>Integer/td> td>-/td> td>Either 1 or 0. br>1 means Yes and 0 means No./td> /tr> tr> td>strong>requireService/strong>/td> td>Service Required/td> td>Yes/td> td>Integer/td> td>-/td> td>Either 1 or 0. br>1 means Yes and 0 means No./td> /tr> tr> td>strong>productId/strong>/td> td>Product ID/td> td>Yes/td> td>Integer/td> td>-/td> td>Can have one or more products./td> /tr> tr> td>strong>quantity/strong>/td> td>Product Quantity/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>strong>oneTimeCharge/strong>/td> td>One Time Charge/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>strong>description/strong>/td> td>Description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>strong>unitRate/strong>/td> td>Unit Rate/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>strong>total/strong>/td> td>Total/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>strong>planUrl/strong>/td> td>Plan URL/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/subscription/create_plan /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "planName": "Test Plan", "durationList": "0", "payCycle": "mon", "gatewayId": "526", "autoPay": "1", "emailRecurrance": "0", "freeTrial": "0", "shortUrl": "testpl", "billingInfo": "1", "requireShipping": "1", "requireService": "1", "productId": "PRO-674319-T059CH", "quantity": "1", "oneTimeCharge": "0", "description": "test description", "unitRate": "2.00", "total": "2.00", "planUrl": "", "planId": "" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Subscription plan created succsessfully.", "data": 46, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idget-subscription-template> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Get All Subscription Templates/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Get all subscription templates./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/subscription/get_subscription_plans_data /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "page": "0", "limit": "100" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Subscription plans", "data": { "planID": "48", "merchantDataID": "478", "planName": "Test Plan", "subscriptionPlan": "0", "freeTrial": "0", "invoiceFrequency": "mon", "subscriptionAmount": "10.00", "totalInvoice": "0", "generatedInvoice": "0", "totalAmount": null, "paidAmount": null, "paymentGateway": "704", "automaticPayment": "1", "emailRecurring": "0", "usingExistingAddress": "1", "createdAt": "2021-02-26 10:41:44", "updatedAt": null, "postPlanURL": "testpl", "merchantPlanURL": "https://demo.demo.com", "isShipping": "1", "isService": "1", "confirm_page_url": "0", "proRate": "0", "proRateBillingDay": "0", "nextMonthInvoiceDate": "0", "autoBilling": "1", "creditCard": "0", "eCheck": "0", "gatwayName": "NMI", "plan_items": { "itemID": "125", "itemListID": "21", "itemFullName": "test description", "itemDescription": "test description", "itemQuantity": "1", "itemRate": "10.00", "itemTax": "0", "oneTimeCharge": "0", "planID": "48", "invoiceDataID": "0" } } , "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idcreate-subscription> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Create Subscription/h4> div classrow> div classcol-sm-7> p classpt-4>Create a subscription for a customer./p> p>Setting up a subscription can be done without first creating a subscription template. If you supply a subscription template in the code>subPlanId/code> field it will ignore all fields that exist in the subscription plan template upon subscription creation/edit./p> p>Subscriptions with a start date of today will be billed immediately. If the customer is billed immediately you will be provided invoice information. Subscriptions will always be created regardless of successful or failure creation of invoice or transaction. All subscriptions create a customer invoice and that invoice is linked to the transaction for the subscription. Upon creation and billing of the customer you can find the code>IsPaid/code> key in the invoice to know immediately if capturing the payment was successful. If the subscription transaction fails (bad billing information, card declined, etc.) it will try again the next day. After 3 attempts we will re-create the invoice with the balance due. All transactions that fail will email the customer regarding their failed transaction. Chargezoom will continue to attempt to bill their subscription daily until a successful transaction occurs. To stop attempting billing a customer you must delete the subscription./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>strong>subscriptionName/strong>/td> td>Subscription Name is not required but can be used for display purposes./td> td>No/td> td>String/td> td>-/td> /tr> tr> td>strong>subPlanId/strong>/td> td>subPlanId can be created from the Create Subscription Template endpoint. If you provide a subPlanId all items with a red font stylecolor: red>*/font> by the requirements will be ignored and used only from the template./td> td>No/td> td>Integer/td> td>-/td> /tr> tr> td>strong>durationList/strong>/td> td>Duration list occurs by providing the total amount of times you want the subscription ran. The calculation becomes (subscription cost / duration list) charge amount per pay cycle. So a $1000 yearly cost broken down into monthly payments would be a durationList of 12, pay cycle of mon, the calculated product total would be $1000. Then the customer would be charged $83.33 per month./td> td>Yesfont stylecolor: red>*/font>/td> td>Integer/td> td>Pass 0 if recurrence is unlimited. font stylecolor: red>*/font>Ignored if subPlanId provided./td> /tr> tr> td>strong>payCycle/strong>/td> td>The pay cycle will be how often you want the customer to be billed./td> td>Yesfont stylecolor: red>*/font>/td> td>String/td> td>Plan cycle option: dly, 1wk, 2wk, mon, 2mn, qtr, six, yrl, 2yr and 3yr. font stylecolor: red>*/font>Ignored if subPlanId provided./td> /tr> tr> td>strong>proRate/strong>/td> td>If you choose a subscription recurring of monthly you can enable prorate billing. To enter Prorate data and charge next month data this must be 1 and payCycle must be mon./td> td>No/td> td>Integer/td> td>1,0/td> /tr> tr> td>strong>proBillingDate/strong>/td> td>Enter the day of the month you want to charge on./td> td>No/td> td>Integer/td> td>This field is only valid if your payCycle is mon and proRate is set to 1./td> /tr> tr> td>strong>proNextBillingDate/strong>/td> td>Enter the day of the month after which the following month will also be included on the first invoice./td> td>No/td> td>Integer/td> td>This field is only valid if your payCycle is mon and proRate is set to 1./td> /tr> tr> td>strong>customerID/strong>/td> td>Customer unique identifier./td> td>Yes/td> td>String/td> td>Customer Unique/td> /tr> tr> td>strong>autoPay/strong>/td> td>If you do not enable autoPay the subscription will ignore cardId and any payment details to be saved. It will also not bill the invoice that is generated when the subscription is created. No payments will be made unless the invoice is manually charged./td> td>Yesfont stylecolor: red>*/font>/td> td>Integer/td> td>Either 1 or 0. 1 means Yes and 0 means No. font stylecolor: red>*/font>Ignored if subPlanId provided./td> /tr> tr> td>strong>generateDate/strong>/td> td>Generation date is the date of which the subscription was generated but not first billing. For example you can have generate date be today or a day in the past and start date be today or start date be tomorrow. If no generate date provided it will be set to the date subscription created./td> td>No/td> td>String/td> td>Date format: YYYY/MM/DD/td> /tr> tr> td>strong>startDate/strong>/td> td>If you set the start date to todays date they will be billed upon creation of the subscription. The start date is first day the charges start occuring./td> td>Yes/td> td>String/td> td>Date format: YYYY/MM/DD/td> /tr> tr> td>strong>emailRecurring/strong>/td> td>Send a recurring email invoice/td> td>Yesfont stylecolor: red>*/font>/td> td>Integer/td> td>Either 1 or 0. 1 means Yes and 0 means No. font stylecolor: red>*/font>Ignored if subPlanId provided./td> /tr> tr> td>strong>freeTrial/strong>/td> td>Free trial subscription/td> td>Yesfont stylecolor: red>*/font>/td> td>String/td> td>font stylecolor: red>*/font>Ignored if subPlanId provided./td> /tr> tr> td>strong>taxId/strong>/td> td>Tax ID/td> td>No/td> td>Integer/td> td>-/td> /tr> tr> td>strong>gatewayId/strong>/td> td>Gateway ID/td> td>Yesfont stylecolor: red>*/font>/td> td>Integer/td> td>Gateway ID of merchant configured gateway. font stylecolor: red>*/font>Ignored if subPlanId provided./td> /tr> tr> td>strong>productId/strong>/td> td>Subscription item ID/td> td>Yesfont stylecolor: red>*/font>/td> td>Integer/td> td>font stylecolor: red>*/font>Ignored if subPlanId provided./td> /tr> tr> td>strong>quantity/strong>/td> td>Quantity/td> td>Yesfont stylecolor: red>*/font>/td> td>Float/td> td>font stylecolor: red>*/font>Ignored if subPlanId provided./td> /tr> tr> td>strong>oneTimeCharge/strong>/td> td>One time charge/td> td>Yesfont stylecolor: red>*/font>/td> td>Integer/td> td>Either 1 or 0. 1 means Yes and 0 means No. font stylecolor: red>*/font>Ignored if subPlanId provided./td> /tr> tr> td>strong>description/strong>/td> td>Description is used as the item/service name and description of item./td> td>Yesfont stylecolor: red>*/font>/td> td>String/td> td>font stylecolor: red>*/font>Ignored if subPlanId provided./td> /tr> tr> td>strong>unitRate/strong>/td> td>Rate/td> td>Yesfont stylecolor: red>*/font>/td> td>Float/td> td>font stylecolor: red>*/font>Ignored if subPlanId provided./td> /tr> tr> td>strong>taxCheck/strong>/td> td>Tax check/td> td>Yesfont stylecolor: red>*/font>/td> td>Integer/td> td>Either 1 or 0. 1 means Yes and 0 means No. font stylecolor: red>*/font>Ignored if subPlanId provided./td> /tr> tr> td>strong>cardId/strong>/td> td>The cardId can either be created in Customers->Create Payment Method. Or you can submit new1 as the cardId and it will create a saved payment method during the creation of the subscription./td> td>Yes/td> td>String/td> td>Must be new1 or the cardId number/td> /tr> tr> td>strong>cardNumber/strong>/td> td>Card number/td> td>Yes (if cardId equal to new1 and paymentMethod equal to 1)/td> td>String/td> td>Must be 15 or 16 digits number./td> /tr> tr> td>strong>expMonth/strong>/td> td>Expiration month/td> td>Yes (if cardId equal to new1 and paymentMethod equal to 1)/td> td>Integer/td> td>Month must be a two-digit number. For single-digit months, prepend with a leading zero (eg: 01-12)./td> /tr> tr> td>strong>expYear/strong>/td> td>Expiration year/td> td>Yes (if cardId equal to new1 and paymentMethod equal to 1)/td> td>Integer/td> td>-/td> /tr> tr> td>strong>cvv/strong>/td> td>Card CVV/td> td>Yes (if cardId equal to new1 and paymentMethod equal to 1)/td> td>Integer/td> td>Must be 3 or 4 digits number./td> /tr> tr> td>strong>eaccountNumber/strong>/td> td>eCheck account number/td> td>Yes (if cardId equal to new1 and payment method equal to 2)/td> td>Int/td> td>-/td> /tr> tr> td>strong>erouteNumber/strong>/td> td>eCheck route number/td> td>Yes(if cardId equal to new1 and payment method equal to 2)/td> td>Int/td> td>-/td> /tr> tr> td>strong>eaccountName/strong>/td> td>eCheck account holder name/td> td>Yes(if cardId equal to new1 and payment method equal to 2)/td> td>String/td> td>-/td> /tr> tr> td>strong>eaccountType/strong>/td> td>eCheck account type/td> td>Yes(if cardId equal to new1 and payment method equal to 2)/td> td>String/td> td>-/td> /tr> tr> td>strong>eaccountHolderType/strong>/td> td>eChek account holder type/td> td>Yes(if cardId equal to new1 and payment method equal to 2)/td> td>String/td> td>-/td> /tr> tr> tr> td>strong>friendlyName/strong>/td> td>Card friendly name/td> td>Yes/td> td>String/td> td>-/td> /tr> tr> td>strong>billinfo/strong>/td> td>This is a check to use an existing address on file for the customer. We recommend you submit the address anyway for both billing and non-billing address fields even if it is the same data./td> td>Yesfont stylecolor: red>*/font>/td> td>String/td> td>Either 1 or 0. 1 means Yes and 0 means No. font stylecolor: red>*/font>Ignored if subPlanId provided./td> /tr> tr> td>strong>bAddress1/strong>/td> td>Billing address 1/td> td>No/td> td>String/td> td>-/td> /tr> tr> td>strong>bAddress2/strong>/td> td>Billing address 2/td> td>No/td> td>String/td> td>-/td> /tr> tr> td>strong>bCity/strong>/td> td>Billing city/td> td>No/td> td>String/td> td>-/td> /tr> tr> td>strong>bState/strong>/td> td>Billing state/td> td>No/td> td>String/td> td>-/td> /tr> tr> td>strong>bCountry/strong>/td> td>Billing country/td> td>No/td> td>String/td> td>-/td> /tr> tr> td>strong>bZipcode/strong>/td> td>Billing zipcode/td> td>No/td> td>Integer/td> td>-/td> /tr> tr> td>strong>bPhone/strong>/td> td>Billing phone/td> td>No/td> td>Integer/td> td>Phone number should be 10 digits long./td> /tr> tr> td>strong>address1/strong>/td> td>Address 1 (Non-billing)/td> td>Yes/td> td>String/td> td>-/td> /tr> tr> td>strong>address2/strong>/td> td>Address 2 (Non-billing)/td> td>Yes/td> td>String/td> td>-/td> /tr> tr> td>strong>city/strong>/td> td>City (Non-billing)/td> td>No/td> td>String/td> td>-/td> /tr> tr> td>strong>state/strong>/td> td>State (Non-billing)/td> td>No/td> td>String/td> td>-/td> /tr> tr> td>strong>country/strong>/td> td>Country (Non-billing)/td> td>No/td> td>String/td> td>-/td> /tr> tr> td>strong>zipcode/strong>/td> td>Zipcode (Non-billing)/td> td>No/td> td>Integer/td> td>-/td> /tr> tr> td>strong>phone/strong>/td> td>Phone (Non-billing)/td> td>No/td> td>Integer/td> td>Phone number should be 10 digits long./td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/subscription/create_subscription /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "startDate": "2025-10-26", "freeTrial": 0, "autoPay": 1, "gatewayId": 2714, "oneTimeCharge": 1, 0 , "productId": 15, 25 , "quantity": 1, 1 , "unitRate": 5, 300 , "description": "$5.00 One-Time Setup Fee", "$300 Yearly Gold Plan" , "taxCheck": 0, 0 , "customerID": "6491379", "durationList": "12", "subscriptionName": "Antivirus Gold Plan", "emailRecurring": 1, "payCycle": "dly", "address1": "7400 Center ave.", "address2": "", "city": "Huntington Beach", "state": "CA", "country": "USA", "zipcode": "92647", "phone": "1231231232", "cardId": "new1", "cardNumber": "4761000000000001", "expMonth": "10", "expYear": "2025", "baddress1": "7400 Center ave.", "baddress2": "", "bcity": "Huntington Beach", "bstate": "CA", "bcountry": "USA", "bzipcode": "92647", "bphone": "1231231232" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Subscription created succsessfully.", "data": { "subscriptionID": "158", "customerID": "6831448", "merchantDataID": "82", "subscriptionName": "test", "proRate": "0", "proRateBillingDay": "0", "nextMonthInvoiceDate": "0", "subscriptionPlan": "12", "freeTrial": "0", "invoiceFrequency": "mon", "subscriptionAmount": "40.43", "totalInvoice": "12", "generatedInvoice": "1", "totalAmount": "0.00", "paidAmount": "0.00", "generatingDate": null, "firstDate": "2022-10-19", "nextGeneratingDate": "2022-11-19", "startDate": "2022-10-19", "endDate": "2023-09-18", "paymentGateway": "526", "automaticPayment": "1", "emailRecurring": "0", "usingExistingAddress": "0", "cardID": "1146", "address1": "1234 Center ave.", "address2": "", "country": "USA", "state": "CA", "city": "Huntington Beach", "zipcode": "92647", "contactNumber": "1231231232", "createdAt": null, "updatedAt": "2022-02-25 22:27:02", "taxID": "0", "planID": "0", "baddress1": "1234 Center ave.", "baddress2": "", "bcountry": "USA", "bstate": "CA", "bcity": "Huntington Beach", "bzipcode": "92647", "subscriptionStatus": "1", "isSubscriptionDelete": "0", "FullName": "John Doe - 1", "companyName": "John Doe LLC", "planName": "Sprinkle", "gatewayID": "***", "gatewayFriendlyName": "***", "gatewayUsername": "*******", "gatewayPassword": "22", "gatewaySignature": "", "extra_field_1": "", "merchantID": "276", "gatewayType": "17", "status": "0", "gatewayMerchantID": "", "creditCard": "1", "echeckStatus": "1", "isSurcharge": "0", "surchargePercentage": "0", "set_as_default": "1", "enable_level_three_data": "0", "items": { "itemID": "734", "itemListID": "1", "itemFullName": "really cool product", "itemDescription": "really cool product", "itemQuantity": "1", "itemRate": "13.00", "itemTax": "0", "oneTimeCharge": "0", "subscriptionID": "158", "invoiceDataID": "34278", "itemLineID": null, "TxnLineID": null, "itemTotal": null }, { "itemID": "735", "itemListID": "2", "itemFullName": "wow howdy", "itemDescription": "wow howdy", "itemQuantity": "1", "itemRate": "14.00", "itemTax": "0", "oneTimeCharge": "1", "subscriptionID": "158", "invoiceDataID": "34278", "itemLineID": null, "TxnLineID": null, "itemTotal": null }, { "itemID": "736", "itemListID": "3", "itemFullName": "so cool", "itemDescription": "so cool", "itemQuantity": "1", "itemRate": "12.75", "itemTax": "0", "oneTimeCharge": "0", "subscriptionID": "158", "invoiceDataID": "34278", "itemLineID": null, "TxnLineID": null, "itemTotal": null }, { "itemID": "737", "itemListID": "4", "itemFullName": "some product", "itemDescription": "some product", "itemQuantity": "2", "itemRate": "0.34", "itemTax": "0", "oneTimeCharge": "0", "subscriptionID": "158", "invoiceDataID": "34278", "itemLineID": null, "TxnLineID": null, "itemTotal": null } , "invoices": { "id": "4421", "TxnID": "34278", "EditSequence": null, "TimeCreated": "2022-10-21 00:01:47", "TimeModified": "2022-10-21 00:01:47", "RefNumber": "CHZ171-20035", "poNumber": null, "Customer_ListID": "6831448", "Customer_FullName": "John Doe - 1", "ShipAddress_Addr1": "1234 Center ave.", "ShipAddress_Addr2": "", "ShipAddress_City": "Huntington Beach", "ShipAddress_State": "CA", "ShipAddress_Country": "USA", "ShipAddress_Province": null, "ShipAddress_PostalCode": "92647", "BalanceRemaining": "40.43", "AppliedAmount": "0.00", "DueDate": "2022-10-19", "invoiceDate": "2024-01-30", "IsPaid": "false", "InvoiceMemo": null, "userStatus": "Active", "insertInvID": "34278", "invoiceRefNumber": "20035", "checkNumber": null, "paymentDate": null, "Billing_Addr1": "1234 Center ave.", "Billing_Addr2": "", "Billing_City": "Huntington Beach", "Billing_State": "CA", "Billing_Country": "USA", "Billing_PostalCode": "92647", "customerMemo": null, "TaxRate": "0.00", "TotalTax": "0", "TaxListID": "", "qb_status": "0", "qb_inv_companyID": "15683", "qb_inv_merchantID": "82", "isTxnDelete": "0", "leftDay": "29", "ListID": "6831448", "FullName": "John Doe - 1", "status": "Upcoming", "c_status": "Done" } } , "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idget-subscriptions> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Get Subscriptions/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Get all customer subscriptions./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/subscription/get_subscriptions_data /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "page": "0", "limit": "100" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Subscription list", "data": { "subscriptionID": "96", "customerID": "2", "merchantDataID": "478", "subscriptionName": "", "subscriptionPlan": "0", "freeTrial": "0", "invoiceFrequency": "mon", "subscriptionAmount": "2.00", "totalInvoice": "0", "generatedInvoice": "0", "totalAmount": null, "paidAmount": null, "generatingDate": "1", "firstDate": "2020-02-01", "nextGeneratingDate": "2020-02-01", "startDate": "2020-01-20", "endDate": "2020-01-20", "paymentGateway": "0", "automaticPayment": "1", "emailRecurring": "0", "usingExistingAddress": "0", "cardID": "1670", "address1": "", "address2": "", "country": "", "state": "", "city": "", "zipcode": "", "baddress1": null, "baddress2": null, "bcountry": null, "bstate": null, "bcity": null, "bzipcode": null, "bphone": null, "contactNumber": "", "createdAt": "2021-02-26 11:03:08", "updatedAt": "2021-02-26 11:03:08", "taxID": "0", "planID": "48", "subscriptionStatus": "1", "fullName": "Demo Shop", "companyName": "Demo Shop", "planName": null, "gatewayID": null, "gatewayFriendlyName": null, "items": { "itemID": "222", "itemListID": "27", "itemFullName": "test description", "itemDescription": "test description", "itemQuantity": "1", "itemRate": "2.00", "itemTax": "0", "oneTimeCharge": "0", "subscriptionID": "96", "invoiceDataID": "0" } } , "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item iddelete-subscription> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Delete Subscriptions/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Delete a subscription. Subscriptions cannot be edited but they can be marked deleted. This does not delete the original subscription historical data or invoice historical data./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>deleteSubscriptionId/td> td>Subscription ID you wish to delete./td> td>Yes/td> td>String/Int/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/subscription/delete_subscription /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "subscriptionID": "96" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Subscription deleted successfully.", "data": null "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idget-dunning> h4 classc_head load-order-2 idhead>span classget-type>GET/span> Get Dunning Management/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieve subscription dunning Management data./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/subscription/dunningManagement /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Dunning Managment", "data": { "period": "15", "frequency": "2,4,5,10,15", "doWithSubscriptions": "1", "doWithInvoices": "1", "trialSubscriptions": "1" }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idcreate-dunning> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Create / Edit Dunning Management/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Create or Edit a subscription dunning management./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>period/td> td>Chargezoom will retry payment collection during this period. You can choose a final action to be applied on subscriptions and invoices if customers dont pay up by the end of this period./td> td>No/td> td>String/Int/td> /tr> tr> td>frequency/td> td>Specify the intervals after which you want to retry payment collection. For example, if you specify 1, 4, 9, then payment collection will be retried after 1, 4, and 9 days from the invoice due date./td> td>No/td> td>String/Int/td> /tr> tr> td>doWithSubscriptions/td> td> When dunning period ends, what happens to invoices?br>Final action to be taken at the end of the dunning period, if invoice is unpaid. This is applicable for recurring invoices only.br> 1 for Retain as Activebr> 2 for Cancel Subscriptions /td> td>No/td> td>String/Int/td> /tr> tr> td>doWithInvoices/td> td> When dunning period ends, what happens to invoices?br> 1 for Mark As Not Paidbr> 2 for Mark As Voided /td> td>No/td> td>String/Int/td> /tr> tr> td>trialSubscriptions/td> td> Dunning for Trial subscriptionsbr> 0 or 1 /td> td>No/td> td>String/Int/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/subscription/dunningManagement /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "period": "15", "frequency": "2,4,5,10,15", "doWithSubscriptions": "1", "doWithInvoices": "1", "trialSubscriptions": "1" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Changes to Dunning Managment were saved successfully!", "data": { "period": "15", "frequency": "2,4,5,10,15", "doWithSubscriptions": "1", "doWithInvoices": "1", "trialSubscriptions": "1" }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> /article> article classdocumentation_body doc-section idPayments> div classshortcode_title> h2>Payments/h2> p classpb-4>Manage customer payments and transactions./p> /div> div classtour_item idcreate-sale-transaction> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Create Sale Transaction/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Create a sale transaction authorizing a payment./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>customerId/td> td>customerId/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>paymentMethod/td> td>Payment Method Type ( 1 for Credit Card & 2 for ACH)/td> td>Yes/td> td>integer/td> td>-/td> td>1,2/td> /tr> tr> td>cardId/td> td>Card unique identifier/td> td>Yes/td> td>String/td> td>new1/td> td>-/td> /tr> tr> td>cardNumber/td> td>Card Number/td> td>Yes(if cardId not equal to new1 and payment method equal to 1)/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>cardCvv/td> td>Card CVV/td> td>Yes(if cardId not equal to new1 and payment method equal to 1)/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>expMonth/td> td>Card expire month/td> td>Yes(if cardId not equal to new1 and payment method equal to 1)/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>expYear/td> td>Card expire year/td> td>Yes(if cardId not equal to new1 and payment method equal to 1)/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>eaccountNumber/td> td>eCheck account number/td> td>Yes(if cardId not equal to new1 and payment method equal to 2)/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>erouteNumber/td> td>eCheck route number/td> td>Yes(if cardId not equal to new1 and payment method equal to 2)/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>eaccountName/td> td>eCheck account holder name/td> td>Yes(if cardId not equal to new1 and payment method equal to 2)/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>eaccountType/td> td>eCheck account type/td> td>Yes(if cardId not equal to new1 and payment method equal to 2)/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>eaccountHolderType/td> td>eChek account holder type/td> td>Yes(if cardId not equal to new1 and payment method equal to 2)/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>payAmount/td> td>Amount to be paid/td> td>Yes/td> td>Float/td> td>-/td> td>/td> /tr> tr> td>bAddress/td> td>Customer Business Address Line/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCity/td> td>Customer Business Address City/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bState/td> td>Customer Business Address State/Province/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bZipcode/td> td>Customer Business Address ZipCode/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCountry/td> td>Country field should have a valid ISO 3166 country code/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>customerEmail/td> td>Customer Email/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>customerContact/td> td>Customer Contact/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayId/td> td>Gateway unique ID/td> td>Yes/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>invoiceId/td> td>Invoice unique ID/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>poNumber/td> td>PO Number/td> td>No/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>sendEmail/td> td>Send an email with transaction/td> td>No/td> td>Int/td> td>-/td> td>0,1/td> /tr> tr> td>referenceMemo/td> td>Reference memo/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>applySurcharge/td> td>Surcharge(1 for Enable, 0 for Disable)/td> td>No/td> td>boolean/td> td>-/td> td>1,0/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/payments/sale /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "customerId": "CUS-123457-9WV1YK", "paymentMethod": "1", "cardId": "new1", "cardNumber": "4111111111111111", "cardCvv": "1234", "expMonth": "02", "expYear": "2025", "payAmount": 5.00, "gatewayId": "2469" "applySurcharge": "1" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "data": "7406132281", "message": "Payment Successful", "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idcreate-authorize-payment> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Create Authorize Payment/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Create authorization payment for a customer. The response data number is the transaction id number. You can use this number to void or capture the transaction./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>customerId/td> td>Customer unique identifier/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>cardId/td> td>Card unique identifier/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>cardNumber/td> td>Card number/td> td>Yes(if cardId not equal to new1)/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>cardCvv/td> td>Card CVV/td> td>Yes(if cardId not equal to new1)/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>expMonth/td> td>Card expire month/td> td>Yes(if cardId not equal to new1)/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>expYear/td> td>Card expire year/td> td>Yes(if cardId not equal to new1)/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>payAmount/td> td>Amount to be paid/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>bAddress/td> td>Customer Business Address Line/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCity/td> td>Customer Business Address City/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bState/td> td>Customer Business Address State/Province/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bZipcode/td> td>Customer Business Address ZipCode/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>bCountry/td> td>Country field should have a valid ISO 3166 country code/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>customerEmail/td> td>Customer Email/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>customerContact/td> td>Customer Contact/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>gatewayId/td> td>Gateway unique identifier/td> td>Yes/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>poNumber/td> td>PO Number/td> td>No/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>sendEmail/td> td>Send an email to customer/td> td>No/td> td>Int/td> td>0/td> td>1,0/td> /tr> tr> td>referenceMemo/td> td>Reference Memo/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>applySurcharge/td> td>Surcharge(1 for Enable, 0 for Disable)/td> td>No/td> td>boolean/td> td>-/td> td>1,0/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/payments/auth /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "customerId": "CUS-1234567-9WV1YK", "paymentMethod": "1", "cardId": "new1", "cardNumber": "4111111111111111", "cardCvv": "1234", "expMonth": "02", "expYear": "2025", "payAmount": 5.00, "gatewayId": "2469" "applySurcharge": "1" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "data": "7406185193", "message": "Payment Successful", "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idcreate-auth-capture-transaction> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Create Auth Capture Transaction/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Create a card authorization capture event transaction. Return response data is the transaction id number./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>transactionId/td> td>Transaction unique identifier/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>invoiceId/td> td>Invoice unique identifier/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>payAmount/td> td>Amount to be paid/td> td>Yes(if invoiceId has value)/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>sendEmail/td> td>Email to be sent to customer/td> td>No/td> td>Int/td> td>0/td> td>1,0/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/payments/capture /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "transactionId": "7479739594", "payAmount": 5.00 } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "data": "7479739594", "message": "Payment Successful", "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idcreate-refund-transaction> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Create Refund Transaction/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Create a refund. Transaction id can be retrieved from data of previous auth capture, payment, or sale events. You can also refund a specific invoice which must include the payAmount to be refunded. Amounts but not be more than the original transaction amount./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>transactionId/td> td>Transaction unique identifier/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>invoiceRefundData/td> td>invoiceId and payAmount/td> td>No/td> td>Array/td> td>-/td> td>-/td> /tr> tr> td>payAmount/td> td>Amount to be refunded/td> td>Yes(if invoiceRefundData column does not have value)/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>sendEmail/td> td>Email to be sent to customer/td> td>No/td> td>Int/td> td>0/td> td>1,0/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/payments/refund /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "transactionId": "200028607652", "payAmount": 5.00 } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "transactionId": "200028607652", "invoiceRefundData": { "invoiceId":"INV-4729343-ME84RW", "payAmount":20 } } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "data": "200028607652", "message": "Transaction Refunded", "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idcreate-void-transaction> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Create Void Transaction/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Void a transaction./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>transactionId/td> td>Transaction unique identifier/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/payments/void /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "transactionId": "7406185193" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "data": "7406185193", "message": "Transaction Voided", "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idget-transactions> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Get Transactions/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieve all transactions./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>page/td> td>*Page Number (Starting - 0) */td> td>No/td> td>Int/td> td>-/td> /tr> tr> td>limit/td> td>Listing Limit Count (requires a limit, 0 provides no results)/td> td>Yes/td> td>Int/td> td>-/td> /tr> tr> td>customerId/td> td>Customer unique identifier/td> td>No/td> td>String/td> td>-/td> /tr> tr> td>transactionId/td> td>Transaction unique identifier/td> td>No/td> td>String/td> td>-/td> /tr> tr> td>dateTo/td> td>Date To/td> td>No/td> td>String/td> td>Date format: YYYY/MM/DD/td> /tr> tr> td>dateFrom/td> td>Date From/td> td>No/td> td>String/td> td>Date format: YYYY/MM/DD/td> /tr> tr> td>timeModified/td> td>Date must be yyyy-mm-dd format. Such as 2024-01-30 etc./td> td>No/td> td>String/td> td>-/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/v1/payments/list/transactions /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "limit": "100" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "code": 200, "message": "All transactions", "data": { "tnxID": "123654668468", "tnxAmount": "20.00", "tnxDate": "2022-07-14 02:19:07", "tnxStatus": "Success", "tnxCustomerId": "CUS-1234567-NPIE2O", "tnxType": "refund", "tnxGateway": "Heartland", "tnxGatewayId": "642", "tnxCode": "200", "tnxUserStatus": "2", "tnxPaymentMethod": "1", "tnxCustomDataFields": "{\"payment_type\":\"Visa - 1111\"}", "tnxReferenceMemo": null, "tnxInvoiceId": "INV-1234567-ME84RW", "tnxInvoiceRef": "CHZ10305" } } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idget-transactions-legacy> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Get Transactions (Legacy)/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieve all transactions./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>page/td> td>*Page Number (Starting - 0) */td> td>No/td> td>Int/td> td>-/td> /tr> tr> td>limit/td> td>Listing Limit Count (requires a limit, 0 provides no results)/td> td>Yes/td> td>Int/td> td>-/td> /tr> tr> td>customerId/td> td>Customer unique identifier/td> td>No/td> td>String/td> td>-/td> /tr> tr> td>transactionId/td> td>Transaction unique identifier/td> td>No/td> td>String/td> td>-/td> /tr> tr> td>dateTo/td> td>Date To/td> td>No/td> td>String/td> td>Date format: YYYY/MM/DD/td> /tr> tr> td>dateFrom/td> td>Date From/td> td>No/td> td>String/td> td>Date format: YYYY/MM/DD/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/payments/list/transactions /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "limit": "100" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "code": 200, "message": "All transactions", "data": { "tnxID": "123654668468", "tnxAmount": "20.00", "tnxDate": "2022-07-14 02:19:07", "tnxStatus": "Success", "tnxCustomerId": "CUS-1234567-NPIE2O", "tnxType": "refund", "tnxGateway": "Heartland", "tnxGatewayId": "642", "tnxCode": "200", "tnxUserStatus": "2", "tnxPaymentMethod": "1", "tnxCustomDataFields": "{\"payment_type\":\"Visa - 1111\"}", "tnxReferenceMemo": null, "tnxInvoiceId": "INV-1234567-ME84RW", "tnxInvoiceRef": "CHZ10305" } } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idpayment-unlink-transaction> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Unlink Invoice Transaction/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>The Unlink Transaction from Invoice API removes the association between a specific transaction and its linked invoice. This action marks the transaction as void within the system, indicating that it no longer applies to the invoice. Crucially, this API does not void the original payment with the underlying payment gateway. This functionality is valuable for correcting invoice errors, handling partial refunds or adjustments, and accommodating scenarios where a valid transaction becomes irrelevant to the current invoice. This API provides flexibility in managing invoice-transaction relationships, but its important to carefully consider the accounting and reconciliation implications of unlinking transactions./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>transactionId/td> td>Transaction unique identifier/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/payments/unlink-transaction /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "transactionId": "7406132281" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "code": 200, "message": "All transactions", "data": "7406132281" } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> /article> article classdocumentation_body doc-section idProductsServices> div classshortcode_title> h2>Product & Services/h2> p classpb-4>Use the products and services object to create items, products, and services./p> /div> div classtour_item idcreate-item> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Item Create/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Create a new product or item. Body parameters follow for your type of integration (QBO, QBD, FreshBooks, XERO, NAP, etc)/p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse61 rolebutton aria-expandedfalse aria-controlscollapse61>Request Parameters/a> div classcollapse multi-collapse idcollapse61> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>externalItemId/td> td>externalItemId/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Supported Type : Service, NonInventory, OtherCharge, Subtotal, Group, Payment and Discount./td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSalePrice/td> td>Item sale Price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item Sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse38 rolebutton aria-expandedfalse aria-controlscollapse38>Legacy QBO Type & Item Type Inventory Request Parameters/a> div classcollapse multi-collapse idcollapse38> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSku/td> td>Item SKU/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Item Type/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSalePrice/td> td>Item sale price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemPurchasePrice/td> td>Item purchase or list price./td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemPurchaseDescription/td> td>Item purchase description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemQuantity/td> td>Item quantity/td> td>No/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>parentItemId/td> td>Parent Item Id/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>expenseAccountId/td> td>Item expense Account Id/td> td>No/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>incomeAccountId/td> td>Item income Account Id/td> td>No/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>inventoryAccountId/td> td>Item inventory Account Id/td> td>No/td> td>Int/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse39 rolebutton aria-expandedfalse aria-controlscollapse39>Legacy QBO Type and Item Type Service Request Parameters/a> div classcollapse multi-collapse idcollapse39> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSku/td> td>Item SKU/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Item type/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSalePrice/td> td>Item sale Price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item Sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemPurchasePrice/td> td>Item purchase Price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemPurchaseDescription/td> td>Item purchase description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>parentItemId/td> td>Parent Item Id/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>expenseAccountId/td> td>Item expense Account Id/td> td>No/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>incomeAccountId/td> td>Item income Account Id/td> td>No/td> td>Int/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse40 rolebutton aria-expandedfalse aria-controlscollapse40>Legacy QBD Type, Item Type Service, Non-inventory, & other charge/a> div classcollapse multi-collapse idcollapse40> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Item type/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSalePrice/td> td>Item sale Price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item Sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>parentItemId/td> td>Parent Item Id/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>incomeAccountId/td> td>Item income Account Id/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse41 rolebutton aria-expandedfalse aria-controlscollapse41>Legacy QBD Type & Item Type Discount Request Parameters/a> div classcollapse multi-collapse idcollapse41> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Item type/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemDiscount/td> td>Item discount Price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item Sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>parentItemId/td> td>Parent Item Id/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>incomeAccountId/td> td>Item income Account Id/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse42 rolebutton aria-expandedfalse aria-controlscollapse42>Legacy QBD Type & Item Type Payment or Subtotal Request Parameters/a> div classcollapse multi-collapse idcollapse42> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Item type/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item Sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse43 rolebutton aria-expandedfalse aria-controlscollapse43>Legacy FreshBooks Type & Item Type Request Parameters/a> div classcollapse multi-collapse idcollapse43> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Item type/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSalePrice/td> td>Item sale Price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item Sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemQuantity/td> td>Item quantity/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>incomeAccountId/td> td>Item income Account Id/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>inventoryType/td> td>Item inventory Type/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>inventoryStock/td> td>Item inventory Stock/td> td>Yes(if you input the value inventoryType )/td> td>Int/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse44 rolebutton aria-expandedfalse aria-controlscollapse44>Legacy FreshBooks Type & Item Type Service Request Parameters/a> div classcollapse multi-collapse idcollapse44> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Item type/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSalePrice/td> td>Item sale Price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse45 rolebutton aria-expandedfalse aria-controlscollapse45>Legacy XERO Type Request Parameters/a> div classcollapse multi-collapse idcollapse45> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSalePrice/td> td>Item sale Price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item Sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemCode/td> td>Item code/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemAccountId/td> td>Item Account Id/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse46 rolebutton aria-expandedfalse aria-controlscollapse46>Legacy NAP Type, Item Type, Service Type, Inventory, & Other Charge/a> div classcollapse multi-collapse idcollapse46> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Item type/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSalePrice/td> td>Item sale Price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item Sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>parentItemId/td> td>Item parent Item Id/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse47 rolebutton aria-expandedfalse aria-controlscollapse47>Legacy NAP Type & Item Type Discount Request Parameters/a> div classcollapse multi-collapse idcollapse47> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Item type/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemDiscount/td> td>Item discount Price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item Sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>parentItemId/td> td>Item parent Item Id/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse48 rolebutton aria-expandedfalse aria-controlscollapse48>Legacy NAP Type & Item Type Payment & Subtotal Request Parameters/a> div classcollapse multi-collapse idcollapse48> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Item type/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item Sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/products/create /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "itemName": "ACER-ASPIRE-XU507U", "externalItemId": "EXT-ITEM-123", "itemType": "Noninventory", "itemSalePrice": "10", "itemPurchaseDescription": "Acer Aspire Series" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Product Created Successfully", "data": { "czItemId": "588", "externalItemId": "EXT-ITEM-123", "ListID": "PRO-1234657-E4M5SP", "EditSequence": null, "IsActive": "true", "TimeCreated": "2022-08-05 21:07:44", "TimeModified": null, "Name": "ACER-ASPIRE-XU507U", "FullName": "ACER-ASPIRE-XU507U", "Type": "Noninventory", "Parent_ListID": "", "Parent_FullName": null, "ManufacturerPartNumber": null, "SalesTaxCode_ListID": null, "SalesTaxCode_FullName": null, "BuildPoint": null, "ReorderPoint": null, "QuantityOnHand": "0", "AverageCost": null, "QuantityOnOrder": "0", "QuantityOnSalesOrder": "0", "AccountRef": null, "TaxRate": null, "SalesPrice": "10", "SalesDesc": "Acer Aspire Series", "PurchaseCost": null, "PurchaseDesc": null, "PrefVendor_ListID": null, "PrefVendor_FullName": null, "companyListID": "228", "Discount": "0.00", "DepositToAccountRef": null, "DepositToAccountName": null, "PaymentMethodRef": null, "PaymentMethodName": null }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idget-item-details> h4 classc_head load-order-2 idhead>span classget-type>GET/span> Get Item Details/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Retrieve a specific item details and attributes./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/products/{itemID} /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "data": { "itemId": "PRO-213654-E4M5SP", "externalItemId": "EXT-ITEM-123", "itemName": "ACER-ASPIRE-XU507U", "itemType": "Noninventory", "itemStatus": "Active", "itemSalePrice": "10", "itemParentId": "", "itemSaleDescription": "Acer Aspire Series", "itemAccountId": null }, "message": "Item Detail Get Successfully", "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idget-all-items> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Get All Item/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Get list of items/products./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>page/td> td>Page Number (Starting - 0)/td> td>Yes/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>limit/td> td>Listing Limit Count (0 for unlimited)/td> td>Yes/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>search/td> td>Filter Customer by itemName, externalItemId /td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>timeModified/td> td>Date must be yyyy-mm-dd format. Such as 2024-01-30 etc./td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/v1/products/all /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "page": 0, "limit": 100 } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Item Detail Get Successfully", "data": { "itemId": "PRO-123654-E4M5SP", "externalItemId": "EXT-ITEM-123", "itemName": "ACER-ASPIRE-XU507U", "itemType": "Noninventory", "itemStatus": "Active", "itemSalePrice": "10", "itemParentId": "", "itemSaleDescription": "Acer Aspire Series", "itemAccountId": null } , "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idget-all-items-legacy> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Get All Item (Legacy)/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Get list of items/products./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>page/td> td>Page Number (Starting - 0)/td> td>Yes/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>limit/td> td>Listing Limit Count (0 for unlimited)/td> td>Yes/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>search/td> td>Filter Customer by itemName, externalItemId /td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/products/all /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "page": 0, "limit": 100 } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Item Detail Get Successfully", "data": { "itemId": "PRO-123654-E4M5SP", "externalItemId": "EXT-ITEM-123", "itemName": "ACER-ASPIRE-XU507U", "itemType": "Noninventory", "itemStatus": "Active", "itemSalePrice": "10", "itemParentId": "", "itemSaleDescription": "Acer Aspire Series", "itemAccountId": null } , "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idupdate-item-status> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Update Item Status/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Update item/product status./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemId/td> td>Item Id/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemStatus/td> td>Item status/td> td>Yes/td> td>Integer/td> td>-/td> td>Aceepted Values 1, 0 /td> /tr> /tbody> /table> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/products/status_update /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "itemId": "PRO-1234657-E4M5SP", "itemStatus": "1" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": { "message": "Your Item Active", "itemId": "PRO-1234657-E4M5SP" }, "data": null, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> div classtour_item idupdate-item> h4 classc_head load-order-2 idhead>span classpost-type>POST/span> Update Item/h4> div classrow> div classcol-sm-7> p classpt-4 pb-4>Update item/product details. Body parameters follow for your type of integration (QBO, QBD, FreshBooks, XERO, NAP, etc)./p> h5>Header Parameters/h5> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> /tr> /thead> tbody> tr> td>secretKey/td> td>API secret key/td> td>Yes/td> td>String/td> /tr> tr> td>token/td> td>Access token received from the login authentication response/td> td>Yes/td> td>String/td> /tr> /tbody> /table> h5>Body Parameters/h5> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse61 rolebutton aria-expandedfalse aria-controlscollapse61>Request Parameters/a> div classcollapse multi-collapse idcollapse61> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>externalItemId/td> td>externalItemId/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Supported Type : Service, NonInventory, OtherCharge, Subtotal, Group, Payment and Discount./td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSalePrice/td> td>Item sale Price/td> td>No/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item Sale description/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemPurchaseDescription/td> td>Item purchase description/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse49 rolebutton aria-expandedfalse aria-controlscollapse49>Legacy QBO Type & Item Type Inventory Request Parameters/a> div classcollapse multi-collapse idcollapse49> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemId/td> td>Item Id/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSku/td> td>Item SKU/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Item Type/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSalePrice/td> td>Item sale price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemPurchasePrice/td> td>Item purchase or list price./td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemPurchaseDescription/td> td>Item purchase description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemQuantity/td> td>Item quantity/td> td>No/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>parentItemId/td> td>Parent Item Id/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>expenseAccountId/td> td>Item expense Account Id/td> td>No/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>incomeAccountId/td> td>Item income Account Id/td> td>No/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>inventoryAccountId/td> td>Item inventory Account Id/td> td>No/td> td>Int/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse50 rolebutton aria-expandedfalse aria-controlscollapse50>Legacy QBO Type and Item Type Service Request Parameters/a> div classcollapse multi-collapse idcollapse50> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemId/td> td>Item Id/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSku/td> td>Item SKU/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Item type/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSalePrice/td> td>Item sale Price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item Sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemPurchasePrice/td> td>Item purchase Price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemPurchaseDescription/td> td>Item purchase description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>parentItemId/td> td>Parent Item Id/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>expenseAccountId/td> td>Item expense Account Id/td> td>No/td> td>Int/td> td>-/td> td>-/td> /tr> tr> td>incomeAccountId/td> td>Item income Account Id/td> td>No/td> td>Int/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse51 rolebutton aria-expandedfalse aria-controlscollapse51>Legacy QBD Type, Item Type Service, Non-inventory, & other charge/a> div classcollapse multi-collapse idcollapse51> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemId/td> td>Item Id/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Item type/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSalePrice/td> td>Item sale Price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item Sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>parentItemId/td> td>Parent Item Id/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>incomeAccountId/td> td>Item income Account Id/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse52 rolebutton aria-expandedfalse aria-controlscollapse52>Legacy QBD Type & Item Type Discount Request Parameters/a> div classcollapse multi-collapse idcollapse52> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemId/td> td>Item Id/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Item type/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemDiscount/td> td>Item discount Price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item Sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>parentItemId/td> td>Parent Item Id/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>incomeAccountId/td> td>Item income Account Id/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse53 rolebutton aria-expandedfalse aria-controlscollapse53>Legacy QBD Type & Item Type Payment or Subtotal Request Parameters/a> div classcollapse multi-collapse idcollapse53> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemId/td> td>Item Id/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Item type/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item Sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse54 rolebutton aria-expandedfalse aria-controlscollapse54>Legacy FreshBooks Type & Item Type Request Parameters/a> div classcollapse multi-collapse idcollapse54> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemId/td> td>Item Id/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Item type/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSalePrice/td> td>Item sale Price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item Sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemQuantity/td> td>Item quantity/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>incomeAccountId/td> td>Item income Account Id/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>inventoryType/td> td>Item inventory Type/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>inventoryStock/td> td>Item inventory Stock/td> td>Yes(if you input the value inventoryType )/td> td>Int/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse55 rolebutton aria-expandedfalse aria-controlscollapse55>Legacy FreshBooks Type & Item Type Service Request Parameters/a> div classcollapse multi-collapse idcollapse55> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemId/td> td>Item Id/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Item type/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSalePrice/td> td>Item sale Price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse56 rolebutton aria-expandedfalse aria-controlscollapse56>Legacy XERO Type Request Parameters/a> div classcollapse multi-collapse idcollapse56> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemId/td> td>Item Id/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSalePrice/td> td>Item sale Price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item Sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemCode/td> td>Item code/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemAccountId/td> td>Item Account Id/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse57 rolebutton aria-expandedfalse aria-controlscollapse57>Legacy NAP Type, Item Type, Service Type, Inventory, & Other Charge/a> div classcollapse multi-collapse idcollapse57> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemId/td> td>Item Id/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Item type/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSalePrice/td> td>Item sale Price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item Sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>parentItemId/td> td>Item parent Item Id/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse58 rolebutton aria-expandedfalse aria-controlscollapse58>Legacy NAP Type & Item Type Discount Request Parameters/a> div classcollapse multi-collapse idcollapse58> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemId/td> td>Item Id/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Item type/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemDiscount/td> td>Item discount Price/td> td>Yes/td> td>Float/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item Sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>parentItemId/td> td>Item parent Item Id/td> td>No/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> a classtoggle_btn mt-1 collapsed data-togglecollapse href#collapse59 rolebutton aria-expandedfalse aria-controlscollapse59>Legacy NAP Type & Item Type Payment & Subtotal Request Parameters/a> div classcollapse multi-collapse idcollapse59> div classcard card-body toggle_body p-0> table classtable table_shortcode table-responsive> thead> tr> th>strong>Key/strong>/th> th>strong>Description/strong>/th> th>strong>Required/strong>/th> th>strong>Type/strong>/th> th>strong>Default/strong>/th> th>strong>Restrictions/strong>/th> /tr> /thead> tbody> tr> td>itemId/td> td>Item Id/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemName/td> td>Item name/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemType/td> td>Item type/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> tr> td>itemSaleDescription/td> td>Item Sale description/td> td>Yes/td> td>String/td> td>-/td> td>-/td> /tr> /tbody> /table> /div> /div> /div> div classcol-sm-5> div classcode_item> h4 classc_head load-order-2 idinline>URL/h4> pre classsnippet> code classlanguage-clike> https://merchantapi.payportal.com/products/edit /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Request Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "itemId": "PRO-1233546-E4M5SP", "externalItemId": "EXT-ITEM-124", "itemName": "ACER-ASPIRE-XU507U", "itemType": "Noninventory", "itemSalePrice": "10", "itemSaleDescription": "Acer Aspire Series", "itemPurchaseDescription": "" } /code> /pre> /div> div classcode_item> h4 classc_head load-order-2 idinline>Response Example/h4> pre classsnippet> code classlanguage-json data-langjson> { "message": "Product Upadate Successfully", "data": { "czItemId": "588", "externalItemId": "EXT-ITEM-124", "ListID": "PRO-1233546-E4M5SP", "EditSequence": null, "IsActive": "true", "TimeCreated": "2022-08-05 22:13:26", "TimeModified": null, "Name": "ACER-ASPIRE-XU507U", "FullName": "ACER-ASPIRE-XU507U", "Type": "Noninventory", "Parent_ListID": "", "Parent_FullName": null, "ManufacturerPartNumber": null, "SalesTaxCode_ListID": null, "SalesTaxCode_FullName": null, "BuildPoint": null, "ReorderPoint": null, "QuantityOnHand": "0", "AverageCost": null, "QuantityOnOrder": "0", "QuantityOnSalesOrder": "0", "AccountRef": null, "TaxRate": null, "SalesPrice": "10", "SalesDesc": "Acer Aspire Series", "PurchaseCost": null, "PurchaseDesc": null, "PrefVendor_ListID": null, "PrefVendor_FullName": null, "companyListID": "228", "Discount": "0.00", "DepositToAccountRef": null, "DepositToAccountName": null, "PaymentMethodRef": null, "PaymentMethodName": null }, "code": 200 } /code> /pre> /div> /div> /div> /div> div classborder_bottom>/div> /article> /div> /div> /div> /div> /section> footer classsimple_footer> div classcontainer > div classrow> div classcol-lg-6> p stylecolor: white;>© 2025 All Rights Reserved by a href# stylecolor:white;>Chargezoom/a>/p> /div> /div> /div> /footer> /div> !-- Back to top button --> a idback-to-top titleBack to Top>/a> script src/resources/js/jquery-3.5.1.min.js>/script> script src/resources/assets/bootstrap/js/bootstrap.min.js>/script> script src/resources/assets/prism/prism.js>/script> script src/resources/js/throttle.js>/script> script src/resources/js/onpage-menu.js>/script> /body>/html>
View on OTX
|
View on ThreatMiner
Please enable JavaScript to view the
comments powered by Disqus.
Data with thanks to
AlienVault OTX
,
VirusTotal
,
Malwr
and
others
. [
Sitemap
]