Connecting USAePay

Connecting to USAePay uses API credentials. You generate a source key and a
PIN in the USAePay console and enter them in the connection settings.

Setup

To set up USAePay you need to create a source key and PIN:

  1. Log in to USAePay at usaepay.com/login.

  2. Select Settings in the top navigation.

  3. Select Source Keys in the secondary navigation.

  4. Select Add Source.

  5. Name your source — for example, Online Payments — and add a secret PIN
    (for example, 12345), then select Save.

    USAePay Source Key and PIN dialog

  6. Copy the Key from the list of sources, along with the PIN you created, into
    the corresponding boxes on the USAePay configuration screen.

Connection options

  • Enable ACH / Bank Transfer: Accept bank account (ACH) payments in USD. The
    payment method must also be enabled on your USAePay account.
    • Webhook Signature Key: Optional. The USAePay webhook Signature Key
      (wsig:...) from your USAePay console. Supplying it lets USAePay tell Shuttle
      as soon as an ACH payment settles or is returned; leave it blank and Shuttle
      falls back to scheduled polling, which is slower but still reconciles the
      payment.

ACH behaves differently from cards — see
ACH Payments & Returns before enabling it.

Payment methods

You can enable additional payment methods on your USAePay account and configure
them in the USAePay console.


Did this page help you?