USAePay USAePay is a gateway that allows you to collect card and eCheck payments. This guide is intended to help you implement USAePay based on your preferred integration workflow.

Services and compatibility


Supported payment types	Card eCheck
Supported transaction types	Sale (saved card/echeck token or full card number) ( API ) Auth Only (saved card/echeck token or full card number) ( API ) Capture (partial and greater than) ( API ) Void ( API ) Refund (partial and multiple) ( API )
Supported processing currencies	CAD, EUR, GBP, USD
3D Secure 1.x supported	No
3D Secure 2.x supported	No
External 3D Secure supported	Yes
Installments supported	No

Gateway-specific information

USAePay settles batches daily.
paymentType is not supported.

Configuration

Work with Integrations Support to add USAePay as a connection. You will need the following credentials from USAePay:

source key
PIN

Required and optional fields

The following table shows the optional fields for USAePay transactions in the Create one-time-use token or Run card transaction request.

Field	Required?	Description
`data.descriptor.name`	No	For USAePay card transactions, include this parameter to dynamically change the descriptor on the customer's statement. If this parameter is not included, the system uses the default descriptor (as set up on the merchant account that is originating the transactions).
`data.descriptor.address`	No	For USAePay card transactions only, include this parameter to dynamically change the descriptor on the customer's statement for the street address of the merchant. If this parameter is not included, the system uses the default street address descriptor (as set up on the merchant account that is originating the transactions).
`data.descriptor.city`	No	For USAePay card transactions only, include this parameter to dynamically change the descriptor on the customer's statement for the city of the merchant. If this parameter is not included, the system uses the default city descriptor (as set up on the merchant account that is originating the transactions).
`data.descriptor.state`	No	For USAePay card transactions only, include this parameter to dynamically change the descriptor on the customer's statement for the state of the merchant. If this parameter is not included, the system uses the default state descriptor (as set up on the merchant account that is originating the transactions).
`data.descriptor.postal`	No	For USAePay card transactions only, include this parameter to dynamically change the descriptor on the customer's statement for the postal code of the merchant. If this parameter is not included, the system uses the default postal code descriptor (as set up on the merchant account that is originating the transactions).
`data.descriptor.country`	No	For USAePay card transactions only, include this parameter to dynamically change the descriptor on the customer's statement for the country of the merchant. If this parameter is not included, the system uses the default country descriptor (as set up on the merchant account that is originating the transactions).
`data.descriptor.phone`	No	For USAePay card transactions only, include this parameter to dynamically change the descriptor on the customer's statement for the phone number of the merchant. If this parameter is not included, the system uses the default phone number descriptor (as set up on the merchant account that is originating the transactions).
`data.descriptor.url`	No	For USAePay card transactions only, include this parameter to dynamically change the descriptor on the customer's statement for the website URL of the merchant. If this parameter is not included, the system uses the default URL descriptor (as set up on the merchant account that is originating the transactions).
`data.descriptor.merchantId`	No	For USAePay card transactions only, include this parameter to dynamically change the descriptor on the customer's statement for the NMI ID of the merchant. If this parameter is not included, the system uses the default ID descriptor (as set up on the merchant account that is originating the transactions).
`data.descriptor.mcc`	No	For USAePay card transactions only, include this parameter to dynamically change the descriptor on the customer's statement for the merchant category code (MCC). If this parameter is not included, the system uses the default MCC descriptor (as set up on the merchant account that is originating the transactions).

Example requests

The following is an example run card transaction request for USAePay.

curl -X POST https://api.nexiopaysandbox.com/pay/v3/process \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic [Base64_encoded_login]'
  -d '{
  "data": {
    "amount": 4.00,
    "descriptor": {
    	"name": "Our Company Name",
			"address": "123 Main St.",
			"city": "New York City",
      "state": "NY",
      "postal": "10001",
      "country": "US",
      "phone": "1555555555",
      "url": "https://your-ecommerce-website.example.com",
      "merchantId": "1234",
      "mcc": "5964"
		}
  },
  "paymentMethod": "card",
  "tokenex": {
		"token": "eb50a022-d6de-4244-a1e6-dcb8522b2d19"
  }
}'

The following is an example run echeck transaction request for USAePay.

curl -X POST https://api.nexiopaysandbox.com/pay/v3/processECheck \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic [Base64_encoded_login]'
  -d '{
  "data": {
    "amount": 4.00,
    "currency": "USD"
  },
  "tokenex": {
		"token": "eb50a022-d6de-4244-a1e6-dcb8522b2d19"
  }
}'

Testing data

Use the following test card information to test your USAePay configuration.

Brand	Card number	Exp date	Security code	Cardholder name	Transaction result
Visa	4000100011112224	Any	Any	Any	Success
Visa	4000300011112220	Any	Any	Any	Decline
Mastercard	5555444433332226	Any	Any	Any	Success
American Express	371122223332225	Any	Any (ex: 1234)	Any	Success
Discover	6011222233332224	Any	Any	Any	Success

Status workflows

The status of a successful transaction with USAePay varies, depending on the options you choose.


Sale	When `isAuthOnly` is `false`, successful sale transactions will have the following statuses: pending* or authorized settled
Auth only	When `isAuthOnly` is `true`, successful sale transactions will have the following status: authOnly
Capture	Successful capture transactions will have the following statuses: pending* or authorized settled
Void	Successful void transactions will have the following status: voided
Refund	Successful refund transactions will have the following statuses: pending* or authorized settled

*Pending status displays as "authorized" or "AUTHORIZED" in the Nexio Dashboard; it displays as 10, meaning "authorized", in the response when querying transactions (for more information about transactionStatus, see the appropriate transactionStatus table).

If you have any additional questions or feedback, contact us.