Skip to main content
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 the dashboard, configure the following credentials, which are obtained from USAePay administrator portal.

​
API key

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

​
Webhook configuration

Webhooks need to be configured in the USAePay administrator portal under Settings -> Webhooks. Note and copy the webhook subscription URL in the dashboard and pass it to the Hook URL field in the USAePay webhook configuration.
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 administrator portal, and pass this to the Webhook Signature Key when configuring the credentials in the dashboard.

​
Idempotency

USAePay provides support for idempotent retries. However, it needs to be configured in their administrator 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 the 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. The system does not currently support void before the transaction is settled yet, this feature is still in development.