Getting Started
Pre-Requisites and Usage
- An active business on Cadana and an org API key is required to make payments.
Please go through the guides on API keys and authentication before you continue.
Step 1: Creating a beneficiary
To make a payment, you first need to create a beneficiary - the employee/contractor you want to pay. All beneficiaries are created against a support payout provider (i.e bank, wallet provider). You can use the following endpoint to get the list of supported banks and then proceed to create the beneficiary.
Step 2: Confirm Balance
Before you can initiate any payouts, your account must have sufficient balance to process the payment.
Step 3: Creating a payout
You now need to create an fxQuote that will be used to initiate a payment to the beneficiary. The FX quotes are short lived and typically expire within 5 mins. Once you have the fxQuote you can initiate the payout.
Step 4: Monitor payout status
You can use the GET payouts endpoint to view the status of a transaction. Webhooks are also emitted when the state of a transaction is updated.
Updated about 1 month ago