preauthTransaction

Create a preauthorized transaction for the user specified by the authorization token.

The response contains a transaction object. The id within this transaction object is used to identify this preauthorized transaction.

Preauthorized transactions do not have a default expiration, but can be configurable by merchant.

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

Code	HTTP Status	Message
AP009	401	Unauthorized
AP101	401	No authenticated user
AP103	200	Unable to set user reputation level
AP109	200	Delinquent activity on account
AP110	200	User profile incomplete
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
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
AP310	200	Credit transaction declined
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
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
AP1000	200	Invalid API
AP1400	400	Idempotency key reused with different payload
AP1401	400	Request with same idempotency key still processing
AP1402	400	Invalid idempotency key structure

</details>

Content-Typestring required

authorizationstring required

A userForMerchant scoped token.

Idempotency-Keystring uuid

Optional UUID value to ensure idempotent transaction.

Request body

bankAccountIdinteger required

bankAccountId of selected bank

merchantIdinteger required

MerchantId

referenceIdstring

Merchant reference id of transaction

{
  "bankAccountId": "0",
  "merchantId": "1748",
  "amount": {
    "amount": 1234,
    "currency": "USD"
  },
  "referenceId": "123-123-1234"
}

Success

OR

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