API Reference
Start typing to search…

Agave

How to enable Agave ACH on a merchant.

Agave offers a platform for processing ACH (Automated Clearing House) payments, facilitating secure and efficient bank-to-bank transactions. The service supports integration with various business systems to automate and manage payment operations effectively.

Features

✅ Payment Sale Payments are authorized and immediately captured using ACH payment methods.

Resources

Configuration

To configure Agave for ACH payments, you'll need to secure your Merchant ID and Merchant Key. These are essential credentials for the gateway and can be obtained as follows:

  • The Merchant ID is visible at the top of the Virtual Terminal screen within your Agave account.
  • To get your Merchant Key, please contact Agave support at [email protected] or call 855-546-8749 and select option 2 for Support. Let Agave know you will be using Authvia, so they can confirm the proper TSYS settings for your credentials.

Once you have these credentials you can proceed with configuring this product.

This table describes the required or possible attributes needed to configure a merchant product for this type.

NameTypeDescriptionRules
hoststringThe base URL for Agave API requests
merchantIdstringThe merchant ID for authenticating with Agave API Examples: mid_1234567890abcdef.
merchantKeystringThe merchant key for authenticating with Agave API Examples: key_test_4eC39HqLyjWDarjtT1zdp7dc.

Enabling this Product

Using create-merchant-product API you can add a new product to your merchant record. Below is an example configuration for the payload of that request.

{
  "line": "payments",
  "product": "ach",
  "provider": "agave",
  "config": {
    "merchantId": "mid_1234567890abcdef",
    "merchantKey": "key_test_4eC39HqLyjWDarjtT1zdp7dc"
  }
}

Data Mapping

The following bullet points outline the mapping of data fields between the Authvia platform and the Agave system, detailing the correspondence of specific attributes for seamless data integration.