payoutTransaction

post

https://api.sandbox-pay.aero.inc/payoutTransaction

Create a transaction that pays an amount from the logged in merchant to the specified user.

The details of the transaction are returned upon success.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

userId

string

required

UserId of user receiving funds.

bankAccountId

string

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

merchantLocationId

string

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

amount

string

required

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

uuid

string

required

A uuid unique to the transaction that can be provided, and referenced later. Required for X-AP-Version 2023-06-05. Must follow standard uuid guidelines (ISO/IEC 9834-8).

rtp

boolean

True if real time payment (RTP), defaults to false. Requires header X-AP-Version: 2023-06-05. Please note you must complete additional bank compliance documents to enable RTP payouts.

Headers

authorizationToken

string

required

A merchant scoped token.

X-AP-Version

string

required

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

Responses

200Successful response

401Missing or invalid authorizationToken header

defaultUnsuccessful response. IMPORTANT: Returns 200