---
updatedAt: 2025-09-30T15:27:51.000Z
agentTools:
  projectIndex: https://docs.nexiopay.com/llms.txt
---

# Submit payouts using batch file

Allows you to submit one or more payouts using a batch file as input for the API request.

Use this endpoint to make payouts to existing or new recipients.

<!-- theme: warning -->
> 🛑 Important
>
> Ensure the following for this endpoint:<ul style='margin-top: -5px; margin-bottom: -5px'><li>The header content-type must be `multipart/form-data`.</li><li>The batch file must be in a location that is accessible by the server making this API request.</li></ul>

<!-- theme: info -->
> 📘 Note 
> 
> For the payout provider Interchecks, if you pass a value for one of the `recipientIdNumbers` parameters when creating a new recipient, you cannot update any recipient information with [Update recipient](ref:updaterecipient) endpoint.

<!-- theme: warning -->
> ⚠️ Try It
> 
> Due to technical limitations, it is not possible to use the Try It feature with this endpoint. Instead, use Postman or your own server (along with the credentials for your [Sandbox API user](doc:sandbox-environments)) to make the request.

 
## Batch file parameters
The following table shows the required and optional parameters for making payouts using a batch file.
For more information about each parameter, see the [Submit payouts](ref:submitpayouts) endpoint.

To use your own field headers from your batch file, contact [Integrations Support](page:contact-us) for assistance.

<table>
<tr>
<th align='center'>Parameter</th>
<th align='center'>Name in batch file</th>
<th align='center'>Notes</th>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>batchRef</span></td>
<td>batchRef</td>
<td>If you include this parameter, the system only uses the first instance of it in the batch file. Other instances are ignored. If you want multiple batches to display as a single group in a report, specify the same value for each batch. Using this option allows you to easily view money sent to different payout providers so that you can properly fund those accounts.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>currency</span></td>
<td>currency</td>
<td>Required for each payout.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>amount</span></td>
<td>amount</td>
<td>Required for each payout.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>description</span></td>
<td>description</td>
<td>Optional.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>payoutRef</span></td>
<td>payoutRef</td>
<td>Optional.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.recipientId</span></td>
<td>recipientId</td>
<td>Conditionally required for payout to an existing recipient when neither `recipientRef` nor `email` is included. This parameter is prioritized if more than one of those is included.<br/><br/>Not allowed for payout to a new recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.recipientRef</span></td>
<td>recipientRef</td>
<td>Conditionally required for payout to an existing recipient when neither `recipientId` nor `email` is included. This parameter is prioritized over email if that value is included. Otherwise, it is ignored if `recipientId` is included.<br/><br/>Required for payout to a new recipient.<br/><br/><b>Important:</b> We strongly recommend that you include this value in your request instead of <span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipientId</span> in order to facilitate payment reconciliation.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.email</span></td>
<td>email</td>
<td>Conditionally required for payout to an existing recipient when neither `recipientId` nor `recipientRef` is included. This parameter is only prioritized if neither of the other two are included. Otherwise, it is ignored.<br/><br/>Required for payout to a new recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.firstName</span></td>
<td>firstName</td>
<td>Required for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.lastName</span></td>
<td>lastName</td>
<td>Required for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.country</span></td>
<td>country</td>
<td>Required for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.providerId</span></td>
<td>providerId</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.userType</span></td>
<td>userType</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.gender</span></td>
<td>gender</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.birthDate</span></td>
<td>birthDate</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.countryOfBirth</span></td>
<td>countryOfBirth</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.countryOfNationality</span></td>
<td>countryOfNationality</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.addressType</span></td>
<td>addressType</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.addressLine1</span></td>
<td>addressLine1</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.addressLine2</span></td>
<td>addressLine2</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.city</span></td>
<td>city</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.region</span></td>
<td>region</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.postalCode</span></td>
<td>postalCode</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.phoneNumber</span></td>
<td>phoneNumber</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.phoneNumberCountry</span></td>
<td>phoneNumberCountry</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.mobileNumber</span></td>
<td>mobileNumber</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.mobileNumberCountry</span></td>
<td>mobileNumberCountry</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.governmentIdType</span></td>
<td>governmentIdType</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>governmentId</span><br/>(in <span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.recipientIdNumbers</span>)</td>
<td>governmentId</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>passportId</span><br/>(in <span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.recipientIdNumbers</span>)</td>
<td>passportId</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>driversLicenseId</span><br/>(in <span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.recipientIdNumbers</span>)</td>
<td>driversLicenseId</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
<tr>
<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>employerId</span><br/>(in <span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.recipientIdNumbers</span>)</td>
<td>employerId</td>
<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>
</tr>
</table>

