Create Mass Payout
Note
To enable the use of this method, contact Rapyd support.
Create a batch of payouts (disbursements) from a file.
Note
The base URL for this method is different from all other methods in the API.
Sandbox - https://sandboxfiles-service.rapyd.net/
Production - https://prodfiles-service.rapyd.net/
This method triggers one or more of the following webhooks for each entry in the file. Use the Client Portal to select the webhooks you want to receive.
The -F or --form parameter requires a CSV file on your local machine. The file must be in unencrypted CSV format. To get a template for this file, see Downloading a Sample Mass Payout File.
/v1/batch_process/files/mass_payout_pci
Mass Payout
curl -X post https://sandboxfiles-service.rapyd.net/v1/batch_process/files/mass_payout_pci' -H 'access_key: your-access-key-here' -H 'Content-Type: multipart/form-data' -H 'idempotency: your-idempotency-parameter-here' -H 'salt: your-random-string-here' -H 'signature: your-calculated-signature-here' -H 'timestamp: your-unix-timestamp-here' -F 'file=@"/your-file-location/mass-payout-file.csv"'
{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "411b1685-fec6-42cb-8cde-02eca47f5c4d" }, "data": { "id": "batch_fbd7d1cf1a189719554a1b0289506262", "original_name": "mass-payout-file.csv", "type": "mass_payout_pci", "status": "NEW", "created_at": 1706009143453 } }