Skip to main content

​
Onboard and get API keys

First, you need to have onboarded to Consul and completed your entity onboarding. Once you’ve done this, you can provision your API keys in the Developer section of the dashboard.

​
Deposit funds

To start sending payouts, you need to have USDC funds available in your Consul wallet. The quickest way to do this is to link your bank account and initiate a deposit from the dashboard. You can do this by clicking the “Add Funds” button on the home page or selecting deposit in the “Move Money” dropdown. Once complete, you will receive deposit instructions: Deposit Instructions Note: as of this writing, you can deposit USD, ARS, MXN, COP, and BRL.

​
Wait for deposit webhook

Once the deposit is complete, you will receive an email notification. For a payout integration, you’ll need to listen for the deposit.updated webhook event and fetch the associated deposit object. The funds are now available and ready to be used for payouts.

​
Send payouts

Using the Create a Payout API you can now initiate a payout to an email address. We can initiate a payout with the following snippet: 
curl --request POST
     --url https://api.onconsul.com/v1/payouts
     --header 'Authorization: Bearer <API_KEY>'
     --header 'Content-Type: application/json'
     --data '[
     {"amount": 100, "currency": "USD", "recipient_email": "test@example.com"},
     {"amount": 200, "currency": "USD", "recipient_email": "test2@example.com"},
    ]'
Note: payouts settle almost instantly (<3s p99 latency), but the output will be a payout ID in the processing state. The reason for this is that, occasionally (e.g. during rare high congestion times), Base may take up to 30s to finalize the payout. You can then listen for webhook events to wait for the transfer.updated event to reconcile this payout as completed. Payouts can be fetched at any time, and the current on-chain status (including transaction hashes) will be available. Once the above To enable an end-to-end instant flow, you can then send an RTP push payment to your external operating account. Alternatively, a FedWire will be sent overnight to your operating account on file.