Overview

API Payouts, also referenced as 'Dynamic Payouts', offer a more flexible approach to managing payouts, enabling you to send funds to your recipients on an as-needed basis. With API Payouts, you can initiate payouts at any time, giving you complete control over the timing and frequency of your disbursements.

Create a payout instruction

Step 1: Add a Bank Account to a Merchant

Ensure the merchant is provisioned on your platform, then add their bank account.

Step 2: Run a Transaction

Initiate a transaction using the merchant ID.

• In the sandbox, wait 2 minutes for processing.
• In production, transactions are typically settled in batches at the end of the day, with settlement occurring the next day.

Step 3: Check Merchant’s Available Balance

Query the merchant’s available balance to ensure sufficient funds for the payout.

Step 4: Submit Payout Instructions

Submit the payout details, specifying how and where the funds should be transferred, using the Dynamic Payouts API.

Step 5: Await Underwriting Approval

Wait for underwriting approval to ensure the payout is authorized.

Step 6: Verify Payout Status

Check the status of the payout to confirm if it was successful or failed.

Void existing payout instructions

Note: Only payout instructions that have NOT been processed can be voided.

To void an existing payout instruction that hasn't been processed yet, simply include the payoutId in your request.