Aeropay

Verify linked bank accounts with the Aeropay enrichment in RiskOS™ to support account verification, account funding, and payment use cases.

Aeropay

Status: Integrated
Website: https://www.aeropay.com/
Credentials: Customer-provided (Connector)
Description: Aeropay is a secure, card-free way to pay and get paid directly from your bank account. Instead of typing card numbers or keeping a wallet balance, you link your checking account once and then pay, deposit, cash out, or receive refunds in just a few taps. Aeropay powers payments for e‑commerce checkouts, subscriptions, gaming deposits and withdrawals, health and wellness memberships, and marketplace payouts—anywhere a fast, secure, bank‑based payment makes sense.

Products offered via RiskOS™

Product Name	Description	RiskOS™ Use Cases
Aeropay User Data	Verify that a customer has linked bank accounts within the Aeropay network by supplying minimal personally identifiable information.	Account verification, account funding, payments

Example API responses

Retrieve User Data

{
"success": "true",
"error": "string",
"user": {
  "userId": 0,
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "type": "string",
  "phone": "string",
  "bankAccounts": [
    {
      "bankAccountId": "string",
      "userId": 0,
      "bankName": "string",
      "accountLast4": "string",
      "name": "string",
      "externalBankAccountId": "string",
      "isSelected": "string",
      "accountType": "string",
      "status": "string",
      "createdDate": "string"
    }
  ],
  "createdDate": "string",
  "aeroPassUserUuid": "string"
}
}

Data dictionary

Retrieve User Data

Field	Type	Description
`authorizationToken`	String	Request. Header. Required. A userForMerchant scoped token. The user fetched is based on the userId provided when this token was created via /token.
`success`	Integer	Response. 1 when the request succeeded.
`user`	Object	Response. The user associated with the merchant.
`user.userId`	String	Response. The unique identifier for this user within the AeroPay system.
`user.firstName`	String	Response. User's first name.
`user.lastName`	String	Response. User's last name.
`user.type`	String (enum)	Response. User type (e.g., consumer).
`user.email`	String	Response. User's email address.
`user.phone`	String	Response. User's phone number, E.164 format.
`user.createdDate`	String (Unix timestamp)	Response. Date the user was created in AeroPay.
`user.bankAccounts`	Array<BankAccount>	Response. Bank accounts linked to this user.
`user.bankAccounts[].bankAccountId`	String	Response. Unique identifier for the linked bank account.
`user.bankAccounts[].userId`	String	Response. The userId this bank account belongs to.
`user.bankAccounts[].bankName`	String	Response. Name of the bank (e.g., "Chase Bank").
`user.bankAccounts[].accountLast4`	String	Response. Last 4 digits of the bank account number.
`user.bankAccounts[].name`	String	Response. Display name for the account (e.g., "Checking - 1222").
`user.bankAccounts[].externalBankAccountId`	String	Response. External/aggregator-side identifier for the bank account, if any.
`user.bankAccounts[].isSelected`	String ("0" \| "1")	Response. Whether this is the user's default/selected account for transactions.
`user.bankAccounts[].accountType`	String (enum)	Response. Account type (e.g., checking).
`user.bankAccounts[].status`	String (enum)	Response. Bank account link status (e.g., verified).
`user.bankAccounts[].createdDate`	String (Unix timestamp)	Response. Date this bank account was linked.
`user.aeroPassUserUuid`	String (UUID)	Response. The user's network-wide AeroPass identifier, used for Aerosync SDK widget configuration and cross-merchant identity within the Aero network.
`user.userStatus`	String (enum)	Response. Current status of the user (e.g., Active).
`error`	Object	Response. Present instead of a success payload when the request fails. Per Aeropay convention, most error conditions are returned with an HTTP 200 status; this endpoint additionally returns a true HTTP 401 specifically when the authorizationToken header is missing or invalid.
`error.help`	String	Response. Optional human-readable guidance (e.g., "contact [email protected] for help"). Not present on all errors.
`error.code`	String (enum)	Response. Machine-readable Aeropay error code (e.g., AP101 for a missing/invalid authorizationToken, AP113 if the userId on the token no longer resolves to a user). See the Aeropay Error Glossary for the full list.
`error.message`	String	Response. Human-readable error message (e.g., "No Authenticated User", "User does not exist").

Updated 2 days ago

Did this page help you?