Payout workflow

Scenario : Initiate a direct Payout


Step 1 : To initiate a direct payout, create a beneficiary via the Create beneficiary endpoint

Step 2 : Once your beneficiary(ies) have been created, you can then create a direct payout by inputing the payout details and your beneficiary id

Step 3 : If you do not know the specific Beneficiary ID (for already existing beneficiaries), you can retrieve a list of all your beneficiaries by calling the Get Beneficiaries API.

Step 4 : Initiate a Payout request by calling the Initiate direct payout API. Initiate payout to an existing beneficiary by calling the Initiate Payout to existing beneficiary API

Scenario : Initiate Payout with File


Step 1 : To initiate a payout with file, download a sample payout document template with Get Payout template API and edit to include your beneficiaries.

Step 2 : Once your beneficiary(ies) have been added, you can initiate a payout with the Initiate Payout with file API