Sign in

v1

latestOpenAPI 3.0.02026-07-263118119.8 KB
Create & Manage Transactions

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.

<details> <summary><strong>Error Glossary</strong> (click to expand)</summary>
CodeHTTP StatusMessage
AP101401No authenticated user
AP103200Unable to set user reputation level
AP109200Delinquent activity on account
AP110200User profile incomplete
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
AP305200Account blocked - delinquent activity
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
AP900200External API error
AP1400400Idempotency key reused with different payload
AP1401400Request with same idempotency key still processing
AP1402400Invalid idempotency key structure
</details>
post/v2/payoutTransaction

Headers

Content-Typestring required
authorizationstring required

A merchant scoped token.

Idempotency-Keystring uuid

Optional UUID value to ensure idempotent transaction.

Request body

userIdstring required

UserId of Aeropay user to pay to. In UUID format.

merchantIdinteger required

merchantId

bankAccountIdinteger

bankAccountId of selected bank

referenceIdstring

Merchant reference id of transaction

rtpboolean

If RTP is not specified, it will default to an ACH transaction.

Response

Success or Business Logic Error (AP411)

OR

Example response

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