> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gr4vy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# USAePay - Card

> Connect to USAePay to accept credit and debit card payments.

USAePay is a US-based card payment gateway owned by NMI, providing secure
payment processing solutions for merchants in the United States.

## Setup

USAePay provides a self-service sign-up for a sandbox account. To sign up for
an account, visit the [sign-up
page](https://developer.usaepay.com/_developer/app/register) and create an
account.

## Credentials

Configure the following credentials in the Gr4vy dashboard, which are obtained
from your USAePay administrator portal under **Settings** → **API Keys**:

* **API Key** - Your USAePay API key for authentication
* **PIN** - Your USAePay PIN for API access
* **Webhook Signature Key** (optional) - Your webhook signature key for
  verifying webhook authenticity

<Frame>
  <img src="https://mintcdn.com/gr4vy/YjfuwBe-3Nu3A-GT/connections/assets/usaepay_api_key.png?fit=max&auto=format&n=YjfuwBe-3Nu3A-GT&q=85&s=615c36a169a27eaf46c7e75d2433200f" alt="USAePay API Key" width="1898" height="994" data-path="connections/assets/usaepay_api_key.png" />
</Frame>

## Connector configuration

After setting up your USAePay connector in the dashboard, configure how
transactions are routed to it. Choose one of the following options:

* **Using Flow** - Configure USAePay as the target connector in
  [Flow](/guides/dashboard/flow/overview) to automatically route card
  transactions to this connector
* **Using the API** - Explicitly set the `payment_service_id` parameter to the
  USAePay connector ID when creating transactions. This overrides any Flow
  routing rules.

The connector ID can be found in the dashboard under **Connections** ->
**Configured connections**.

## Features

USAePay supports the following features:

* **Delayed capture** - Authorize a payment and capture it at a later time
* **Partial capture** - Capture a portion of the authorized amount
* **Partial refunds** - Refund a portion of the captured amount
* **Refunds** - Refund a captured payment
* **Void** - Cancel an authorized transaction before capture
* **Payment method tokenization** - Store payment methods for future use outside
  of transactions
* **Transaction sync** - Automatic synchronization of transaction status updates

## Supported countries

USAePay supports transactions from buyers in `US`.

## Supported currencies

USAePay supports processing payments in `USD`.

## Limitations

The following features are not supported by this connector:

* **3-D Secure** - Neither hosted nor pass-through 3DS authentication
* **Digital wallets** - Apple Pay, Google Pay, and other digital wallet integrations
* **Network tokens** - Network-level tokenization for enhanced security
* **Over-capture** - Capturing an amount greater than the authorized amount
* **Partial authorization** - Accepting a partial amount when the full amount cannot be authorized
* **Settlement reporting** - Automated settlement and reconciliation reporting
* **Zero auth** - Verifying a card without charging it

<Note>
  This is a closed-loop connector. Some failover scenarios are limited.
  For details, see [Open loop versus closed loop](https://docs.gr4vy.com/guides/features/recurring-payments/open-loop#open-loop-versus-closed-loop).
</Note>

## Integration

To accept card payments with USAePay, use one of Gr4vy's client-side
integration methods to securely collect card details. Due to PCI compliance
requirements, card data should never be sent directly to your servers.

You can integrate using:

* **[Embed](/guides/payments/embed/quick-start)** - A pre-built, customizable
  payment form that handles the complete payment flow
* **[Secure Fields](/guides/payments/secure-fields/quick-start)** - Embed card
  input fields for building custom payment forms while maintaining PCI
  compliance
* **[Mobile SDKs](/guides/get-started#sdks-and-plugins)** - Native SDKs for
  iOS, Android, React Native, and other platforms

These methods handle card data collection and tokenization. Once the card
details are collected and tokenized, create a transaction through the Gr4vy API,
which automatically routes the payment to your configured USAePay connection
based on your Flow rules or explicit `payment_service_id` parameter.

## Webhooks

Webhooks need to be configured in the USAePay administrator portal under
**Settings** → **Webhooks**. Copy the webhook subscription URL from the Gr4vy
dashboard and add it to the **Hook URL** field in the USAePay webhook
configuration.

<Frame>
  <img src="https://mintcdn.com/gr4vy/YjfuwBe-3Nu3A-GT/connections/assets/usaepay_webhook_configuration.png?fit=max&auto=format&n=YjfuwBe-3Nu3A-GT&q=85&s=da5b62ea71adcae6b9df47e2b39283ba" alt="USAePay Webhook Configuration" width="3360" height="1888" data-path="connections/assets/usaepay_webhook_configuration.png" />
</Frame>

If webhook signature verification is desired, enable this in the USAePay webhook
configuration. Copy the **Signature Key** from the bottom of the webhook
configuration window in USAePay's administrator portal, and provide this value
in the **Webhook Signature Key** field when configuring the connector
credentials in the Gr4vy dashboard.

### Idempotency

USAePay supports idempotent retries, but this must be configured in the USAePay
administrator portal and is linked directly to the API key. By default, the
**Duplicate Transaction Handling** field is set to `None`. There are 3 options
to choose from, and only the **Signature Key** option is supported by Gr4vy.
There is also a **Time Limit** field that allows you to set a limit for
evaluating duplicate transactions.

* **3-D Secure** - Neither hosted nor pass-through 3DS is supported
* **Cancel** - Canceling transactions is not supported
* **Create session** - Session creation is not supported
* **Delete token** - Deleting stored payment tokens is not supported
* **Digital wallets** - Direct wallet integrations are not supported
* **Network tokens** - Network tokenization is not supported
* **Open loop** - Open-loop card processing is not supported
* **Over capture** - Capturing more than the authorized amount is not supported
* **Partial authorization** - Partial authorization is not supported
* **Settlement reporting** - Automatic settlement reporting is not supported
* **Zero auth** - Zero authorization verification is not supported

Additional limitations include:

* **Refunds before settlement** - Captured transactions cannot be refunded until
  they are settled. The system does not currently support voiding transactions
  before settlement.

## Integration

To accept card payments with USAePay, use one of Gr4vy's client-side integration
methods to securely collect card details. Due to PCI compliance requirements,
card data should never be sent directly to your servers.

You can integrate using:

* **[Embed](/guides/payments/embed/quick-start)** - A pre-built, customizable
  payment form that handles the complete payment flow
* **[Secure Fields](/guides/payments/secure-fields/quick-start)** - Embed card
  input fields for building custom payment forms while maintaining PCI
  compliance
* **[Mobile SDKs](/guides/get-started#sdks-and-plugins)** - Native SDKs for iOS,
  Android, React Native, and other platforms

These methods handle card data collection and tokenization. Once the card
details are collected and tokenized, create a transaction through the Gr4vy API,
which routes the payment to your configured USAePay connection based on your
Flow rules or explicit `payment_service_id` parameter.
