v1

latestOpenAPI 3.0.02026-07-263118119.8 KB

Create & Manage Transactions

transaction

Create an Aeropay Transaction Object where funds will move from a user to a merchant.

The userForMerchant token specifies the paying user. The merchant being paid is specified by the merchantId in the request body. The user's default bank account will be selected if no bankAccountId is specified.

Attributes are AeroPay formatted data that you may wish to include with your transaction. For example, an invoice number or the tracking of a tip amount.

NOTE: Tip amounts will be added to the 'amount' value.

<details> <summary><strong>Error Glossary</strong> (click to expand)</summary>

Code	HTTP Status	Message
AP101	401	No authenticated user
AP103	200	Unable to set user reputation level
AP109	200	Delinquent activity on account
AP110	200	User profile incomplete
AP114	200	Account restricted by merchant
AP201	200	No merchant found for merchant id
AP203	200	Unable to get location for merchant
AP205	200	Unable to get rewards and fees for merchant
AP206	200	Unable to get merchant account
AP300	200	Unable to connect to bank
AP302	200	Insufficient funds
AP303	200	Transaction missing location
AP304	200	Transaction amount exceeds limit
AP306	200	Insufficient balance
AP307	200	Payment declined - try a lower amount
AP308	200	Invalid amount
AP314	200	Transaction already exists
AP315	200	Payment rejected - threshold or suspended bank
AP400	200	No bank account linked
AP401	400	Cannot validate bank account
AP402	200	No bank account for merchant
AP403	200	Bank not supported
AP404	200	Invalid routing number
AP411	200	Invalid account type - connect a checking account
AP412	200	Bank account already removed
AP700	400	Missing or invalid required parameter
AP701	400	Improperly formatted parameter
AP1400	400	Idempotency key reused with different payload
AP1401	400	Request with same idempotency key still processing
AP1402	400	Invalid idempotency key structure

</details>

post/v2/transaction

Headers

Content-Typestring required

authorizationstring required

A userForMerchant scoped token.

Idempotency-Keystring uuid

Optional UUID value to ensure idempotent transaction.

Request body

bankAccountIdinteger

default bank account for the user will be used if not specified

merchantIdinteger required

MerchantId

referenceIdstring

Merchant reference id of transaction

Example request

{
  "attributes": {
    "invoice": {
      "value": "Value",
      "description": "Description"
    },
    "tip": {
      "tipAmount": "1.00",
      "label": "$1.00",
      "totalAmount": "2.00"
    }
  }
}

Response

Success or Business Logic Error

Example response

{
  "error": {
    "help": "Contact support@aeropay.com for help.",
    "code": "AP700",
    "message": "Missing required Parameter: 'email'"
  }
}