## Batch file format and examples
The batch file needs to be in CSV format. The first line contains a comma-separated list of the parameters to use. Each subsequent line must have the same number of commas as the first line but does not have to have content for each parameter (except where the parameter is required for the payout request). 
For the possible required, conditionally required, and optional parameters to include, see the previous section.

To use your own field headers from your batch file, contact [Integrations Support](page:contact-us) for assistance.

### Simple batch file example
```
firstName,lastName,recipientRef,email,country,amount,currency
Yiseme,Gordman,9348rwf2,ygordman@testdata123.com,US,15,USD
John,Johnson,123456r3,jj@123.com,CA,140,CAD
,,,,,,
```
[Download sample file (in ZIP)](https://drive.google.com/file/d/1rR_knD7aBeCUnTvbHATOrPsW5lsuz-BI/view?usp=sharing)<br/>(To download, click the link and then select the option to "download".)
### Batch file with all parameters example
```
batchRef,currency,amount,description,payoutRef,recipientId,recipientRef,email,firstName,lastName,country,providerId,userType,gender,birthDate,countryOfBirth,countryOfNationality,addressType,addressLine1,addressLine2,city,region,postalCode,phoneNumber,phoneNumberCountry,mobileNumber,mobileNumberCountry,governmentIdType,governmentId,passportId,driversLicenseId,employerId
batch006,USD,1314.27,June commission payment,113e9ee19a-9c5f-49ca-9a92-3e39e64219c01,98198452,DS1125345,recipientemail112@payoutnow.com,Judith,Callie,US,12695,INDIVIDUAL,FEMALE,12/5/90,US,US,RESIDENTIAL,123 Somewhere St,,Somewhere,AK,99885,801111111,US,8012222222,US,NATIONALIDCARD,999999999,,DL12343234,
batch006,USD,125,June commission payment,Z12345 June 15th  compensation  pay1,98468985,Z11223456,recipientemai1l21@payoutnow.com,Merchnat,LLC,ES,12686,BUSINESS,MALE,11/19/91,ES,ES,BUSINESS,"C. del Pozo, 8",,Madrid,,28012,34915223894,ES,34915223895,ES,NATIONALIDCARD,,,,111111111
batch006,CAD,161.13,June commission payment,11a5ff4a13d4381,,RR12234346,recipientemail132@payoutnow.com,Wilimina,Manning,CA,12696,INDIVIDUAL,FEMALE,1/15/93,CA,CA,RESIDENTIAL,800 Benevenuto Ave,,Brentwood Bay,BC,V8M 1J8,2506524422,CA,2506524421,CA,PASSPORT,,789546512,,
```
[Download sample batch file (in ZIP)](https://drive.google.com/file/d/1JYmaQCyfQRy6ioMn5mZPVvFTGk2xgySC/view?usp=sharing)<br/>(To download, click the link and then select the option to "download".)

# OpenAPI definition

````json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Payouts API Reference",
    "version": "3.0.0",
    "description": "<img src=\"https://files.readme.io/2d0a9c3-payout_icon.png\" alt=\"Payout\" align=\"left\"> Use the Payouts API to push payments to recipients. These endpoints allow you to create and view recipients, send and view payouts, and send multiple payouts through a batch file. For additonal information, see [Payouts](doc:payouts-overview) in Guides.",
    "contact": {
      "name": "Integrations Support",
      "email": "integrations@nexiopay.com",
      "url": "https://nexiointegrations.slack.com/"
    },
    "license": {
      "name": "ISC",
      "url": "https://docs.nexiopay.com/page/license"
    }
  },
  "security": [
    {
      "Basic_Authentication": []
    },
    {
      "One-time-use_Token": []
    }
  ],
  "servers": [
    {
      "description": "Sandbox",
      "url": "https://api.nexiopaysandbox.com",
      "variables": {}
    }
  ],
  "components": {
    "securitySchemes": {
      "Basic_Authentication": {
        "type": "http",
        "scheme": "basic",
        "description": "Basic authentication is a simple authentication scheme built into the HTTP protocol. \n\nFor the \"Try It\" feature, type your API username and password in the appropriate fields. The system then automatically creates the Authorization header that contains the word `Basic` followed by a space and a base64-encoded string `username:password`. \n\nFor example: `Authorization: Basic ZGVtbzpwQDU1dzByZA==` \n\nFor your own requests, learn how to do the conversion in the [Authentication](doc:authentication#basic-authentication) guide. \n\nFor more information about this security protocol, see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample"
      },
      "One-time-use_Token": {
        "type": "apiKey",
        "name": "token",
        "in": "query",
        "description": "The one-time-use token authentication scheme requires a token supplied in the named query parameter that can only be used to submit a single API request and that expires after one hour. \n\nFor the \"Try It\" feature, first generate the one-time-use token through either the [Create one-time-use token](ref:createonetimeusetoken) or the [Create APM one-time-use token](ref:createapmonetimeusetoken) endpoint. Copy the resulting token and then paste it in the appropriate field for the current endpoint. \n\nFor your own requests, learn how to generate the one-time-use token in the [Authentication](doc:authentication#one-time-use-tokens) guide. Then, use it as normal for this endpoint. \n\nFor more information about the \"apiKeys\" security protocol, see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object"
      }
    },
    "responses": {
      "401": {
        "description": "Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string",
                  "description": "A message from Nexio about the state of the request.",
                  "example": "Unauthorized"
                }
              }
            }
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "Payouts",
      "description": "APIs for payouts"
    }
  ],
  "paths": {
    "/payout/v3/batch": {
      "post": {
        "summary": "Submit payouts using batch file",
        "operationId": "PayoutBatch",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "success",
                      "description": "Message indicates success or failure for processing the batch file."
                    }
                  }
                },
                "examples": {
                  "Example response": {
                    "value": {
                      "message": "success"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          }
        },
        "description": "Allows you to submit one or more payouts using a batch file as input for the API request.\n\nUse this endpoint to make payouts to existing or new recipients.\n\n<!-- theme: warning -->\n> 🛑 Important\n>\n> Ensure the following for this endpoint:<ul style='margin-top: -5px; margin-bottom: -5px'><li>The header content-type must be `multipart/form-data`.</li><li>The batch file must be in a location that is accessible by the server making this API request.</li></ul>\n\n<!-- theme: info -->\n> 📘 Note \n> \n> For the payout provider Interchecks, if you pass a value for one of the `recipientIdNumbers` parameters when creating a new recipient, you cannot update any recipient information with [Update recipient](ref:updaterecipient) endpoint.\n\n<!-- theme: warning -->\n> ⚠️ Try It\n> \n> Due to technical limitations, it is not possible to use the Try It feature with this endpoint. Instead, use Postman or your own server (along with the credentials for your [Sandbox API user](doc:sandbox-environments)) to make the request.\n\n \n## Batch file parameters\nThe following table shows the required and optional parameters for making payouts using a batch file.\nFor more information about each parameter, see the [Submit payouts](ref:submitpayouts) endpoint.\n\nTo use your own field headers from your batch file, contact [Integrations Support](page:contact-us) for assistance.\n\n<table>\n<tr>\n<th align='center'>Parameter</th>\n<th align='center'>Name in batch file</th>\n<th align='center'>Notes</th>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>batchRef</span></td>\n<td>batchRef</td>\n<td>If you include this parameter, the system only uses the first instance of it in the batch file. Other instances are ignored. If you want multiple batches to display as a single group in a report, specify the same value for each batch. Using this option allows you to easily view money sent to different payout providers so that you can properly fund those accounts.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>currency</span></td>\n<td>currency</td>\n<td>Required for each payout.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>amount</span></td>\n<td>amount</td>\n<td>Required for each payout.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>description</span></td>\n<td>description</td>\n<td>Optional.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>payoutRef</span></td>\n<td>payoutRef</td>\n<td>Optional.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.recipientId</span></td>\n<td>recipientId</td>\n<td>Conditionally required for payout to an existing recipient when neither `recipientRef` nor `email` is included. This parameter is prioritized if more than one of those is included.<br/><br/>Not allowed for payout to a new recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.recipientRef</span></td>\n<td>recipientRef</td>\n<td>Conditionally required for payout to an existing recipient when neither `recipientId` nor `email` is included. This parameter is prioritized over email if that value is included. Otherwise, it is ignored if `recipientId` is included.<br/><br/>Required for payout to a new recipient.<br/><br/><b>Important:</b> We strongly recommend that you include this value in your request instead of <span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipientId</span> in order to facilitate payment reconciliation.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.email</span></td>\n<td>email</td>\n<td>Conditionally required for payout to an existing recipient when neither `recipientId` nor `recipientRef` is included. This parameter is only prioritized if neither of the other two are included. Otherwise, it is ignored.<br/><br/>Required for payout to a new recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.firstName</span></td>\n<td>firstName</td>\n<td>Required for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.lastName</span></td>\n<td>lastName</td>\n<td>Required for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.country</span></td>\n<td>country</td>\n<td>Required for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.providerId</span></td>\n<td>providerId</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.userType</span></td>\n<td>userType</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.gender</span></td>\n<td>gender</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.birthDate</span></td>\n<td>birthDate</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.countryOfBirth</span></td>\n<td>countryOfBirth</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.countryOfNationality</span></td>\n<td>countryOfNationality</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.addressType</span></td>\n<td>addressType</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.addressLine1</span></td>\n<td>addressLine1</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.addressLine2</span></td>\n<td>addressLine2</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.city</span></td>\n<td>city</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.region</span></td>\n<td>region</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.postalCode</span></td>\n<td>postalCode</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.phoneNumber</span></td>\n<td>phoneNumber</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.phoneNumberCountry</span></td>\n<td>phoneNumberCountry</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.mobileNumber</span></td>\n<td>mobileNumber</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.mobileNumberCountry</span></td>\n<td>mobileNumberCountry</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.governmentIdType</span></td>\n<td>governmentIdType</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>governmentId</span><br/>(in <span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.recipientIdNumbers</span>)</td>\n<td>governmentId</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>passportId</span><br/>(in <span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.recipientIdNumbers</span>)</td>\n<td>passportId</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>driversLicenseId</span><br/>(in <span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.recipientIdNumbers</span>)</td>\n<td>driversLicenseId</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n<tr>\n<td><span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>employerId</span><br/>(in <span style='font-family: monospace; font-size: 11px; border: solid 1px; padding: 5px; background-color: rgb(250,251,252); border-color: rgb(216,222,235);'>recipient.recipientIdNumbers</span>)</td>\n<td>employerId</td>\n<td>Optional for payout to a new recipient.<br/><br/>Ignored for payout to an existing recipient.</td>\n</tr>\n</table>\n\n## Batch file format and examples\nThe batch file needs to be in CSV format. The first line contains a comma-separated list of the parameters to use. Each subsequent line must have the same number of commas as the first line but does not have to have content for each parameter (except where the parameter is required for the payout request). \nFor the possible required, conditionally required, and optional parameters to include, see the previous section.\n\nTo use your own field headers from your batch file, contact [Integrations Support](page:contact-us) for assistance.\n\n### Simple batch file example\n```\nfirstName,lastName,recipientRef,email,country,amount,currency\nYiseme,Gordman,9348rwf2,ygordman@testdata123.com,US,15,USD\nJohn,Johnson,123456r3,jj@123.com,CA,140,CAD\n,,,,,,\n```\n[Download sample file (in ZIP)](https://drive.google.com/file/d/1rR_knD7aBeCUnTvbHATOrPsW5lsuz-BI/view?usp=sharing)<br/>(To download, click the link and then select the option to \"download\".)\n### Batch file with all parameters example\n```\nbatchRef,currency,amount,description,payoutRef,recipientId,recipientRef,email,firstName,lastName,country,providerId,userType,gender,birthDate,countryOfBirth,countryOfNationality,addressType,addressLine1,addressLine2,city,region,postalCode,phoneNumber,phoneNumberCountry,mobileNumber,mobileNumberCountry,governmentIdType,governmentId,passportId,driversLicenseId,employerId\nbatch006,USD,1314.27,June commission payment,113e9ee19a-9c5f-49ca-9a92-3e39e64219c01,98198452,DS1125345,recipientemail112@payoutnow.com,Judith,Callie,US,12695,INDIVIDUAL,FEMALE,12/5/90,US,US,RESIDENTIAL,123 Somewhere St,,Somewhere,AK,99885,801111111,US,8012222222,US,NATIONALIDCARD,999999999,,DL12343234,\nbatch006,USD,125,June commission payment,Z12345 June 15th  compensation  pay1,98468985,Z11223456,recipientemai1l21@payoutnow.com,Merchnat,LLC,ES,12686,BUSINESS,MALE,11/19/91,ES,ES,BUSINESS,\"C. del Pozo, 8\",,Madrid,,28012,34915223894,ES,34915223895,ES,NATIONALIDCARD,,,,111111111\nbatch006,CAD,161.13,June commission payment,11a5ff4a13d4381,,RR12234346,recipientemail132@payoutnow.com,Wilimina,Manning,CA,12696,INDIVIDUAL,FEMALE,1/15/93,CA,CA,RESIDENTIAL,800 Benevenuto Ave,,Brentwood Bay,BC,V8M 1J8,2506524422,CA,2506524421,CA,PASSPORT,,789546512,,\n```\n[Download sample batch file (in ZIP)](https://drive.google.com/file/d/1JYmaQCyfQRy6ioMn5mZPVvFTGk2xgySC/view?usp=sharing)<br/>(To download, click the link and then select the option to \"download\".)",
        "parameters": [],
        "externalDocs": {
          "url": "",
          "description": "External file to upload."
        },
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "binary",
                    "example": "@\"{path_to_file}/{your_batch_file}.csv\"",
                    "description": "Directory location and name for the batch file. Must be accessible from the server that runs this API endpoint."
                  }
                },
                "required": [
                  "file"
                ]
              },
              "examples": {}
            }
          },
          "description": ""
        },
        "security": [
          {
            "Basic_Authentication": []
          }
        ],
        "tags": [
          "Payouts"
        ]
      }
    }
  }
}
````