# ZenPayments ## Docs - General Information [Authentication](https://rl3l4f0v16.apifox.cn/63691985f0.md): Our API uses **Access Token** to authenticate requests. You can view and manage your **Access Token** in the Dashboard. - General Information [Errors](https://rl3l4f0v16.apifox.cn/63691986f0.md): We use conventional HTTP response codes to indicate the success or failure of an API request. - General Information [Responses](https://rl3l4f0v16.apifox.cn/63691987f0.md): Our response will be divided into 3 sections: - General Information [Filters](https://rl3l4f0v16.apifox.cn/63691988f0.md): Filters will help you find what you search. - General Information [Pagination](https://rl3l4f0v16.apifox.cn/63691989f0.md): If there are too many results of your request, we will enable pagination of the results. - General Information [Data Types](https://rl3l4f0v16.apifox.cn/63691990f0.md): | Type | Description | - Merchants [Card Payments](https://rl3l4f0v16.apifox.cn/63691992f0.md): > In the payment gateway, your requests need to always include the system `terminal.id`. Within itself the system `terminal.id` contains DBA, MID, and terminal TID information, this way we always ensure that you are using the correct MID and TID if you have more than one. - Merchants [Hosted Form](https://rl3l4f0v16.apifox.cn/63691993f0.md): With our Gateway embedded hosted form functionality, you can achieve quick, efficient, and secure online transactions, without the worry of PCI compliance. - Merchants [Hosted Fields](https://rl3l4f0v16.apifox.cn/63691994f0.md): Hosted Fields allows you to create a highly customized payment page for your website or application. All fields are completely customizable to fit your web page design and branding. In order to use this functionality you need to have an API token with permission `Credit/Debit Card Payments Read and Write` assigned to it. - Merchants > Hosted Fields [How it Works](https://rl3l4f0v16.apifox.cn/63692003f0.md): Everytime when a payment should be made, you must include our `HostedFields.js` asset into your website, then issue an `Hosted Fields Token` with which a payment can be processed. You then initialize a payment form (with the `Hosted Fields Token`) by providing the required configuration and styling for it. We will render the payment form the way you requested it and process the payment when the customer submits the form with all required data (card number, cvv, etc.). In order to make it fully functional you will need to handle all payment form events that occur on your end. We're going to notify you of these events (validation failure, validation success, 3DS started, processing start and so on), but you will need to handle them accordingly (e.g., updating the UI when required) to make the payment experience user friendly. Hosted Fields Asset URL: - Merchants > Hosted Fields [Hosted Fields Token](https://rl3l4f0v16.apifox.cn/63692004f0.md): A `Hosted Fields Token` is required to process a hosted fields payment without exposing your API Token. - Merchants > Hosted Fields > Integration Guide [Step 1: Include the JavaScript Library](https://rl3l4f0v16.apifox.cn/63692006f0.md): After you have your AccessToken you can start integrating the hosted fields form into your website. First, add the `HostedFields` asset script tag to access the JavaScript Library: - Merchants > Hosted Fields > Integration Guide [Step 2: Add HTML Elements for all payment fields](https://rl3l4f0v16.apifox.cn/63692007f0.md): You need some HTML elements that will act as containers in which the separate hosted fields will be rendered. Here's an example structure: - Merchants > Hosted Fields > Integration Guide [Step 3: Set the AccessToken and Configure the rest of the form](https://rl3l4f0v16.apifox.cn/63692008f0.md): ##### Main Configuration - Merchants > Hosted Fields > Integration Guide [Step 4: Add styling](https://rl3l4f0v16.apifox.cn/63692009f0.md): ##### Manually Providing CSS - Merchants > Hosted Fields > Integration Guide [Step 5: Listen for Events](https://rl3l4f0v16.apifox.cn/63692010f0.md): The `form` variable returned by our JavaScript library is an instance of **EventTarget** object. This means that you can **addEventListener** to all of the various events it emits while the user interacts with it or while the payment is processed. All of the emitted events are **CustomEvents** and they might have payload containing event related data under `event.detail` Object. Here's a full list: - Merchants > Hosted Fields > Integration Guide [Step 6: Get the tokenized card](https://rl3l4f0v16.apifox.cn/63692011f0.md): When a payment is completed and you did set **saveCard** parameter to `required` or `optional` (and the user gave the permission) the card token will be available for you to fetch. To do so you need make a POST request to following endpoint: - Merchants > Hosted Fields > Integration Guide [Add Payment Method Page](https://rl3l4f0v16.apifox.cn/63692012f0.md): If you want to use the hosted fields functionality to create an `Add Payment Method` page to your website the process is the same as described above. Just make sure you set the `amount` parameter to **0**. And when issuing the `Hosted Fields Token` pass the **saveCard** parameter as `required`. We will make sure to render the correct submit button text so the users know they aren't paying anyting. - Merchants > Hosted Fields > Integration Guide [Testing your integration](https://rl3l4f0v16.apifox.cn/63692013f0.md): You can use our sandbox environment to test your integration. - Merchants [CustomerVault](https://rl3l4f0v16.apifox.cn/63691995f0.md): Customer Vault securely stores sensitive customer billing information, allowing subsequent transactions to be processed without the need for you to recollect the information or store it on your own system. This makes for a quick and simple billing process. - Merchants > CustomerVault [Sandbox](https://rl3l4f0v16.apifox.cn/63692014f0.md): **IMPORTANT** Please be aware the CustomerVault URL is different than what is referenced above in the merchant section of this documentation. Please ensure to use the correct URL endpoint for CustomerVault as shown below. - Merchants > CustomerVault [Hosted Card Form](https://rl3l4f0v16.apifox.cn/63692015f0.md): With our Customer Vault embedded hosted form functionality, you can achieve quick, efficient, and secure customer card tokenization without the worry of PCI compliance. - Merchants > CustomerVault [Customers](https://rl3l4f0v16.apifox.cn/63692016f0.md): Use this endpoint to manage all of your customers in the Customer Vault. - Merchants > CustomerVault [Billing Information](https://rl3l4f0v16.apifox.cn/63692018f0.md): You can use this endpoint for customer billing-related operations in the customer vault. You can create, update, delete, or archive customer billing information. - Merchants > CustomerVault [Recurring Payment](https://rl3l4f0v16.apifox.cn/63692020f0.md): #### Recurring Payments - Merchants [Response Codes](https://rl3l4f0v16.apifox.cn/63691997f0.md): Responses to any request clearly indicate if the request is processed successfully. We have integrated the following logic and groups in our response codes. - Merchants > Response Codes [Verification Response Codes](https://rl3l4f0v16.apifox.cn/63692021f0.md): In addition to our status response codes, we have verification codes within the transaction response. - Merchants [3DSecure](https://rl3l4f0v16.apifox.cn/63691998f0.md): 3DSecure (3DS) is a fraud prevention security protocol that allows consumers to shop online more securely. It works by verifying that the consumer entering the credit card information on an e-commerce site is the owner or person authorized to use that credit card. How this works depends on which version of the 3DS protocol is being used. Using 3DS can provide you with chargeback protection and lower interchange rates. - Merchants > 3DSecure [Version](https://rl3l4f0v16.apifox.cn/63692022f0.md): StartFragment - Merchants > 3DSecure [Create](https://rl3l4f0v16.apifox.cn/63692023f0.md): This will initiate the 3DS process and `id`, `version` and `iframe` will be presented in the response. - Merchants > 3DSecure [Check](https://rl3l4f0v16.apifox.cn/63692024f0.md): For 3DS v1.0 this will return the `status` for the specific `id`. - Merchants > 3DSecure [Test Cards](https://rl3l4f0v16.apifox.cn/63692025f0.md): We offer you test cards for the sandbox environment so you can confirm your integration works before using real card data. - Merchants [Account Updater](https://rl3l4f0v16.apifox.cn/63691999f0.md): Account Updater is a feature that automatically requests updates for tokenized cards on file in the event that a customer's card expires or is replaced. This will help you avoid or reduce billing issues. - Merchants > Account Updater [Card Compatibility](https://rl3l4f0v16.apifox.cn/63692026f0.md): Whether a card can be updated using Account Updater is solely dependent on the customer's issuing bank and that bank's participation in this service. Sometimes even if the customer's card is compatible, it might not be eligible for automatic updates if the issuing bank does not participate. - Merchants > Account Updater [How It Works](https://rl3l4f0v16.apifox.cn/63692027f0.md): Account Updater works on a transaction level whether you initiate a **Sale**, **Auth**, or **Return**. The card needs to be tokenized, the `card.save` need to be `Yes` first, and then all future transactions are going to be checked for card updates, if any. In the event that the card has been updated, we will automatically charge the new card and will return the new details in the `card` object along with some additional status details. - Merchants [ACH Payments](https://rl3l4f0v16.apifox.cn/63692000f0.md): The Automated Clearing House (**ACH**) is an electronic funds-transfer system that facilitates payments in the U.S. The ACH is run by the National Automated Clearing House Association (**NACHA**). - Merchants > ACH Payments [General Information](https://rl3l4f0v16.apifox.cn/63692028f0.md): We offer a secure, streamlined ACH payment processing system. This endpoint enables you to make secure bank-to-bank transfers. We offer one-time and recurring ACH payments for various payment scenarios including corporate, consumer, telephone, and web payments. - Merchants > ACH Payments > Transactions [SEC Codes](https://rl3l4f0v16.apifox.cn/63692036f0.md): Standard Entry Class (SEC) code is a three letter code that describes how a customer or business authorized an ACH transaction. - Merchants > ACH Payments > Transactions [Statuses](https://rl3l4f0v16.apifox.cn/63692037f0.md): When you have successfully created an ACH Transaction, it will be given one of the following statuses, depending on the case. - Merchants > ACH Payments > Transactions [Actions](https://rl3l4f0v16.apifox.cn/63692038f0.md): Actions give you the possibility to update your ACH records in specific statuses. - Merchants > ACH Payments > Transactions [History Log](https://rl3l4f0v16.apifox.cn/63692039f0.md): Utilizing this endpoint you can see the full history log of an ACH transaction record. - Merchants > ACH Payments [Hosted Form](https://rl3l4f0v16.apifox.cn/63692030f0.md): With our ACH embedded hosted form functionality you can achieve quick, efficient and secure online transactions. - Merchants > ACH Payments [Customers](https://rl3l4f0v16.apifox.cn/63692031f0.md): Use this endpoint to store customer information in your dashboard for quick ACH payment management. - Merchants > ACH Payments [Customer Accounts](https://rl3l4f0v16.apifox.cn/63692032f0.md): Account Object - Merchants > ACH Payments [Bank Information](https://rl3l4f0v16.apifox.cn/63692033f0.md): Utilizing this endpoing you can view/verify the bank inforamtion associated with an ABA/Routing Number. - Merchants > ACH Payments [ACH Settlements](https://rl3l4f0v16.apifox.cn/63692034f0.md): Utilizing this endpoint you can view your ACH settlement details - Merchants > ACH Payments [ACH Webhooks](https://rl3l4f0v16.apifox.cn/63692035f0.md): All the ACH group of events you can subscribe to. - Merchants > ACH Payments > ACH Webhooks [New ACH Record](https://rl3l4f0v16.apifox.cn/63692040f0.md): Notification when a new ACH record is created. - Merchants > ACH Payments > ACH Webhooks [ACH Status Update](https://rl3l4f0v16.apifox.cn/63692041f0.md): Notification when an ACH status is updated. - Merchants > ACH Payments > ACH Webhooks [New ACH Customer](https://rl3l4f0v16.apifox.cn/63692042f0.md): Notification when a new ACH Customer has been successfully added. - Merchants [Reporting](https://rl3l4f0v16.apifox.cn/63692001f0.md): You can use this endpoint for all the available reports through our API. - Merchants > Reporting [Sandbox](https://rl3l4f0v16.apifox.cn/63692043f0.md): **IMPORTANT** Please be aware the reporting section URL is different than what is referenced above in the merchant section of this documentation. Please ensure to use the correct URL endpoint for reporting as shown below. - Merchants > Reporting [Authorizations](https://rl3l4f0v16.apifox.cn/63692044f0.md): Returns a list of all authorizations for a specific `dba.id` - Merchants > Reporting [Batches](https://rl3l4f0v16.apifox.cn/63692045f0.md): View batches for a specific `dbaId`. You can view the full batch summary for a specific date or ID and also all the transactions that are included in that batch. - Merchants > Reporting [Payouts](https://rl3l4f0v16.apifox.cn/63692046f0.md): You can utilize this endpoint to list all payout information for a specific `dba.Id` - Merchants > Reporting [Chargebacks](https://rl3l4f0v16.apifox.cn/63692047f0.md): You can use this endpoint to manage all chargeback-related information. - Merchants > Reporting > Chargebacks [Disputes](https://rl3l4f0v16.apifox.cn/63692053f0.md): By utilizing this endpoint you can dispute specific chargeback cases. - Merchants > Reporting > Chargebacks [Webhooks](https://rl3l4f0v16.apifox.cn/63692054f0.md): Use webhooks to be notified about events that happen in your account. - Merchants > Reporting > Chargebacks > Webhooks [Signatures](https://rl3l4f0v16.apifox.cn/63692056f0.md): We sign the webhook events that are sent to your endpoints. We do so by including a signature in each event's `Webhook-Signature` header. This allows you to verify that the events were sent by us, not by a third party. - Merchants > Reporting > Chargebacks > Webhooks [Events](https://rl3l4f0v16.apifox.cn/63692057f0.md): Groups of events you can subscribe to. - Merchants > Reporting > Chargebacks > Webhooks > Events [Chargeback](https://rl3l4f0v16.apifox.cn/63692058f0.md): Chargeback group of events you can subscribe to. - Merchants > Reporting > Chargebacks > Webhooks > Events > Chargeback [New Chargeback Record](https://rl3l4f0v16.apifox.cn/63692059f0.md): Notification when a new Chargeback record is created. - Merchants > Reporting > Chargebacks > Webhooks > Events > Chargeback [Chargeback Update](https://rl3l4f0v16.apifox.cn/63692060f0.md): Notification when a Chargeback is updated. - Merchants > Reporting [Reserve](https://rl3l4f0v16.apifox.cn/63692049f0.md): You can use this endpoint to view reserve activity for a specific `dba.id` - Merchants > Reporting [Fraud Report](https://rl3l4f0v16.apifox.cn/63692050f0.md): At the end of each month, we create a customized and highly detailed fraud report for each merchant. To download it use the following endpoint by providing the `dbaId` and `date` for the desired fraud report pdf. - Merchants > Reporting [Visa Verifi](https://rl3l4f0v16.apifox.cn/63692051f0.md): **PRODUCT SUMMARY** - Merchants > Reporting > Visa Verifi [Submiting External Transactions](https://rl3l4f0v16.apifox.cn/63692061f0.md): If you are not utilizing our payment gateway services and still wish to participate in the Visa Verifi program you can do so by sending us all of your transactions and the corresponding necessary information. To do so you can utilize this endpoint and leverage our systems to do the rest automatically. The transactions that you submit will become available for lookup through the Visa Verifi program. - Merchants > Reporting [Other Reports](https://rl3l4f0v16.apifox.cn/63692052f0.md): Based on the reports that are available to you, you can utilize this endpoint to export data-intensive reports from our system. - Merchants [Gateway Test Cards](https://rl3l4f0v16.apifox.cn/63692002f0.md): We offer you test cards for the sandbox environment so you can confirm your integration works before using real card data. - [Platforms](https://rl3l4f0v16.apifox.cn/63691984f0.md): Platforms represent different types of partners, such as resellers and third-party solution providers, utilzing our platform for mutual merchants. Board your merchants, view reporting, receive webhooks for important updates, process payments on behalf of, and perform other valuable functions to offer a more integrated and seamless payment experience by leveraging our dashboard and infrastructure. - Platforms [Onboarding](https://rl3l4f0v16.apifox.cn/63692063f0.md): For platforms, such as resellers which generally include ISO and ISV partners, this enables the ability to systematically onboard merchants via our API. This enables platforms to better manage the interface and experience for boarding their merchants to our system. - Platforms > Onboarding [Boarding Applications](https://rl3l4f0v16.apifox.cn/63692069f0.md): This endpoint provides an interface for working with Boarding Applications. Each application belongs to a pre-created campaign. A campaign controls several aspects of a Boarding Application, such as pricing fees, the type of processing and several other parameters. - Platforms > Onboarding > Boarding Applications [Campaigns](https://rl3l4f0v16.apifox.cn/63692074f0.md): A Boarding Application always starts by choosing a campaign and `processingMethod`. We have two main types of campaigns `Standard` or `Other`. - Platforms > Onboarding > Boarding Applications [Equipment](https://rl3l4f0v16.apifox.cn/63692075f0.md): You can utilize this endpoint to perform several operations in the Equipment section of the Boarding Application - Platforms > Onboarding > Boarding Applications > Equipment [Terminals](https://rl3l4f0v16.apifox.cn/63692094f0.md): When creating a boarding application we give you the ability to add existing terminals. - Platforms > Onboarding > Boarding Applications [List](https://rl3l4f0v16.apifox.cn/63692076f0.md): Use this endpoint to list all Boarding Applications that you have available. - Platforms > Onboarding > Boarding Applications [Create](https://rl3l4f0v16.apifox.cn/63692077f0.md): An application needs to be created first before proceeding to updating with the necessary fields. We have 3 types of Boarding Applications based on the processing type that the merchant is applying for. - Platforms > Onboarding > Boarding Applications [Delete](https://rl3l4f0v16.apifox.cn/63692078f0.md): You can use this endpoint to Delete a boarding application. - Platforms > Onboarding > Boarding Applications [View](https://rl3l4f0v16.apifox.cn/63692079f0.md): You can either view the full Boarding Application or only a specific section. - Platforms > Onboarding > Boarding Applications [Update](https://rl3l4f0v16.apifox.cn/63692080f0.md): For testing purposes, please use our sandbox endpoint below. - Platforms > Onboarding > Boarding Applications [Principals](https://rl3l4f0v16.apifox.cn/63692081f0.md): You can use this endpoint to execute all necessary operations in the Principals section of the Boarding Application. You can do the following: - Platforms > Onboarding > Boarding Applications [Processing](https://rl3l4f0v16.apifox.cn/63692082f0.md): You can use this endpoint to execute all necessary operations in the Processing section of the Boarding Application. You can do the following: - Platforms > Onboarding > Boarding Applications [Merchant Category Codes (MCCs)](https://rl3l4f0v16.apifox.cn/63692083f0.md): In the finance ecosystem, Merchant Category Codes (also known as MCCs) are used to classify businesses by the type of products or services they provide. - Platforms > Onboarding > Boarding Applications [ACH](https://rl3l4f0v16.apifox.cn/63692084f0.md): You can use this endpoint to execute all necessary operations in the ACH section of the Boarding Application. You can do the following: - Platforms > Onboarding > Boarding Applications [Documents](https://rl3l4f0v16.apifox.cn/63692085f0.md): This endpoint is used for all the supporting documents on a Boarding Application. There are several things to consider with documents on a Boarding Application. - Platforms > Onboarding > Boarding Applications > Documents [Attachment About](https://rl3l4f0v16.apifox.cn/63692095f0.md): The Attachment-about endpoint is used for the categorization of all the supporting documents that can be assigned to a Boarding Application. We have a list of several categories that are used to tell us what the document on a Boarding Application contains. - Platforms > Onboarding > Boarding Applications [Fees](https://rl3l4f0v16.apifox.cn/63692086f0.md): You can use this endpoint to execute all necessary operations in the Fee section of the Boarding Application. You can do the following: - Platforms > Onboarding > Boarding Applications > Fees [Types](https://rl3l4f0v16.apifox.cn/63692096f0.md): Use this endpoint to list all the system fee types with their corresponding detailed information. - Platforms > Onboarding > Boarding Applications > Fees [Other Fees](https://rl3l4f0v16.apifox.cn/63692097f0.md): Other Fee Object - Platforms > Onboarding > Boarding Applications [Bank Accounts](https://rl3l4f0v16.apifox.cn/63692087f0.md): > Multiple Bank Accounts are supported only for Acquiring Boarding Applications - Platforms > Onboarding > Boarding Applications [Validate](https://rl3l4f0v16.apifox.cn/63692088f0.md): Use this endpoint to validate your Boarding Application before changing the `status` to Underwriting. - Platforms > Onboarding > Boarding Applications [URL](https://rl3l4f0v16.apifox.cn/63692089f0.md): You can get the Boarding Application URL to send out for merchant completion via our online web interface form. - Platforms > Onboarding > Boarding Applications [Signature](https://rl3l4f0v16.apifox.cn/63692090f0.md): An application needs to be completed with a signature(s) before you can send it to Underwriting for approval and boarding. - Platforms > Onboarding > Boarding Applications > Signature [Request E-sign](https://rl3l4f0v16.apifox.cn/63692098f0.md): When manually requesting e-signing we initiate an email to all the principals on the application with a link to our online eSign section. - Platforms > Onboarding > Boarding Applications > Signature [Embed E-sign](https://rl3l4f0v16.apifox.cn/63692099f0.md): You can use this functionality to embed our proprietary e-sign in your workflow. - Platforms > Onboarding > Boarding Applications > Signature > Embed E-sign [Embeded E-sign Example Flow 1](https://rl3l4f0v16.apifox.cn/63692102f0.md): In the below flow, we will show you how to initiate the popup module and perform a callback function with a redirect once the application is signed. - Platforms > Onboarding > Boarding Applications > Signature > Embed E-sign [Embeded E-sign Example Flow 2](https://rl3l4f0v16.apifox.cn/63692103f0.md): In the below flow, we will show you how to initiate a popup module window and close it after you get an e-sign event. - Platforms > Onboarding > Boarding Applications > Signature [Manually Signing](https://rl3l4f0v16.apifox.cn/63692100f0.md): An application can be manually signed via the API. Before sending a manual signing request, the signed PDF must be uploaded to the system via the **\[Attachment Temporary Upload-API\]** - Platforms > Onboarding > Boarding Applications > Signature [External eSign Signing](https://rl3l4f0v16.apifox.cn/63692101f0.md): An application can be signed with an external e-Signature via the API. Before sending the signing request, you need to upload the externally signed PDF via the **\[Attachment Temporary Upload-API\]** - Platforms > Onboarding > Boarding Applications [Automation](https://rl3l4f0v16.apifox.cn/63692091f0.md): We offer Boarding Application automation to streamline some of the processes where needed. At this point there are two options, **AutoSign** and **AutoUnderwriting**. - Platforms > Onboarding > Boarding Applications > Automation [AutoSign](https://rl3l4f0v16.apifox.cn/63692104f0.md): Enabling this option will trigger the eSign section of the online application after all the required fields from the other sections have been completed. - Platforms > Onboarding > Boarding Applications > Automation [AutoUnderwriting](https://rl3l4f0v16.apifox.cn/63692105f0.md): Enabling this option will trigger the eSign section of the online Boarding Application and after the application is signed its status will automatically change to **Underwriting**. - Platforms > Onboarding > Boarding Applications [Status](https://rl3l4f0v16.apifox.cn/63692092f0.md): In order to initiate the approval process of a Boarding Application its status needs to be changed to Underwriting. - Platforms > Onboarding > Boarding Applications [Notes](https://rl3l4f0v16.apifox.cn/63692093f0.md): By utilizing this endpoint you can read all notes associated with the Boarding Application. During the underwriting process, additional information may be requested and this is the endpoint to read all the notes from our Underwriting team. - Platforms > Onboarding [Merchants](https://rl3l4f0v16.apifox.cn/63692070f0.md): This endpoint is used to view all Merchant account related inforamtion. - Platforms > Onboarding > Merchants [Terminals](https://rl3l4f0v16.apifox.cn/63692106f0.md): By utilizing this endpoint you can read all terminal/s related information for a specific merchant. - Platforms > Onboarding [DBA](https://rl3l4f0v16.apifox.cn/63692071f0.md): This endpoint is used to view all Merchant DBA related information. - Platforms > Onboarding [Attachments](https://rl3l4f0v16.apifox.cn/63692072f0.md): This endpoint is used for the Dashboard's file system. Each attachment uploaded via this endpoint can be used in several endpoints, including but not limited to the Boarding Application, Tickets, Chargebacks and etc. - Platforms > Onboarding > Attachments [Temporary Upload](https://rl3l4f0v16.apifox.cn/63692107f0.md): You can utilize this upload for temporary attachment to the system. These attachments can be used for uploading signed boarding applications and signing certificates, which can then be provided in the external e-signing requests - Platforms > Onboarding > Attachments [Chunk Upload](https://rl3l4f0v16.apifox.cn/63692108f0.md): The chunk upload endpoints allow you to upload files larger than 16MB by uploading them into smaller chunks/parts. The overall process is as follows: - Platforms > Onboarding [Webhooks](https://rl3l4f0v16.apifox.cn/63692073f0.md): Use webhooks to be notified about events that happen in your account. - Platforms > Onboarding > Webhooks [Signatures](https://rl3l4f0v16.apifox.cn/63692109f0.md): We sign the webhook events that are sent to your endpoints. We do so by including a signature in each event's `Webhook-Signature` header. This allows you to verify that the events were sent by us, not by a third party. - Platforms > Onboarding > Webhooks [Events](https://rl3l4f0v16.apifox.cn/63692110f0.md): Groups of events you can subscribe to. - Platforms > Onboarding > Webhooks > Events [Boarding Application](https://rl3l4f0v16.apifox.cn/63692111f0.md): Notifications related to our Boarding Applications. - Platforms > Onboarding > Webhooks > Events [Merchant](https://rl3l4f0v16.apifox.cn/63692112f0.md): Merchant group of events you can subscribe to - Platforms > Onboarding > Webhooks > Events > Merchant > Account [New Acquiring Account](https://rl3l4f0v16.apifox.cn/63692115f0.md): Notification when a new Acquiring Merchant is created. - Platforms > Onboarding > Webhooks > Events > Merchant > Account [New ACH Account](https://rl3l4f0v16.apifox.cn/63692116f0.md): Notification when a new ACH Merchant is created. - Platforms > Onboarding > Webhooks > Events > Merchant > Account [Closed Acquiring Account](https://rl3l4f0v16.apifox.cn/63692117f0.md): Notification when a new ACH Merchant is created. - Platforms > Onboarding > Webhooks > Events > Merchant > Account [Closed ACH Account](https://rl3l4f0v16.apifox.cn/63692118f0.md): Notification when an ACH Merchant is closed. - Platforms > Onboarding > Webhooks > Events > Merchant [Terminal](https://rl3l4f0v16.apifox.cn/63692114f0.md): Terminal information events you can subscribe to. This webhook group is helpful when you have newly approved MIDs or if there have been updates with their terminals. - Platforms > Onboarding > Webhooks > Events > Merchant > Terminal [New Terminal Record](https://rl3l4f0v16.apifox.cn/63692119f0.md): Notification when a new Merchant terminal is created - Platforms > Onboarding > Webhooks > Events > Merchant > Terminal [Update Terminal Record](https://rl3l4f0v16.apifox.cn/63692120f0.md): Notification when a merchant terminal is updated - Platforms > Onboarding > Webhooks > Events > Merchant > Terminal [Delete Terminal Record](https://rl3l4f0v16.apifox.cn/63692121f0.md): Notification when a merchant terminal is deleted - Platforms [Reporting](https://rl3l4f0v16.apifox.cn/63692064f0.md): You can use this endpoint for all the available reports through our API. - Platforms > Reporting [Authorizations](https://rl3l4f0v16.apifox.cn/63692122f0.md): Returns a list of all authorizations for a specific `dba.id` - Platforms > Reporting [Batches](https://rl3l4f0v16.apifox.cn/63692123f0.md): View batches for a specific `dbaId`. You can view the full batch summary for a specific date or ID and also all the transactions that are included in that batch. - Platforms > Reporting [Payouts](https://rl3l4f0v16.apifox.cn/63692124f0.md): You can utilize this endpoint to list all payout information for a specific `dba.Id` - Platforms > Reporting [Chargebacks](https://rl3l4f0v16.apifox.cn/63692125f0.md): You can use this endpoint to manage all chargeback-related information. - Platforms > Reporting > Chargebacks [Disputes](https://rl3l4f0v16.apifox.cn/63692131f0.md): By utilizing this endpoint you can dispute specific chargeback cases. A merchant token must be utilized or the platform must be setup on Connect and merchant authorization provided to submit disputes. - Platforms > Reporting > Chargebacks [Webhooks](https://rl3l4f0v16.apifox.cn/63692132f0.md): Use webhooks to be notified about events that happen in your account. - Platforms > Reporting > Chargebacks > Webhooks [Signatures](https://rl3l4f0v16.apifox.cn/63692133f0.md): We sign the webhook events that are sent to your endpoints. We do so by including a signature in each event's `Webhook-Signature` header. This allows you to verify that the events were sent by us, not by a third party. - Platforms > Reporting > Chargebacks > Webhooks [Events](https://rl3l4f0v16.apifox.cn/63692134f0.md): Groups of events you can subscribe to. - Platforms > Reporting > Chargebacks > Webhooks > Events [Chargeback](https://rl3l4f0v16.apifox.cn/63692135f0.md): Chargeback group of events you can subscribe to. - Platforms > Reporting > Chargebacks > Webhooks > Events > Chargeback [New Chargeback Record](https://rl3l4f0v16.apifox.cn/63692136f0.md): Notification when a new Chargeback record is created. - Platforms > Reporting > Chargebacks > Webhooks > Events > Chargeback [Chargeback Update](https://rl3l4f0v16.apifox.cn/63692137f0.md): Notification when a Chargeback is updated. - Platforms > Reporting [Reserve](https://rl3l4f0v16.apifox.cn/63692127f0.md): You can use this endpoint to view reserve activity for a specific `dba.id` - Platforms > Reporting [Fraud Report](https://rl3l4f0v16.apifox.cn/63692128f0.md): At the end of each month, we create a customized and highly detailed fraud report for each merchant. To download it use the following endpoint by providing the `dbaId` and `date` for the desired fraud report pdf. - Platforms > Reporting [Other Reports](https://rl3l4f0v16.apifox.cn/63692129f0.md): Based on the reports that are available to you, you can utilize this endpoint to export data-intensive reports from our system. - Platforms [Residuals](https://rl3l4f0v16.apifox.cn/63692065f0.md): You can utilize this endpoint to read all of your residual data. - Platforms [Tickets](https://rl3l4f0v16.apifox.cn/63692066f0.md): You can utilize this endpoint for our ticketing system. - Platforms > Tickets [Update Ticket Status](https://rl3l4f0v16.apifox.cn/63692138f0.md): You can use this endpoint to Close an existing ticket or Re-Open a closed ticket. - Platforms > Tickets [Responses](https://rl3l4f0v16.apifox.cn/63692139f0.md): You can use this endpoint to: - Platforms > Tickets [Attachments](https://rl3l4f0v16.apifox.cn/63692140f0.md): You can use this endpoint to add an attachment to an existing ticket. - Platforms > Tickets [Categories](https://rl3l4f0v16.apifox.cn/63692141f0.md): This endpoint is used to list all the available categories under which you can open a ticket. - Platforms > Tickets [Notes](https://rl3l4f0v16.apifox.cn/63692142f0.md): You can use this endpoint for notes that are associated with a ticket. - Platforms [Connect](https://rl3l4f0v16.apifox.cn/63692067f0.md): Connect offers flexibility for certified solutions to integrate to the Merchant API and includes the most streamlined approach for mutual merchants to share their data to third-party systems. Connect allows third-parties to access reporting and perform various functions on behalf of merchants for an open payment ecosystem. - Platforms > Connect > Webhooks [Access Granted](https://rl3l4f0v16.apifox.cn/63692144f0.md): Notification when new access has been granted - Platforms > Connect > Webhooks [Access Updated](https://rl3l4f0v16.apifox.cn/63692145f0.md): Notification when modifications have been made to existing granted access - Platforms > Connect > Webhooks [Access Revoked](https://rl3l4f0v16.apifox.cn/63692146f0.md): Notification when access has been revoked. - Platforms > Misc [Address Checker](https://rl3l4f0v16.apifox.cn/63692147f0.md): We have created a zip code database to validate all the city, state, and zip code information on the application. Use this endpoint to get the necessary ids that need to be provided in the corresponding fields on the Boarding Application. - Platforms > Misc [BIN Check](https://rl3l4f0v16.apifox.cn/63692148f0.md): You can use this endpoint to get detailed information on a BIN ## API Docs - General Information > Filters [Example - gte](https://rl3l4f0v16.apifox.cn/333697170e0.md): Find all records created after `2023-01-01 00:00:00` - General Information > Filters [Example - between](https://rl3l4f0v16.apifox.cn/333697171e0.md): Find all records created between `2019-01-01 00:00:00` and `2019-01-01 23:59:59` - General Information > Filters [Example - like](https://rl3l4f0v16.apifox.cn/333697172e0.md): Find all records whose email contains `example.com` - General Information > Filters [Example - in](https://rl3l4f0v16.apifox.cn/333697173e0.md): Find all records with IDs `1` or `2` - General Information > Filters [Example - non-empty](https://rl3l4f0v16.apifox.cn/333697174e0.md): Find all records with ID with non-empty values (ie. NOT NULL) - General Information > Pagination [10 results per page](https://rl3l4f0v16.apifox.cn/333697175e0.md): - Merchants > Sandbox [Sandbox Payment Gateway](https://rl3l4f0v16.apifox.cn/333697176e0.md): For testing purposes, please use our sandbox endpoint. - Merchants > Card Payments [Authorization](https://rl3l4f0v16.apifox.cn/333697177e0.md): The Auth method initializes an authorization-only transaction. Authorization-only transactions are not included in the batch for settlement. - Merchants > Card Payments [Sale](https://rl3l4f0v16.apifox.cn/333697178e0.md): The Sale method creates a new authorization and a capture request by default. - Merchants > Card Payments [Capture](https://rl3l4f0v16.apifox.cn/333697179e0.md): The capture method marks an Auth transaction for settlement, therefore the transaction ID is needed. This method also allows adjustments of the transaction amount. - Merchants > Card Payments [Partial Capture](https://rl3l4f0v16.apifox.cn/333697180e0.md): We provide the functionality to create partial captures. - Merchants > Card Payments [Refund](https://rl3l4f0v16.apifox.cn/333697181e0.md): The refund method is used to refund/void an authorized or settled transaction. This method will void or reverse the transaction based on the card network. - Merchants > Card Payments [Partial Refund](https://rl3l4f0v16.apifox.cn/333697182e0.md): You are allowed to perform a partial refund by providing a lower `amount` than the original captured transaction if no `amount` is provided the transaction will be fully refunded. You need to provide any discount and tax amount that was in the original transaction to perform a partial refund. - Merchants > Card Payments [Soft/Dynamic Descriptor](https://rl3l4f0v16.apifox.cn/333697183e0.md): Soft Descriptor or Dynamic Descriptor functionality gives you the ability to modify the statement descriptor on a per-transaction basis. Using this feature, you gain the ability to change this information according to your discretion and needs. - Merchants > Card Payments [Card Authentication](https://rl3l4f0v16.apifox.cn/333697184e0.md): The Card authentication method supports a zero-dollar authorization. This way you can check that the credit card is valid, and if needed that the card has enough funds on it for the transaction. This type of authorization does not hold any funds on the cardholder account. - Merchants > Card Payments [Card Tokenization](https://rl3l4f0v16.apifox.cn/333697185e0.md): Tokenization is the process of exchanging sensitive card data with a unique token without compromising its security when you desire to use this card for **future payments**. A token is up to 64-digit characters. - Merchants > Card Payments [Card Tokenization with Global Token](https://rl3l4f0v16.apifox.cn/333697186e0.md): Currently we support two types of card tokens. Regular tokens and \`Global Tokens\`. The difference between the regular and the global token is that the regular token **can only be used on the terminal on which the card was tokenized** whereas the Global Token can be used across all of your terminals. - Merchants > Card Payments [Sale with a Fee Terminal](https://rl3l4f0v16.apifox.cn/333697187e0.md): In some cases, there can be 2 terminals involved in one transaction. We call this functionality a Fee Terminal. - Merchants > Hosted Form [Generate](https://rl3l4f0v16.apifox.cn/333697188e0.md): - Merchants > Hosted Form [Generate with Billing and Contact Information](https://rl3l4f0v16.apifox.cn/333697189e0.md): - Merchants > Hosted Fields > Hosted Fields Token [Hosted Fields Token](https://rl3l4f0v16.apifox.cn/333697190e0.md): Supported Parameters: - Merchants > Hosted Fields > Integration Guide > Step 6: Get the tokenized card [Get the tokenized card](https://rl3l4f0v16.apifox.cn/333697191e0.md): > You need to perform this call before your `Hosted Fields Token` expires. - Merchants > CustomerVault > Sandbox [Sandbox Dashboard](https://rl3l4f0v16.apifox.cn/333697192e0.md): For testing purposes, please use our sandbox endpoint. - Merchants > CustomerVault > Hosted Card Form [Generate](https://rl3l4f0v16.apifox.cn/333697193e0.md): - Merchants > CustomerVault > Customers [List](https://rl3l4f0v16.apifox.cn/333697194e0.md): List all of your customers - Merchants > CustomerVault > Customers [View](https://rl3l4f0v16.apifox.cn/333697195e0.md): Use this endpoint to view information for a specific customer. - Merchants > CustomerVault > Customers [Create](https://rl3l4f0v16.apifox.cn/333697196e0.md): Creating a Customer can be achieved using this endpoint - Merchants > CustomerVault > Customers [Update](https://rl3l4f0v16.apifox.cn/333697197e0.md): The update endpoint is used to modify the customer's information in the Customer Vault. You can modify personal details and company information of the customer in the vault. - Merchants > CustomerVault > Customers [Archive](https://rl3l4f0v16.apifox.cn/333697198e0.md): When a specific customer in the vault has transactional history, that customer cannot be deleted. In this case, the customer needs to be archived. - Merchants > CustomerVault > Customers [Delete](https://rl3l4f0v16.apifox.cn/333697199e0.md): If a specific customer in the vault has no transactional history your can delete the customer using this endpoint. - Merchants > CustomerVault > Cards [List Cards](https://rl3l4f0v16.apifox.cn/333697200e0.md): List all stored payment information for a customer. This will return an object of all the stored payment card records on file for a specific customer in the vault. - Merchants > CustomerVault > Cards [View](https://rl3l4f0v16.apifox.cn/333697201e0.md): To view a single card record for a specific customer use the following: - Merchants > CustomerVault > Cards [Add Card](https://rl3l4f0v16.apifox.cn/333697202e0.md): - Merchants > CustomerVault > Cards [Update Exp Date](https://rl3l4f0v16.apifox.cn/333697203e0.md): You can utilize this endpoint to update/change the expiration date of a stored and tokenized card in the Customer vault - Merchants > CustomerVault > Cards [Archive](https://rl3l4f0v16.apifox.cn/333697204e0.md): If a specific payment card record is present in the transactional history of a customer we do not allow for it to be deleted. In this case, you can archive the payment card information record. - Merchants > CustomerVault > Cards [Unarchive](https://rl3l4f0v16.apifox.cn/333697205e0.md): If you want to return an archived card to an active status use the following: - Merchants > CustomerVault > Cards [Delete](https://rl3l4f0v16.apifox.cn/333697206e0.md): If a specific payment card is not present in the transactional history of a customer you can delete it. - Merchants > CustomerVault > Billing Information [List](https://rl3l4f0v16.apifox.cn/333697207e0.md): This will return an object of all the billing information records on file for a specific customer in the vault. - Merchants > CustomerVault > Billing Information [View](https://rl3l4f0v16.apifox.cn/333697208e0.md): Use this endpoint to view a single billing record for a specific customer - Merchants > CustomerVault > Billing Information [Update](https://rl3l4f0v16.apifox.cn/333697209e0.md): - Merchants > CustomerVault > Billing Information [Create](https://rl3l4f0v16.apifox.cn/333697210e0.md): - Merchants > CustomerVault > Shipping Information [List](https://rl3l4f0v16.apifox.cn/333697211e0.md): - Merchants > CustomerVault > Shipping Information [View](https://rl3l4f0v16.apifox.cn/333697212e0.md): - Merchants > CustomerVault > Shipping Information [Update](https://rl3l4f0v16.apifox.cn/333697213e0.md): - Merchants > CustomerVault > Shipping Information [Create](https://rl3l4f0v16.apifox.cn/333697214e0.md): - Merchants > CustomerVault > Recurring Payment [List](https://rl3l4f0v16.apifox.cn/333697215e0.md): - Merchants > CustomerVault > Recurring Payment [View](https://rl3l4f0v16.apifox.cn/333697216e0.md): - Merchants > CustomerVault > Recurring Payment [Update](https://rl3l4f0v16.apifox.cn/333697217e0.md): - Merchants > CustomerVault > Recurring Payment [Create](https://rl3l4f0v16.apifox.cn/333697218e0.md): - Merchants > Transaction Reporting [List](https://rl3l4f0v16.apifox.cn/333697219e0.md): Transaction Reporting Object - Merchants > Transaction Reporting [View](https://rl3l4f0v16.apifox.cn/333697220e0.md): Use this endpoint to view information for a specific transaction record. - Merchants > 3DSecure > Create [Create](https://rl3l4f0v16.apifox.cn/333697221e0.md): - Merchants > 3DSecure > Check [Check](https://rl3l4f0v16.apifox.cn/333697222e0.md): - Merchants > Account Updater > How It Works [Sale with Account Updater](https://rl3l4f0v16.apifox.cn/333697223e0.md): - Merchants > ACH Payments > Transactions > Actions [Action](https://rl3l4f0v16.apifox.cn/333697231e0.md): - Merchants > ACH Payments > Transactions > History Log [Log](https://rl3l4f0v16.apifox.cn/333697232e0.md): - Merchants > ACH Payments > Transactions [List](https://rl3l4f0v16.apifox.cn/333697224e0.md): Use this endpoint to list all ACH transactions in your dashboard. - Merchants > ACH Payments > Transactions [View](https://rl3l4f0v16.apifox.cn/333697225e0.md): View specific ACH transaction records. - Merchants > ACH Payments > Transactions [Create ACH](https://rl3l4f0v16.apifox.cn/333697226e0.md): Use this endpoint to create ACH Transactions. - Merchants > ACH Payments > Transactions [Create ACH & Save Customer](https://rl3l4f0v16.apifox.cn/333697227e0.md): When creating a new ACH transaction record you have the ability to save the customer and payment information to your [ACH Customers](#15fc62a7-afdb-43bf-a8c1-ed7fddc475ff) for future payments. In order to do this you need to pass the `customer.save` as `Yes`. - Merchants > ACH Payments > Transactions [Create ACH for an existing Customer](https://rl3l4f0v16.apifox.cn/333697228e0.md): An example request with an existing customer in the Customer Vault. Keep in mind that these are the minimum required parameters. Feel free to add any additional parameters as needed. - Merchants > ACH Payments > Transactions [Create ACH for an existing Customer and specific Account](https://rl3l4f0v16.apifox.cn/333697229e0.md): An example request with an existing customer account in the Customer Vault. - Merchants > ACH Payments > Transactions [Remove](https://rl3l4f0v16.apifox.cn/333697230e0.md): A transaction can be deleted if there is no status set to it from our system. - Merchants > ACH Payments > Hosted Form [Example Request](https://rl3l4f0v16.apifox.cn/333697233e0.md): - Merchants > ACH Payments > Customers [List Customers](https://rl3l4f0v16.apifox.cn/333697234e0.md): - Merchants > ACH Payments > Customers [View specific Customer](https://rl3l4f0v16.apifox.cn/333697235e0.md): - Merchants > ACH Payments > Customers [Create Customer](https://rl3l4f0v16.apifox.cn/333697236e0.md): - Merchants > ACH Payments > Customers [Update Customer](https://rl3l4f0v16.apifox.cn/333697237e0.md): - Merchants > ACH Payments > Customers [Delete a Customer](https://rl3l4f0v16.apifox.cn/333697238e0.md): - Merchants > ACH Payments > Customer Accounts [List Customer Accounts](https://rl3l4f0v16.apifox.cn/333697239e0.md): - Merchants > ACH Payments > Customer Accounts [Create Customer Account](https://rl3l4f0v16.apifox.cn/333697240e0.md): - Merchants > ACH Payments > Customer Accounts [Update Customer Account](https://rl3l4f0v16.apifox.cn/333697241e0.md): - Merchants > ACH Payments > Customer Accounts [Delete a Customer Account](https://rl3l4f0v16.apifox.cn/333697242e0.md): - Merchants > ACH Payments > Bank Information [View](https://rl3l4f0v16.apifox.cn/333697243e0.md): - Merchants > ACH Payments > ACH Settlements [List](https://rl3l4f0v16.apifox.cn/333697244e0.md): List settlements for a specific `dba.id` - Merchants > ACH Payments > ACH Settlements [View](https://rl3l4f0v16.apifox.cn/333697245e0.md): Get settlement details for the given `dba.id` and `settlement.id` - Merchants > Reporting > Sandbox [Sandbox Dashboard](https://rl3l4f0v16.apifox.cn/333697246e0.md): For testing purposes, please use our sandbox endpoint. - Merchants > Reporting > Authorizations [List](https://rl3l4f0v16.apifox.cn/333697247e0.md): > **IMPORTANT** If no `date` is specified in the request as a filter we will return authorizations for the last 5 days from the current date. - Merchants > Reporting > Authorizations [List with Filters](https://rl3l4f0v16.apifox.cn/333697248e0.md): Example request to list all authorizations for a specific `dbaId`, `card.bin.brand.visa` and `terminal.number` between a date range - Merchants > Reporting > Batches [List](https://rl3l4f0v16.apifox.cn/333697249e0.md): Use this endpoint to list all the batches for a specific `dba.id` - Merchants > Reporting > Batches [List with Filters](https://rl3l4f0v16.apifox.cn/333697250e0.md): Example request to list all the transactions the are included in a batch for a specific date - Merchants > Reporting > Batches [Summary](https://rl3l4f0v16.apifox.cn/333697251e0.md): - Merchants > Reporting > Payouts [List](https://rl3l4f0v16.apifox.cn/333697252e0.md): > **NOTE** Keep in mind that running this request without specifying a processingDate filter will return all available records for the current month - Merchants > Reporting > Payouts [View](https://rl3l4f0v16.apifox.cn/333697253e0.md): View detailed payout information for a specific date - Merchants > Reporting > Payouts [Export](https://rl3l4f0v16.apifox.cn/333697254e0.md): - Merchants > Reporting > Chargebacks > Disputes [Upload a temporary file](https://rl3l4f0v16.apifox.cn/333697255e0.md): In order to upload a temporary file and submit a dispute to a chargeback case you need to utilize our standard Attachments endpoint and pass an additional URL parameter `temporary` - Merchants > Reporting > Chargebacks > Disputes [Create a Dispute](https://rl3l4f0v16.apifox.cn/333697256e0.md): After uploading the file/files you need to create the dispute by assigning all the temporary `attachment.id` to the `case.id`. - Merchants > Reporting > Chargebacks > Disputes [Preview](https://rl3l4f0v16.apifox.cn/333697257e0.md): Use this endpoint if you want to preview your dispute before submitting it. - Merchants > Reporting > Chargebacks > Disputes [Submit](https://rl3l4f0v16.apifox.cn/333697258e0.md): Use this endpoint to submit your dispute - Merchants > Reporting > Chargebacks > View [List](https://rl3l4f0v16.apifox.cn/333697259e0.md): You can utilize this endpoint to list all chargebacks - Merchants > Reporting > Chargebacks > View [View](https://rl3l4f0v16.apifox.cn/333697260e0.md): By utilizing this endpoint you can view detailed information for a specific chargeback - Merchants > Reporting > Statements [List](https://rl3l4f0v16.apifox.cn/333697261e0.md): - Merchants > Reporting > Statements [Download](https://rl3l4f0v16.apifox.cn/333697262e0.md): To download a specific statement, use its corresponding `id`. All the statements are in pdf format. - Merchants > Reporting > Reserve [List](https://rl3l4f0v16.apifox.cn/333697263e0.md): - Merchants > Reporting > Fraud Report [Generate](https://rl3l4f0v16.apifox.cn/333697264e0.md): - Merchants > Reporting > Visa Verifi > Submiting External Transactions [Submit](https://rl3l4f0v16.apifox.cn/333697266e0.md): | Fields | Description | Type | Filterable | Required | - Merchants > Reporting > Visa Verifi [List](https://rl3l4f0v16.apifox.cn/333697265e0.md): You can utilize this endpoint to list all Visa Verifi requests either as OrderInsight or Compelling evidence - Merchants > Reporting > Other Reports [Request a Report](https://rl3l4f0v16.apifox.cn/333697267e0.md): - Merchants > Reporting > Other Reports [Check Status](https://rl3l4f0v16.apifox.cn/333697268e0.md): Use this endpoint to check the status of a specific requested report. - Merchants > Reporting > Other Reports [Download](https://rl3l4f0v16.apifox.cn/333697269e0.md): After checking the status of a requested report and when it is ready to be downloaded, you can utilize this endpoint. - Platforms > Sandbox [Sandbox Dashboard](https://rl3l4f0v16.apifox.cn/333697270e0.md): For testing purposes, please use our sandbox endpoint. - Platforms > Onboarding > Boarding Applications > Campaigns [List](https://rl3l4f0v16.apifox.cn/333697271e0.md): Use this endpoint to list all Campaigns - Platforms > Onboarding > Boarding Applications > Equipment > Terminals [List](https://rl3l4f0v16.apifox.cn/333697274e0.md): List all terminals that have been added to a Boarding Application. These terminals will be sent to the merchant when the application is approved. - Platforms > Onboarding > Boarding Applications > Equipment > Terminals [View](https://rl3l4f0v16.apifox.cn/333697275e0.md): View a specific Terminal in the Equipment section of the Boarding Application - Platforms > Onboarding > Boarding Applications > Equipment [View](https://rl3l4f0v16.apifox.cn/333697272e0.md): Use this endpoint to view the equipment settings on a Boarding Application. - Platforms > Onboarding > Boarding Applications > Equipment [Update](https://rl3l4f0v16.apifox.cn/333697273e0.md): Use this endpoint the update the equipment section of a Boarding Application - Platforms > Onboarding > Boarding Applications > List [List Boarding Applications](https://rl3l4f0v16.apifox.cn/333697276e0.md): - Platforms > Onboarding > Boarding Applications > Create [Create Boarding Application](https://rl3l4f0v16.apifox.cn/333697277e0.md): Creating an Acquiring Boarding Application from a standard Campaign with `ID` 206 as an example. - Platforms > Onboarding > Boarding Applications > Delete [Delete Boarding Application](https://rl3l4f0v16.apifox.cn/333697278e0.md): - Platforms > Onboarding > Boarding Applications > View [View Boarding Application](https://rl3l4f0v16.apifox.cn/333697279e0.md): You can utilize this endpoint for viewing the full Boarding Application - Platforms > Onboarding > Boarding Applications > Update [Update Boarding Application](https://rl3l4f0v16.apifox.cn/333697280e0.md): In the below example, we are updating only the `company.name` of the Boarding Application. - Platforms > Onboarding > Boarding Applications > Principals [List Principals](https://rl3l4f0v16.apifox.cn/333697281e0.md): List all Principals for Boarding Application 608. - Platforms > Onboarding > Boarding Applications > Principals [Create Principal](https://rl3l4f0v16.apifox.cn/333697282e0.md): Add a second Principal to Boarding Application 608 - Platforms > Onboarding > Boarding Applications > Principals [Update a Single Principal](https://rl3l4f0v16.apifox.cn/333697283e0.md): You can utilize this endpoint to update information on a single principal in the Principals section of the Boarding Application. - Platforms > Onboarding > Boarding Applications > Principals [Mass update Principals](https://rl3l4f0v16.apifox.cn/333697284e0.md): You can utilize this endpoint to mass add, update or delete principal information. - Platforms > Onboarding > Boarding Applications > Principals [Delete Principal](https://rl3l4f0v16.apifox.cn/333697285e0.md): Delete Principal with `id` 741 for Boarding Application 607. - Platforms > Onboarding > Boarding Applications > Processing [View Processing section](https://rl3l4f0v16.apifox.cn/333697286e0.md): You can use this endpoint to view the necessary information in the Processing section of the Boarding Application. - Platforms > Onboarding > Boarding Applications > Processing [Update Processing section](https://rl3l4f0v16.apifox.cn/333697287e0.md): You can use this endpoint to update the necessary information in the Processing section of the Boarding Application. - Platforms > Onboarding > Boarding Applications > Merchant Category Codes (MCCs) [List MCCs](https://rl3l4f0v16.apifox.cn/333697288e0.md): - Platforms > Onboarding > Boarding Applications > ACH [View ACH section](https://rl3l4f0v16.apifox.cn/333697289e0.md): You can use this endpoint to view the necessary information in the ACH section of the Boarding Application. - Platforms > Onboarding > Boarding Applications > ACH [Update ACH section](https://rl3l4f0v16.apifox.cn/333697290e0.md): You can use this endpoint to update the necessary information in the ACH section of the Boarding Application. - Platforms > Onboarding > Boarding Applications > Documents > Attachment About [List All Document Categories](https://rl3l4f0v16.apifox.cn/333697297e0.md): **Note:** Keep in mind that the `about.id` differs from our Sandbox and Production environments. Please ensure to use and assign the correct `about.id` with their corresponding environment. - Platforms > Onboarding > Boarding Applications > Documents [View all documents](https://rl3l4f0v16.apifox.cn/333697291e0.md): You can utilize this endpoint to list all uploaded documents to a boarding application. - Platforms > Onboarding > Boarding Applications > Documents [MPA](https://rl3l4f0v16.apifox.cn/333697292e0.md): Once a boarding application has been signed, you can utilize this endpoint to download the merchant agreement. - Platforms > Onboarding > Boarding Applications > Documents [Assign a single document](https://rl3l4f0v16.apifox.cn/333697293e0.md): In this example, we will add one document and categorize it by adding to it `about.id` \[1,2\] for "Other" and "Voided Check" - Platforms > Onboarding > Boarding Applications > Documents [Assign multiple documents](https://rl3l4f0v16.apifox.cn/333697294e0.md): In this example, we will add - Platforms > Onboarding > Boarding Applications > Documents [Update a single document](https://rl3l4f0v16.apifox.cn/333697295e0.md): In this example, we will update the `about.id` for document with `id`1916 - Platforms > Onboarding > Boarding Applications > Documents [Delete a single document](https://rl3l4f0v16.apifox.cn/333697296e0.md): In this example, we will delete document with `id`1916 - Platforms > Onboarding > Boarding Applications > Fees > Types [List](https://rl3l4f0v16.apifox.cn/333697302e0.md): - Platforms > Onboarding > Boarding Applications > Fees > Other Fees [Add](https://rl3l4f0v16.apifox.cn/333697303e0.md): This endpoint is used to add up to two `Other Fees` in the Fee section of the Boarding Application. - Platforms > Onboarding > Boarding Applications > Fees > Other Fees [Update](https://rl3l4f0v16.apifox.cn/333697304e0.md): This endpoint is used to update a specific `Other Fee` in the Fee section of the Boarding Application. - Platforms > Onboarding > Boarding Applications > Fees > Other Fees [Delete](https://rl3l4f0v16.apifox.cn/333697305e0.md): This endpoint is used to remove a specific `Other Fee` in the Fee section of the Boarding Application. - Platforms > Onboarding > Boarding Applications > Fees [List all fees](https://rl3l4f0v16.apifox.cn/333697298e0.md): Listing all fees for boarding application with `id` 608 - Platforms > Onboarding > Boarding Applications > Fees [View a specific fee](https://rl3l4f0v16.apifox.cn/333697299e0.md): View all the information for fee with `id` 19445 for boarding application with `id` 608 - Platforms > Onboarding > Boarding Applications > Fees [Update a single fee](https://rl3l4f0v16.apifox.cn/333697300e0.md): Update the value for fee with `id` 19445 for boarding application with `id` 608 - Platforms > Onboarding > Boarding Applications > Fees [Update multiple fees](https://rl3l4f0v16.apifox.cn/333697301e0.md): Update the values for fees with `id` 19452 and `id` 19451 for boarding application with `id` 608 - Platforms > Onboarding > Boarding Applications > Bank Accounts [Add](https://rl3l4f0v16.apifox.cn/333697306e0.md): `When creating separate Bank Accounts all Bank Account types have to be provided in the request.` - Platforms > Onboarding > Boarding Applications > Bank Accounts [Update](https://rl3l4f0v16.apifox.cn/333697307e0.md): To update a Bank Account, you have to provide the ID of the Bank Account you want to update: - Platforms > Onboarding > Boarding Applications > Bank Accounts [Change](https://rl3l4f0v16.apifox.cn/333697308e0.md): In the case, a Boarding Application has multiple Bank Accounts assigned and you want to switch to a single Bank Account, you can use the following request - Platforms > Onboarding > Boarding Applications > Validate [Validate a Boarding Application](https://rl3l4f0v16.apifox.cn/333697309e0.md): Validate Boarding Application with `id` 386 - Platforms > Onboarding > Boarding Applications > URL [GET URL of Boarding Application](https://rl3l4f0v16.apifox.cn/333697310e0.md): - Platforms > Onboarding > Boarding Applications > Signature > Request E-sign [Request Signature](https://rl3l4f0v16.apifox.cn/333697311e0.md): - Platforms > Onboarding > Boarding Applications > Signature > Embed E-sign [Request Embed](https://rl3l4f0v16.apifox.cn/333697312e0.md): - Platforms > Onboarding > Boarding Applications > Signature > Manually Signing [Manual Sign](https://rl3l4f0v16.apifox.cn/333697313e0.md): ``` - Platforms > Onboarding > Boarding Applications > Signature > External eSign Signing [External eSign](https://rl3l4f0v16.apifox.cn/333697314e0.md): ``` - Platforms > Onboarding > Boarding Applications > Automation > AutoSign [Set AutoSign](https://rl3l4f0v16.apifox.cn/333697315e0.md): - Platforms > Onboarding > Boarding Applications > Automation > AutoUnderwriting [Set AutoUnderwriting](https://rl3l4f0v16.apifox.cn/333697316e0.md): - Platforms > Onboarding > Boarding Applications > Status [Set status to Underwriting](https://rl3l4f0v16.apifox.cn/333697317e0.md): - Platforms > Onboarding > Boarding Applications > Notes [List](https://rl3l4f0v16.apifox.cn/333697318e0.md): - Platforms > Onboarding > Boarding Applications > Notes [Create](https://rl3l4f0v16.apifox.cn/333697319e0.md): Create a note for Boarding Application with `id` 608 and send a notification to the appropriate department - Platforms > Onboarding > Merchants > Terminals [List Terminals](https://rl3l4f0v16.apifox.cn/333697321e0.md): List all terminals with their associated `merchant.id` and `dba.id` - Platforms > Onboarding > Merchants > Terminals [View a specific Terminal](https://rl3l4f0v16.apifox.cn/333697322e0.md): - Platforms > Onboarding > Merchants > Terminals [VAR Sheet](https://rl3l4f0v16.apifox.cn/333697323e0.md): By utilizing this endpoint you can download a pdf file containing the terminal information, also known as VAR Sheet. - Platforms > Onboarding > Merchants > Terminals [VAR View](https://rl3l4f0v16.apifox.cn/333697324e0.md): By utilizing this endpoint you can view VAR sheet data for a specific terminal - Platforms > Onboarding > Merchants [List Merchants](https://rl3l4f0v16.apifox.cn/333697320e0.md): - Platforms > Onboarding > DBA [List](https://rl3l4f0v16.apifox.cn/333697325e0.md): Use this endpoint to list all DBAs that you have available. - Platforms > Onboarding > DBA [View](https://rl3l4f0v16.apifox.cn/333697326e0.md): - Platforms > Onboarding > Attachments > Temporary Upload [Temporary Upload](https://rl3l4f0v16.apifox.cn/333697333e0.md): You can utilize the standard upload endpoint if your file is 16MB or less. Anything above 16MB you need to utilize the chunk upload endpoint. - Platforms > Onboarding > Attachments > Chunk Upload [Initialize](https://rl3l4f0v16.apifox.cn/333697334e0.md): Initialize Object - Platforms > Onboarding > Attachments > Chunk Upload [Upload Request 1/2](https://rl3l4f0v16.apifox.cn/333697335e0.md): You need to separate the larger file into smaller chunks/parts no bigger than 16MB. After the separation, the files need to be uploaded with the correct sequence of parts. - Platforms > Onboarding > Attachments > Chunk Upload [Upload Request 2/2](https://rl3l4f0v16.apifox.cn/333697336e0.md): You need to separate the larger file into smaller chunks/parts no bigger than 16MB. After the separation, the files need to be uploaded with the correct sequence of parts. - Platforms > Onboarding > Attachments [Standard Upload](https://rl3l4f0v16.apifox.cn/333697327e0.md): You can utilize the standard upload endpoint if your file is 16MB or less. Anything above 16MB you need to utilize the chunk upload endpoint. - Platforms > Onboarding > Attachments [List attachments](https://rl3l4f0v16.apifox.cn/333697328e0.md): List all of your attachments in the Dashboard's file system. - Platforms > Onboarding > Attachments [View](https://rl3l4f0v16.apifox.cn/333697329e0.md): View a specific attachment - Platforms > Onboarding > Attachments [View in browser](https://rl3l4f0v16.apifox.cn/333697330e0.md): View a specific attachment in browser - Platforms > Onboarding > Attachments [Download](https://rl3l4f0v16.apifox.cn/333697331e0.md): Download an attachment. - Platforms > Onboarding > Attachments [Delete](https://rl3l4f0v16.apifox.cn/333697332e0.md): Deleting attachments can be achieved by utilizing this endpoint. - Platforms > Reporting > Authorizations [List](https://rl3l4f0v16.apifox.cn/333697337e0.md): > **IMPORTANT** If no `date` is specified in the request as a filter we will return authorizations for the last 5 days from the current date. - Platforms > Reporting > Authorizations [List with Filters](https://rl3l4f0v16.apifox.cn/333697338e0.md): Example request to list all authorizations for a specific `dbaId`, `card.bin.brand.visa` and `terminal.number` between a date range - Platforms > Reporting > Batches [List](https://rl3l4f0v16.apifox.cn/333697339e0.md): Use this endpoint to list all the batches for a specific `dba.id` - Platforms > Reporting > Batches [List with Filters](https://rl3l4f0v16.apifox.cn/333697340e0.md): Example request to list all the transactions that are included in a batch for a specific date - Platforms > Reporting > Batches [Summary](https://rl3l4f0v16.apifox.cn/333697341e0.md): - Platforms > Reporting > Payouts [List](https://rl3l4f0v16.apifox.cn/333697342e0.md): > **NOTE** Keep in mind that running this request without specifying a processingDate filter will return all available records for the current month - Platforms > Reporting > Payouts [View](https://rl3l4f0v16.apifox.cn/333697343e0.md): View detailed payout information for a specific date - Platforms > Reporting > Payouts [Export](https://rl3l4f0v16.apifox.cn/333697344e0.md): - Platforms > Reporting > Chargebacks > View [List](https://rl3l4f0v16.apifox.cn/333697345e0.md): You can utilize this endpoint to list all chargebacks - Platforms > Reporting > Chargebacks > View [View](https://rl3l4f0v16.apifox.cn/333697346e0.md): By utilizing this endpoint you can view detailed information for a specific chargeback - Platforms > Reporting > Chargebacks > Disputes [Upload a temporary file](https://rl3l4f0v16.apifox.cn/333697347e0.md): In order to upload a temporary file and submit a dispute to a chargeback case you need to utilize our standard Attachments endpoint and pass an additional URL parameter `temporary` - Platforms > Reporting > Chargebacks > Disputes [Create a Dispute](https://rl3l4f0v16.apifox.cn/333697348e0.md): After uploading the file/files you need to create the dispute by assigning all the temporary `attachment.id` to the `case.id`. - Platforms > Reporting > Chargebacks > Disputes [Preview](https://rl3l4f0v16.apifox.cn/333697349e0.md): Use this endpoint if you want to preview your dispute before submitting it. - Platforms > Reporting > Chargebacks > Disputes [Submit](https://rl3l4f0v16.apifox.cn/333697350e0.md): Use this endpoint to submit your dispute - Platforms > Reporting > Statements [List](https://rl3l4f0v16.apifox.cn/333697351e0.md): - Platforms > Reporting > Statements [Download](https://rl3l4f0v16.apifox.cn/333697352e0.md): To download a specific statement, use its corresponding `id`. All the statements are in pdf format. - Platforms > Reporting > Reserve [List](https://rl3l4f0v16.apifox.cn/333697353e0.md): - Platforms > Reporting > Fraud Report [Generate](https://rl3l4f0v16.apifox.cn/333697354e0.md): - Platforms > Reporting > Other Reports [Request a Report](https://rl3l4f0v16.apifox.cn/333697355e0.md): - Platforms > Reporting > Other Reports [Check Status](https://rl3l4f0v16.apifox.cn/333697356e0.md): Use this endpoint to check the status of a specific requested report. - Platforms > Reporting > Other Reports [Download](https://rl3l4f0v16.apifox.cn/333697357e0.md): After checking the status of a requested report and when it is ready to be downloaded, you can utilize this endpoint. - Platforms > Residuals [List](https://rl3l4f0v16.apifox.cn/333697358e0.md): Use this endpoint to list all available residuals - Platforms > Residuals [View](https://rl3l4f0v16.apifox.cn/333697359e0.md): By utilizing this endpoint you can view details for a specific merchant residual. - Platforms > Tickets > Update Ticket Status [Close](https://rl3l4f0v16.apifox.cn/333697363e0.md): - Platforms > Tickets > Update Ticket Status [Re-Open](https://rl3l4f0v16.apifox.cn/333697364e0.md): - Platforms > Tickets > Responses [List](https://rl3l4f0v16.apifox.cn/333697365e0.md): Use this endpoint to list all responses for a specific ticket. - Platforms > Tickets > Responses [Create](https://rl3l4f0v16.apifox.cn/333697366e0.md): Create a response for a specific ticket - Platforms > Tickets > Responses [Add an Attachment](https://rl3l4f0v16.apifox.cn/333697367e0.md): Use this endpoint to add attachments to a ticket response - Platforms > Tickets > Attachments [List](https://rl3l4f0v16.apifox.cn/333697368e0.md): - Platforms > Tickets > Attachments [View](https://rl3l4f0v16.apifox.cn/333697369e0.md): - Platforms > Tickets > Attachments [Create](https://rl3l4f0v16.apifox.cn/333697370e0.md): - Platforms > Tickets > Attachments [Delete](https://rl3l4f0v16.apifox.cn/333697371e0.md): - Platforms > Tickets > Categories [List](https://rl3l4f0v16.apifox.cn/333697372e0.md): - Platforms > Tickets > Notes [List](https://rl3l4f0v16.apifox.cn/333697373e0.md): Use this endpoint to list all the notes for a specific `ticket.id` - Platforms > Tickets > Notes [View](https://rl3l4f0v16.apifox.cn/333697374e0.md): - Platforms > Tickets > Notes [Create](https://rl3l4f0v16.apifox.cn/333697375e0.md): This endpoint is used to add notes to a ticket. - Platforms > Tickets > Notes [Update](https://rl3l4f0v16.apifox.cn/333697376e0.md): You can use this endpoint to update/make corrections to an existing ticket note. - Platforms > Tickets > Notes [Delete](https://rl3l4f0v16.apifox.cn/333697377e0.md): Use this endpoint to delete a ticket note. - Platforms > Tickets > Notes [Attachments](https://rl3l4f0v16.apifox.cn/333697378e0.md): You can use this endpoint to add an attachment to an existing ticket note. - Platforms > Tickets [List](https://rl3l4f0v16.apifox.cn/333697360e0.md): Use this endpoint to list all of your tickets. - Platforms > Tickets [Create](https://rl3l4f0v16.apifox.cn/333697361e0.md): Use this endpoint to create a new ticket. - Platforms > Tickets [View a specific ticket](https://rl3l4f0v16.apifox.cn/333697362e0.md): View all the information for a specific `ticket.id` - Platforms > Misc > Address Checker [List Countries](https://rl3l4f0v16.apifox.cn/333697379e0.md): Use this endpoint to list all countries and their corresponding code information - Platforms > Misc > Address Checker [List States](https://rl3l4f0v16.apifox.cn/333697380e0.md): Use this endpoint to list all available state information for a specific country code. - Platforms > Misc > Address Checker [List Cities and Zip Codes](https://rl3l4f0v16.apifox.cn/333697381e0.md): Use this endpoint to list all available cities and their zip code information for a specific state code. - Platforms > Misc > Address Checker [Filter by City and State](https://rl3l4f0v16.apifox.cn/333697382e0.md): Keep in mind that you can use filters to list only specific cities or list cities for a specific zip code. We validate state, city, and zip code combinations on the Boarding Application, so make sure you are providing the correct information. - Platforms > Misc > BIN Check [Get BIN Information](https://rl3l4f0v16.apifox.cn/333697383e0.md): View information for a specific BIN record.