Create a Payout to your User

Now that you have linked a bank account from your user, you will be able to create a payout transaction, which moves funds from your merchant bank account to the user. These types of transactions may be used for withdrawals or rewards.

You will need to retrieve the user to check for their linked bank account. Refer to the previous step to learn more.

Create the Payout Transaction

HTTP request

Sandbox - POST https://staging-api.aeropay.com/payoutTransaction
Production - POST https://api.aeropay.com/payoutTransaction

Request parameters

Code Example - Request

curl --request POST \
     --url https://staging-api.aeropay.com/payoutTransaction \
     --header 'Content-Type: application/json' \
     --header 'X-AP-Version: 2023-06-05' \
     --header 'accept: application/json' \
     --header 'authorizationToken: Bearer {{token}}' \
     --data '
{
  "userId": "4567",
  "amount": "10.99",
  "bankAccountId": "27381938",
  "merchantId": "143"
}
'

👍

New transaction version!

As of 2023, we have added a new transaction version X-AP-Version: 2023-06-05 which is required for all clients to ensure the fastest and most efficient transaction creation.

🚧

Transaction UUIDs

Transaction uuids are used to associate Aeropay transactions with your own system, and must be unique to every transaction. Any transactions sent with duplicated uuids will be blocked by our system.

Code Example - Response

{
    "success": true,
    "error": null,
    "amount": {
        "currency": "USD",
        "value": "10.99"
    },
    "merchantCategories": [
        "NACHA"
    ],
    "storeAddress": "2328 S Michigan Ave, Chicago, IL",
    "attributes": [],
    "uuid": "bc81e829-d35b-43cb-acb9-d218674878be",
    "timestamp": "2023-09-07 17:50:08 UTC",
    "merchantName": "Aeropay"
}