preauthTransaction

Create an Aeropay preauthorized transaction object

The user making the transaction is specified by the authorizationToken, and the merchant being paid is specified in the request.

A preauthorized Transaction does not iniate the movement of any funds, only stores the details of a transaction that may be captured later via /capturePreauthTransaction POST.

The response contains a transaction object. The 'id' within this transaction object is used to identify and capture/cancel this preauthorized transaction. It is the act of capturing with that id that creates an Aeropay transaction in which money is moved. This newly created transaction will have its own id, separate from the one created in this call.

This preauthorized transaction will expire after 3 days, or can be manually cancelled by calling /preauthTransaction DELETE with its respective id. Time to expiration can be configured on a merchant by merchant basis.

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

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

Description of transaction.

attributes
object
Headers
string
required

A userForMerchant scoped token.

Responses

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