USAePay is a card payment gateway by NMI.

​
Sign-up

USAePay provides a self-service sign-up for a sandbox account. To sign-up for an account visit the sign-up page and create an account.

​
Credentials

When setting up USAePay in our dashboard, you will need to configure the following credentials, which are obtained from USAePay admin portal.

​
API Key

The USAePay API key, PIN, and Webhook Signature Key are all obtained from the USAePay admin portal under Settings -> API Keys.

​
Webhook configuration

Webhooks need to be configured in the USAePay admin portal under Settings -> Webhooks. Note and copy the webhook subscription URL in our dashboard and pass it to the Hook URL field in the USAePay webhook configuration.

​
Signature verification (optional)

If webhook signature verification is desired, then this needs to be explicitly configured. Copy the Signature Key at the bottom of the webhook configuration window in USAePay’s admin portal, and pass this to the Webhook Signature Key when configuring the credentials in our dashboard.

​
Idempotency

USAePay provides support for idempotent retries. However, it needs to be configured in their admin portal and is linked directly to the API key. By default, the Duplicate Transaction Handling field is None. There are 3 options to choose from and only the **Signature Key ** is supported be our system. There is also a Time Limit field that allows setting a limit for evaluating duplicate transactions.

​
Limitations

  • Captured transactions can not be refunded until they are settled. Our system does not currently support void before the transaction is settled yet, this feature is still in development.

​
Latest Release (V2)

A new V2 connector is now available in some sandbox environments. Please contact support if you would like to see this new connector enabled in your environments.

​
New features

  • More detailed API logs in the dashboard, including request and response bodies from the USAePay API.
  • More comprehensive webhook support including webhook validation.
  • Support for syncing transaction manually via the dashboard and API.
  • Support for cart items and shipping addresses in the API
  • Deep linking transactions from our dashboard to the USAePay dashboard.
  • Idempotent retries

​
Changes

  • The connector now sends a different value for the invoice field to the USAePay API. Previously, this field was previously set to the transaction’s reconciliation_id, while it now will include a new idempotency key ({reconciliation_id}-{idempotency_key} ).