--- title: "Create Mass Payout" source_url: https://docs.rapyd.net/en/create-mass-payout.html lang: en --- # 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_encrypted` Boolean parameter. See also the 'Mass Payout - Encrypted File Upload' sample on this page. - The method provides these encryption options: - **No encryption -** `is_encrypted` parameter 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. - [Payout Canceled Webhook](https://docs.rapyd.net/en/payout-canceled-webhook.md "Payout Canceled Webhook") - [Payout Completed Webhook](https://docs.rapyd.net/en/payout-completed-webhook.md "Payout Completed Webhook") - [Payout Created Webhook](https://docs.rapyd.net/en/payout-created-webhook.md "Payout Created Webhook") - [Payout Creation Failed Webhook](https://docs.rapyd.net/en/payout-creation-failed-webhook.md "Payout Creation Failed Webhook") - [Payout Failed Webhook](https://docs.rapyd.net/en/payout-failed-webhook.md "Payout Failed Webhook") - [Payout Returned Webhook](https://docs.rapyd.net/en/payout-returned-webhook.md "Payout Returned Webhook") - [Payout Updated Webhook](https://docs.rapyd.net/en/payout-updated-webhook.md "Payout Updated Webhook") ### Parameters ### Request Header Parameters - - access_key - Unique access key provided by Rapyd for each authorized user. See [Developers](https://docs.rapyd.net/en/developers.md "Developers"). - - Content-Type - Indicates that the data appears as a file. Set to **multipart/form-data**. - - idempotency - A unique key that prevents the platform from creating the same object twice. See [Idempotency](https://docs.rapyd.net/en/idempotency.md "Idempotency"). - - salt - Random string. Recommended length: 8-16 characters. - - signature - Signature calculated for each request individually. See [Request Signatures](https://docs.rapyd.net/en/request-signatures.md "Request Signatures"). - - timestamp - Timestamp for the request, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time") (seconds). ### Request Input File 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](https://docs.rapyd.net/en/downloading-a-sample-mass-payout-file.md "Downloading a Sample Mass Payout File"). ### Request Body Parameters None. ### Response Parameters - - created_at - Time of creation of the batch operation, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time") (seconds). - - id - ID of the batch operation. String starting with **batch_**. - - original_name - Filename of the uploaded batch file. - - status - Status of the batch operation - **NEW** - - type - Batch operation type - **mass_payout_pci** - /v1/batch_process/files/mass_payout_pci - Mass Payout - Unecrypted File Upload - ```bash 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"' ``` - ```json { "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 - ```bash 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"' \ -H 'is_encrypted="true"' ``` - ```json { "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 } } ```