transaction

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

The userForMerchant authorizationToken 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.

Amount is specified as XX.XX in dollars. An optional description may be provided.

A merchant must generate and pass a uuid (following standard uuid guidelines in ISO/IEC 9834-8) to associate the transaction with an internal system.

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Transaction amount in USD rounded to 2 decimal places: XX.XX

string
required

merchantId of merchant receiving payment.

string
required

Unique uuid to identify the transaction. This value can be used to associate Aeropay transactions with your own system. Must follow standard uuid guidelines (ISO/IEC 9834-8).

string

bankAccountId of transacting user. Defaults to user's default bank (isSelected: 1).

string

Specific merchant location, used for multi-location merchants. Defaults to merchant's first location.

string
enum

Currency attribute. Defaults to USD. Aeropay currently only supports USD.

Allowed:
string

Description of transaction.

attributes
object
Headers
string
required

A userForMerchant scoped token.

string
required

Version header. Transaction v2 requires X-AP-Version == 2023-06-05

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json