# Request a payout request split

Splits a pending payout request into two or more separate requests.
Provide an array of amounts; one new payout request is created per amount.
The original request amount is reduced by the sum of the amounts and transitions to the split status.
The total of the provided amounts must be less than the original amount.
The remaining amount remains in the original request.
This operation returns the newly created payout requests.

Endpoint: POST /payout-requests/{id}/split
Version: latest
Security: SecretApiKey, JWT

## Path parameters:

  - `id` (string, required)
    ID of the resource.

## Request fields (application/json):

  - `amounts` (array, required)
    Amounts for each new payout request.
One request is created per amount.
Each amount must be greater than zero.
The sum must be less than the original amount.
Provide one amount to create two requests, or multiple amounts to create additional requests.
    Example: [50,30,20]

## Response 201 fields (application/json):

  - `id` (string)
    ID of the resource.
    Example: "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"

  - `websiteId` (string, required)
    ID of the website.
A website is where an organization obtains a customer.
For more information, see [Obtain an organization ID and website ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).

  - `customerId` (string, required)
    ID of the customer who is requesting a payout.

  - `paymentInstrumentId` (string,null)
    ID of the requested payment instrument to offer for the payout.
    Example: "inst_0YVB8KPKNXCBR9EDX7JHSED75N"

  - `splitFromPayoutRequestId` (string,null)
    ID of the payout request from which this request is split,
or null if this request is not created by a split operation.
    Example: "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"

  - `mergedIntoPayoutRequestId` (string,null)
    ID of the payout request that this request is merged into,
or null if it is not merged into another request.
    Example: "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"

  - `currency` (string, required)
    Currency of the payout.

  - `amount` (number, required)
    Amount of the payout.

  - `availableAmount` (number)
    Amount of the payout request that is unallocated and available.

  - `description` (string,null)
    Description of payout request.

  - `status` (string)
    Status of the request.
    Enum: "pending", "ready", "approved", "in-progress", "instrument-selected", "partially-fulfilled", "fulfilled", "canceled", "customer-reversed", "system-reversed", "admin-reversed", "split", "merged"

  - `blocked` (boolean)
    Specifies whether the payout request is blocked or unblocked.

  - `blockReason` (any)

  - `batchId` (string,null)
    ID of the payout request batch that contains this request.
    Example: "preq_batch_0YVDMDE2BMC6KBB5MX76RF6T80"

  - `selectPaymentInstrumentUrl` (string)
    URL where the customer can select a preferred payment instrument.

  - `allocations` (array)
    List of payout request allocations for the payout request.

  - `allocations.payoutRequestId` (string, required)
    ID of the payout request associated with this allocation.
    Example: "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"

  - `allocations.batchId` (string,null)
    ID of the payout request batch that contains the payout request for this allocation.
    Example: "preq_batch_0YVDMDE2BMC6KBB5MX76RF6T80"

  - `allocations.paymentInstrumentId` (string, required)
    ID of the payment instrument allocated to the payout request.
    Example: "inst_0YVB8KPKNXCBR9EDX7JHSED75N"

  - `allocations.gatewayAccountId` (string, required)
    ID of the gateway account to use for processing this allocation.
    Example: "gateway_0YVB8KPKNXCBR9EDX7JHSED75N"

  - `allocations.gatewayName` (string)
    Name of the gateway account to use for processing this allocation.
    Example: "TestProcessor"

  - `allocations.amount` (number, required)
    Amount allocated to this payment instrument.

  - `allocations.currency` (string, required)
    Currency of the payout request allocation.

  - `allocations.status` (string)
    Status of this payout request allocation.
    Enum: "pending", "queued", "processing", "completed", "failed", "canceled", "declined"

  - `allocations.transactionId` (string,null)
    ID of the transaction that is created when processing this allocation, if applicable.
    Example: "txn_0YVB8KPKNXCBR9EDX7JHSED75N"

  - `allocations.createdTime` (string)
    Date and time when the allocation for the payout request was created.

  - `allocations.updatedTime` (string)
    Date and time when the resource is updated.
This value is set automatically when the resource is updated.

  - `allocations._links` (array)
    Related links.

  - `allocations._links.href` (string)
    Link URL.

  - `allocations._links.rel` (string)
    Type of link.
    Enum: "self", "transaction", "gatewayAccount", "payoutRequest", "paymentInstrument"

  - `selectedPaymentInstrumentRedirectUrl` (string)
    URL where the customer is redirected after selecting a payment instrument.
The default value is the website URL.
Use {{id}} as a placeholder for the payout request ID.
    Example: "https://example.com/payout-request-success"

  - `cancellationReason` (object,null)
    Reason the payout request is canceled.

  - `cancellationReason.canceledBy` (string)
    Specifies who initiated the cancellation.
    Enum: "merchant", "customer"

  - `cancellationReason.description` (string)
    Description of the cancellation reason in free form.

  - `createdTime` (string)
    Date and time when the payout request is created.

  - `updatedTime` (string)
    Date and time when the payout request is updated.

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 404 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 409 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 422 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

  - `invalidFields` (array)
    Invalid field details.
    Example: [{"field":"field1","message":"field1 is invalid"},{"field":"subObject.field2","message":"field2 is invalid"},{"field":"subObject.field2","message":"another error in the field2"}]

  - `invalidFields.field` (string)
    Name of the field.
Dot notation is used for nested object field names.

  - `invalidFields.message` (string)
    Message field.

## Response 429 fields (application/json):

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".
    Example: "about:blank"

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
    Example: "Rate Limit Exceeded"

  - `status` (integer)
    HTTP status code.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.
    Example: "A request cannot be executed because the user has sent too many requests within a certain period of time"

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.