Create Mass Payout
Note
To enable the use of this method, contact Rapyd support.
Create a batch of payouts (disbursements) from a file.
This method enables uploading both encrypted and unencrypted files.
For an encrypted file upload:
Use the
is_encryptedBoolean parameter. See also the 'Mass Payout - Encrypted File Upload' sample on this page.The method provides these encryption options:
No encryption -
is_encryptedparameter is set to false or not entered at all (default).File-level encryption only - Contact Rapyd Support to obtain the public key for file level encryption.
Both file and beneficiary card number encryption (only applicable for card payouts) - Beneficiary card number encryption is an optional feature available only for card payouts. It specifically encrypts the card number (PCI data) and is not controlled by any parameter within this method. Use the PGP algorithm for encryption and for generating public and private keys. Encrypt the card with your own private key and share the corresponding public key with Rapyd.
Note
The base URL for this method is different from all other methods in the API.
Sandbox - https://sandboxfiles-service.rapyd.net/
Production - https://files-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 an unencrypted CSV format when the is_encrypted parameter is not provided. To add encryption, add the is_encrypted Boolean parameter, and set its value to true (default is false). See also the samples on this page for an unencrypted and encrypted file upload.
To get a template for this file, see Downloading a Sample Mass Payout File.
/v1/batch_process/files/mass_payout_pci
Mass Payout - Unecrypted File Upload
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 } }
Mass Payout - Encrypted File Upload
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"' -F 'is_encrypted="true"'
{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "423b1685-fec6-42cb-8cde-02eca47f5c5t" }, "data": { "id": "batch_fbd7d1cf1a189719554a1b0289506262", "original_name": "mass-payout-file.csv", "type": "mass_payout_pci", "status": "NEW", "created_at": 1706009143453 } }