API Reference

transaction

post
https://api.sandbox-pay.aero.inc/v2/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.

Error Glossary (click to expand)
CodeHTTP StatusMessage
AP101401No authenticated user
AP103200Unable to set user reputation level
AP109200Delinquent activity on account
AP110200User profile incomplete
AP114200Account restricted by merchant
AP201200No merchant found for merchant id
AP203200Unable to get location for merchant
AP205200Unable to get rewards and fees for merchant
AP206200Unable to get merchant account
AP300200Unable to connect to bank
AP302200Insufficient funds
AP303200Transaction missing location
AP304200Transaction amount exceeds limit
AP306200Insufficient balance
AP307200Payment declined - try a lower amount
AP308200Invalid amount
AP314200Transaction already exists
AP315200Payment rejected - threshold or suspended bank
AP400200No bank account linked
AP401400Cannot validate bank account
AP402200No bank account for merchant
AP403200Bank not supported
AP404200Invalid routing number
AP411200Invalid account type - connect a checking account
AP412200Bank account already removed
AP700400Missing or invalid required parameter
AP701400Improperly formatted parameter
AP1400400Idempotency key reused with different payload
AP1401400Request with same idempotency key still processing
AP1402400Invalid idempotency key structure
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Body of transaction call

integer

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

integer
required

MerchantId

amount
object
required

Dictionary with currency and amount in pennies. Only USD supported at this time

string

Merchant reference id of transaction

attributes
object

Dictionary with attributes. Tip and invoice are standard formats. Custom attributes must follow value/description dictionary formatting.

Headers
string
required

A userForMerchant scoped token.

uuid

Optional UUID value to ensure idempotent transaction.

Responses

Updated about 2 months ago

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

Updated about 2 months ago

Did this page help you?