# Manage payout requests (Experimental)

This topic describes how to manage customer payout requests.
Payout requests are created when a customer completes a [withdrawal form](/docs/dev-docs/integrate-a-withdrawal-form), when the [Create a payout request](/docs/dev-docs/api/transactions/postpayoutrequest/) API operation is called, or when a member of your organization [creates a payout request on the customer's behalf](#create-a-payout-request).
Users, or members of your organization, manage these requests by reviewing, approving, and allocating funds to payment instruments.

To manage payout requests in bulk, use batches.
For more information, see [Batch payout requests](#batch-payout-requests).

## Payout request process

This procedure describes the payout request process.

To process payout requests, you must configure at least one gateway for payouts.
For more information, see [Configure how a gateway manages payout requests](/docs/settings/set-up-a-gateway#optionally,-configure-how-the-gateway-manages-payout-requests) and [Configure payout methods to display in withdrawal forms](/docs/settings/payout-method-configuration#configure-methods-to-display-in-withdrawal-forms).

To perform all steps of the payout request process in bulk, use [batches](#batch-payout-requests).

1. A payout request is created when a customer completes a [withdrawal form](/docs/dev-docs/integrate-a-withdrawal-form), when the [Create a payout request](/docs/dev-docs/api/transactions/postpayoutrequest/) API operation is called, or when a member of your organization [creates a payout request on the customer's behalf](#create-a-payout-request).
Depending on the integration, the customer adds or selects a payment instrument in a withdrawal form or on the [hosted payout form](/docs/dev-docs/hosted-payout-integration).
Depending on which initial payout request state is configured, the payout request begins in one of the following states:
If the initial payout request state is not configured, the default status is `ready`.
For more information, see [Edit payout request settings](/docs/settings/organizations-and-websites#edit-payout-request-settings).
  - `pending`: The payout request enters the `pending` state for a configured period before it can be reviewed or approved by a member of your organization.
When the pending period ends, the payout request automatically transitions to the `ready` state.
  - `ready`: The payout request enters the `ready` state and can be reviewed and approved immediately by a member of your organization.
**Available actions:** [Mark as ready](#mark-a-payout-request-as-ready), [Split](#split-a-payout-request), [Block](#block-a-payout-request), [Cancel](#cancel-a-payout-request), [Add payment instrument](#add-payment-instrument-to-a-payout-request).
The 'add payment instrument' action is available only when no payment instrument is assigned to the payout request.
2. The payout request is ready for review.
For more information, see [Review a payout request](#review-a-payout-request).
**Available actions:** [Approve](#approve-a-payout-request), [Split](#split-a-payout-request), [Return to pending](#return-to-pending), [Block](#block-a-payout-request), [Cancel](#cancel-a-payout-request), [Add payment instrument](#add-payment-instrument-to-a-payout-request).
The 'add payment instrument' action is available only when no payment instrument is assigned to the payout request.
3. A member of your organization reviews and approves the payout request.
The payout request is assigned the `approved` status, and funds are ready to allocate.
For more information, see [Review a payout request](#review-a-payout-request).
**Available actions:** [Allocate funds](#allocate-funds), [Split](#split-a-payout-request), [Block](#block-a-payout-request), [Cancel](#cancel-a-payout-request)
4. Funds are allocated automatically or manually by a member of your organization to payment instruments and gateways and are assigned the `in-progress` status.
The allocations are processed by a member of your organization.
For more information, see [Allocate funds](#allocate-funds) and [Process allocations](#process-allocations)
**Available actions:** [Process](#process-allocations), [Block](#block-a-payout-request), [Cancel](#cancel-a-payout-request)
5. The allocations have been processed.
The payout request is fulfilled and is assigned the `fulfilled` status.


## Batch payout requests

Use batches to approve, allocate, process, cancel, or block multiple payout requests at once.

A single batch may contain payout requests with different statuses.

### Create a batch

Use this process to create a batch of payout requests.

You cannot add payout requests to a batch if they are already in another batch.

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout requests**.
3. Select from the following:
  1. In the left of each payout request that you want to add to the batch, select the checkbox.
  2. In the top of the table press **Batch** **Create batch**.
  3. Select **Selected rows**, then press **Create batch**.

This process describes how to add up to 1,000 unbatched payout requests that match the current filter to a batch.
For more information, see [Filter payout requests](#filter-payout-requests).
  1. In the top right of the table, press **Filters**.
  2. In the **Filter** dropdown, select a value to filter.
  3. In the **Operation** dropdown, select a condition.
  4. In the **Value** field, enter or select values.
  5. Press **Apply filter**.
  6. In the top of the table press **Batch** **Create batch**.
  7. If the **Selected rows** and **Current filter** options appear, select **Current filter**.
  8. Press **Create batch**.


### Add payout requests to an existing batch

Use this process to add payout requests to an existing batch.

You cannot add payout requests to a batch if they are already in another batch.
A batch can contain a maximum of 1,000 payout requests.

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout requests**.
3. Select from the following:
  1. In the left of each payout request that you want to add to the batch, select the checkbox.
  2. In the top of the table press **Add to existing batch**.
  3. In the **Target batch** dropdown, select a batch.
  4. Select **Selected rows**, then press **Add to batch**.

This process describes how to add all unbatched payout requests that match the current filter to an existing batch.
For more information, see [Filter payout requests](#filter-payout-requests).
  1. In the top right of the table, press **Filters**.
  2. In the **Filter** dropdown, select a value to filter.
  3. In the **Operation** dropdown, select a condition.
  4. In the **Value** field, enter or select values.
  5. Press **Apply filter**.
  6. In the top of the table press **Add to existing batch**.
  7. In the **Target batch** dropdown, select a batch.
  8. If the **Selected rows** and **Current filter** options appear, select **Current filter**.
  9. Press **Add to batch**.


### Manage batches

Use this process to mark payout requests as ready, review, approve, allocate, process, block, unblock, or delete a batch of payout requests, and to remove payout requests from a batch.
To create a batch of payout requests, see [Create a batch](#create-a-batch).

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout request batches**, then in the **ID** column, press a batch ID.
3. Depending on the state of the batch, select from the following:
Use this process to mark payout requests in a batch as ready for review.
This action is available when payout requests in the batch are in the `pending` status and are not blocked.
  1. In the top of the table, press **Pending**.
  2. In the left of each payout request in the batch, select the checkbox. 
Alternatively, select the checkbox in the top of the table to select all payout requests in the batch.
  3. In the top right of the page, press **Mark as ready**.
  4. In the confirmation dialog, press **Mark as ready**.

This action is available when payout requests in the batch are in the `ready` status.
  1. In the top of the table, press **Ready**.
  2. Optionally, to review existing allocations for the payout requests in the batch: In the left of the payout request, press **Caret down**. 
Alternatively, in the **Payout request ID** column, press the payout request ID to view the payout request details.
  3. In the top right of the page, press **Approve**.

This action is available when payout requests in the batch are in the `approved` status.
During automatic allocation, payout limits on the gateway account cap the allocated amount.
For more information, see [Set payout limits](/docs/settings/manage-payment-gateways#set-payout-limits).
  1. In the top of the table, press **In progress**.
  2. Optionally, to change how payout methods are prioritized for this batch: In the right of the page, in the **Allocation order** section, add or remove payout methods, or press and drag methods to reorder them.
  3. If **Save** and **Cancel** appear below **Allocation order**, select from the following:
    - To persist the allocation order to the batch, press **Save**.
The allocation list must include at least two payout methods.
    - To discard unsaved changes to the allocation order, press **Cancel**.
  4. Optionally, to set the allocation order to the organization default: Next to the **Allocation order** heading, press **Refresh** when that control is visible. 
For more information, see [Set default payout allocation order](/docs/settings/organizations-and-websites#set-default-payout-allocation-order).
  5. In the top right of the page, press **Auto allocate**. 
Alternatively, to manually allocate funds for specific payout requests in a batch, see [Allocate funds](#allocate-funds).

Use this process to process payout requests in a batch.
This action is available when payout requests in the batch are in the `in-progress` status.
  1. In the top of the table, press **In progress**.
  2. In the top right of the page, press **Process all**. 
Alternatively, to process a single allocation for a specific payout request in the batch, see [Process allocations](#process-allocations).

Use this process to view completed payout requests in a batch.
This action is available when the payout requests in the batch are in the `completed` status.
  1. In the table, press **Completed**.
  2. In the **Payout request ID** column, press the payout request ID you want to view.

Select from the following:
This action is available when the batch contains unblocked payout requests in the `pending`, `ready`, `approved`, or `in-progress` status.
To block a batch: In the top right of the page, press **Block batch**. 
Alternatively, to block a specific payout request in a batch, see [Block a payout request](#block-a-payout-request).
This action is available when the batch contains blocked payout requests.
To unblock all blocked payout requests in a batch: In the top right of the page, press **Unblock batch**. 
Alternatively, to unblock a specific payout request in a batch, see [Unblock a payout request](#unblock-a-payout-request).
To view blocked payout requests in a batch: In the top of the table, press **Blocked**.
Use this process to remove specific payout requests from a batch.
The payout requests remain available for another batch.
  1. In the table, press the tab that contains the payout requests you want to remove.
  2. In the left of each payout request you want to remove, select the checkbox. 
Alternatively, select the checkbox in the top of the table to select all payout requests in the tab.
  3. In the top right of the page, press **Remove from batch**.
  4. In the confirmation dialog, press **Remove from batch**.

Use this process to permanently delete a batch.
The payout requests remain available for another batch.
  1. In the top right of the page, press **Delete batch**.
  2. In the confirmation dialog, press **Delete batch**.


### View batches

Use this process to view the details of payout request batches.

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout request batches**.
3.   1. In the top right of the table, press **Filters**.
  2. In the **Filter** dropdown, select **Status**.
  3. In the **Operation** dropdown, select **is in**.
  4. In the **Value** field, select the status of the batch.
  5. Press **Apply filter**.
4. Locate the batch you want to view in the table, then in the **ID** column, press the batch ID.
5. Select from the following:
At the top of the page, the following details are displayed:
  - Requested by: Member of your organization who created the batch.
  - Customers: Number of unique customers in the batch.
  - Payouts: Number of payout requests in the batch.
  - Total amount by currency: Total payout amount grouped by currency in the batch.
  - Created time: Date and time when the batch was created.
  - Updated time: Date and time when the batch was last updated.
  - Description: Description of the batch.

Each payout request in the batch displays status, payout request ID, customer, amount, and the date it was submitted.
On all tabs except **Pending** and **Ready**, the **Allocation** column displays the allocated amount and allocation status.
To view the payout requests in the batch: In the top of the table, depending on the status of the batch, select from the following:
  - **Pending**: View the payout requests that are pending.
  - **Processing**: View the payout requests that are processing.
  - **Completed**: View the payout requests that are completed.
  - **Blocked**: View the payout requests that are blocked.

To view all allocations for all payout requests in the batch: In the top right of the table, press **Visibility**.
To hide all allocations for all payout requests in the batch: In the top right of the table, press **Hide**.
Alternatively, to view the allocations for a single payout request, in the **Payout request ID** column, press a payout request ID.
Use this process to filter payout requests that are displayed in a batch based on specific criteria.
For example, filter payout requests by a specific currency, a specific customer, and other criteria.
To share the filtered view of payout requests in the batch with other users in your organization, copy the URL from your web browser and share the URL with them.
Applied filters are stored in the URL.
  1. In the top right of the table, press **Filters**.
  2. In the **Filter** dropdown, select a value to filter.
  3. In the **Operation** dropdown, select a condition.
  4. In the **Value** field, enter or select values.
  5. Press **Apply filter**.

To reload payout requests and tab counts for the active batch tab:
In the top right of the table, press **Refresh**.


### View completed batches

Use this process to view completed payout request batches.

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout request batches**.
3. In the top right of the table, press **Filters**.
4. In the **Filter** dropdown, select **Status**.
5. In the **Operation** dropdown, select **is in**.
6. In the **Value** field, select **completed**.
7. Press **Apply filter**.
8. In the **ID** column, press a batch ID.


## Create a payout request

Use this process to create a payout request on a customer's behalf.
This process also generates a link where the customer adds a payment instrument to the payout request.
Share this link with the customer, or use the form to add a payment instrument on the customer's behalf.
Use the unique link in customer emails or live chat.

To create a payout request for a customer:

1. In the navigation bar, press **Data tables**, and press **Customers**.
2. In the list of customers, select a customer.
3. In the top right of the page, press **Actions**, then press **Create payout request**.
4. Optionally, if you have configured custom domains, in the **Custom domain** field, select a domain.
For more information, see [Configure a custom domain](/docs/settings/organizations-and-websites#configure-a-custom-domain).
5. Optionally, if more than one website is associated with your organization, in the **Website ID** field, select a website.
For more information, see [My organizations and websites](/docs/settings/organizations-and-websites#my-organizations-and-websites).
6. In the **Currency** field, select the currency for the payout.
7. In the **Amount** field, enter the amount for the payout request.
8. Optionally, in the **Redirect URL** field, enter a URL where the customer is redirected after they select a payment instrument. 
To inject the payout request ID into the redirect URL, use `{{id}}` as a placeholder for the payout request ID.
Example: `https://www.example.com?id={{id}}`.
9. Press **Create**.
10. Copy the link and share it with the customer, or use the form to add a payment instrument on the customer's behalf.


## Manage payout requests

This section describes how to manage payout requests.
To manage multiple payout requests at once, see [Batch payout requests](#batch-payout-requests).

### Allocate funds

Use this process to allocate funds for payout requests.
Allocation is the process of distributing the payout amount across one or more payment instruments and gateways.

Optionally, split the payout request amount into multiple allocations, across multiple payment instruments and gateways.

This action is available when payout requests are in the `approved` or `in-progress` status.

Select from the following:

Allocate funds for a payout request
1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout requests**.
3. Use this process to filter payout requests by the `approved` or `in-progress` status.
These payout requests are ready to be allocated.
  1. In the top right of the table, press **Filters**.
  2. In the **Filter** dropdown, select **Status**.
  3. In the **Operation** dropdown, select **is in**.
  4. In the **Value** field, select **approved** or **in-progress**.
  5. Press **Apply filter**.
4. In the **ID** column, press a payout request ID. 
Ensure that the payout request has the `approved` or `in-progress` status. 
The payout request amount is displayed at the top of the page.
5. Review the payout request details, such as the requested amount, currency, exposure amount, and payment instruments.
6. Select from the following:
Use this process to automatically allocate funds based on payment instrument exposure and eligibility.
During automatic allocation, payout limits on the gateway account cap the allocated amount.
For more information, see [Set payout limits](/docs/settings/manage-payment-gateways#set-payout-limits).
  1. Optionally, to set the order in which payout methods are used for processing: In the right of the page, in the **Allocation order** section, press and drag the payout methods to set allocation priority.
  2. Optionally, to reset the order of payout methods to the default: In the right of the page, in the **Allocation order** section, press **Refresh**. 
For more information, see [Set default payout allocation order](/docs/settings/organizations-and-websites#set-default-payout-allocation-order).
  3. In the top right, press **Auto allocate**.

To allocate the payout request amount manually, across multiple payment instruments and gateways:
  1. In the **New allocations** table, in the **Allocation** field, enter the amounts to allocate to the payment instruments and gateways.
  2. In the bottom of the table, press **Add allocations**.
  3. Optionally, if the entire payout request amount is not allocated, repeat steps 1 and 2 to allocate the remaining amount.


Manually allocate funds for a payout request in a batch
Use this process to manually allocate funds for a specific payout request that is in a batch.
To automatically allocate funds in bulk, see [Manage batches](#manage-batches).

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout request batches**.
3. In the **ID** column, press the batch ID that contains the payout request to which you want to allocate funds.
4. In the **Payout request ID** column, press the payout request ID to which you want to allocate funds.
5. In the **New allocations** table, enter the amounts to allocate to the associated payment instruments and gateways.
6. In the bottom of the table, press **Add allocations**.
7. Optionally, if the entire payout request amount is not allocated, repeat steps 5 and 6 to allocate the remaining amount.


### Approve a payout request

To approve a payout request, see [Review a payout request](#review-a-payout-request).
To approve a batch of payout requests, see [Manage batches](#manage-batches).

### Undo approval

Use this process to undo the approval of a payout request and return it to the `ready` status.
This action is available for payout requests that are in the `approved` status.

Select from the following:

Undo approval of a payout request
1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout requests**, then in the **ID** column, press a payout request ID.
3. In the right of the page, press **Undo approval**.
4. In the confirmation dialog, press **Confirm**.


Undo approval of a payout request in a batch
Use this process to manually undo the approval of a specific payout request that is in a batch.
For more information, see [Batch payout requests](#batch-payout-requests).

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout request batches**.
3. In the **ID** column, press a batch ID of the batch that contains the payout request.
4. In the **Payout request ID** column, press the payout request ID to which you want to undo the approval.
5. In the right of the page, press **Undo approval**.
6. In the confirmation dialog, press **Confirm**.


### Add a payout request to an existing batch

Use this process to add a single payout request to an existing batch.
This action is available for payout requests that are not already assigned to a batch.

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout requests**, then in the **ID** column, press a payout request ID.
3. In the right of the page, press **Add to existing batch**.
4. In the **Target batch** dropdown, select a batch.
5. Press **Add to batch**.


### Remove a payout request from a batch

Use this process to remove a single payout request from a batch.
The payout request remains available for another batch.
This action is available for payout requests that are assigned to a batch.

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout requests**, then in the **ID** column, press a payout request ID.
3. In the right of the page, press **Remove from batch**.
4. In the confirmation dialog, press **Remove from batch**.


### Add payment instrument to a payout request

Use this process to add a payment instrument to a payout request.
This process generates a link that can be shared with the customer to add a payment instrument to the payout request.
This action is available for payout requests that are in the `pending` or `ready` status when no payment instrument is assigned.

Select from the following:

Add a payment instrument to a payout request
1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout requests**, then in the **ID** column, press a payout request ID.
3. In the right of the page, press **Add payment instrument**.
4. Copy and share the link with the customer.
5. The customer adds a payment instrument to the payout request by visiting the link. 
The link expires after 24 hours.


Add a payment instrument to a payout request in a batch
Use this process to add a payment instrument to a specific payout request that is in a batch.
For more information, see [Batch payout requests](#batch-payout-requests).

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout request batches**.
3. In the **ID** column, press the batch ID that contains the payout request to which you want to add a payment instrument.
4. In the **Payout request ID** column, press the payout request ID to which you want to add a payment instrument.
5. In the right of the page, press **Add payment instrument**.
6. Copy and share the link with the customer.
7. The customer adds a payment instrument to the payout request by visiting the link. 
The link expires after 24 hours.


### Block a payout request

Use this process to temporarily block actions on a payout request.
For example, block a payout request that requires further investigation.
Reasons for further investigation include:

- Suspected fraud
- Know Your Customer (KYC) verification
- Anti-Money Laundering (AML) review
- Account verification
- Duplicate requests
- Insufficient documentation
- Risk review


When you block a payout request, actions such as approval, allocation, processing, split, merge, and cancellation are not available.
These actions become available again when you unblock the request.
Cancellation of pending allocations is not available while the payout request is blocked.

A blocked payout request may still transition to the `fulfilled` status if allocation processing starts before the payout request is blocked.

This action is available for payout requests that are in the `pending`, `ready`, `approved`, or `in-progress` status.

Select from the following:

Block a payout request
1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout requests**, then in the **ID** column, press a payout request ID.
3. In the right of the page, in the **Details** section, press **Block**.
4. In the **Block reason** dropdown, select a reason.
5. Optionally, in the **Description** field, enter a description for the block.
6. Press **Block payout request**.


Block a payout request in a batch
Use this process to manually block a specific payout request that is in a batch.
To block a batch of payout requests, see [Manage batches](#manage-batches).

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout request batches**.
3. In the **ID** column, press a batch ID of the batch that contains the payout request you want to block.
4. In the **Payout request ID** column, press the payout request ID you want to block.
5. In the right of the page, in the **Details** section, press **Block**.
6. In the **Block reason** dropdown, select a reason.
7. Optionally, in the **Description** field, enter a description for the block.
8. Press **Block payout request**.


### Unblock a payout request

Use this process to unblock a blocked payout request.
When a payout request is unblocked, actions such as approval, allocation, and processing are available.

This action is available for payout requests that are in the `blocked` status.

Select from the following:

Unblock a payout request
1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout requests**, then in the **ID** column, press a payout request ID.
3. In the right of the page, in the **Details** section, press **Unblock**.
4. In the confirmation dialog, press **Confirm**.


Unblock a payout request in a batch
Use this process to manually unblock a specific payout request that is in a batch.
To unblock a batch of payout requests, see [Manage batches](#manage-batches).

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout request batches**.
3. In the **ID** column, press a batch ID of the batch that contains the payout request you want to unblock.
4. In the **Payout request ID** column, press the payout request ID you want to unblock.
5. In the right of the page, in the **Details** section, press **Unblock**.


### Cancel a payout request

Use this process to cancel a payout request.
When a payout request is canceled, its `pending` allocations are canceled, and the payout request is moved to the `canceled` status.
For example, if the payout request was created in error or the customer no longer requires the payout.

This action is available for payout requests that are in the `pending`, `ready`, `approved`, or `in-progress` status.
A payout request cannot be canceled while any of its allocations are in the `queued`, `processing`, or `waiting-completion` status.

Select from the following:

Cancel a payout request
1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout requests**, then in the **ID** column, press a payout request ID.
3. In the top right, press **Cancel**.
4. In the **Canceled by** section, select **Customer** or **Merchant**.
5. In the **Cancellation reason** field, enter a reason for the cancellation.
6. Press **Cancel payout request**.


Cancel a payout request in a batch
Use this process to manually cancel a specific payout request that is in a batch.
For more information, see [Manage batches](#manage-batches).

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout request batches**.
3. In the **ID** column, press a batch ID of the batch that contains the payout request you want to cancel.
4. In the **Payout request ID** column, press the payout request ID you want to cancel.
5. In the top right, press **Cancel**.
6. In the **Canceled by** section, select **Customer** or **Merchant**.
7. In the **Cancellation reason** field, enter a reason for the cancellation.
8. Press **Cancel payout request**.


### Mark a payout request as ready

Use this process to skip the pending period and immediately assign the `ready` status to a payout request.
This action is available for payout requests that are in the `pending` status.

New payout requests may be configured to begin in the `ready` status.
If the initial payout request state is not configured, the default status is `ready`.
For more information, see [Edit payout request settings](/docs/settings/organizations-and-websites#edit-payout-request-settings).

Select from the following:

Mark a payout request as ready
Use this process to manually mark a specific payout request as ready.
To mark a batch of payout requests as ready, see [Manage batches](#manage-batches).

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout requests**, then in the **ID** column, press a payout request ID.
3. In the right of the page, press **Mark as ready**.
4. In the confirmation dialog, press **Confirm**.


Mark a payout request in a batch as ready
Use this process to manually mark a specific payout request that is in a batch as ready.
To mark a batch of payout requests as ready, see [Manage batches](#manage-batches).

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout request batches**.
3. In the **ID** column, press a batch ID of the batch that contains the payout request you want to mark as ready.
4. In the **Payout request ID** column, press the payout request ID you want to mark as ready.
5. In the right of the page, press **Mark as ready**.
6. In the confirmation dialog, press **Confirm**.


### Return to pending

Use this process to return a payout request to the `pending` status.
For example, if the customer needs to update their payment instrument.

This action is available for payout requests that are in the `ready` status.

Select from the following:

Return a payout request to the 'pending' status
1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout requests**, then in the **ID** column, press a payout request ID.
3. In the right of the page, press **Return to pending**.
4. In the confirmation dialog, press **Confirm**.


Return a payout request in a batch to the 'pending' status
Use this process to manually return a specific payout request that is in a batch to the `pending` status.
For more information, see [Manage batches](#manage-batches).

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout request batches**.
3. In the **ID** column, press a batch ID of the batch that contains the payout request you want to return to the 'pending' status.
4. In the **Payout request ID** column, press the payout request ID you want to return to the 'pending' status.
5. In the right of the page, press **Return to pending**.


### Process allocations

Use this process to process allocated funds for a payout request.
Processing allocations sends the allocated funds through the configured gateways to the payment instruments.

This action is available for payout requests that are in the `approved` status.

Select from the following:

Process allocations for a payout request
1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout requests**, then in the **ID** column, press a payout request ID.
3. Select from the following:
  - To process all pending allocations, press **Process all**.
  - To process a single allocation, in the **Allocations** table, on the right of the allocation, press **Process**.
  - To cancel a single allocation, in the **Allocations** table, on the right of the allocation, press **Cancel**. 
You can cancel an allocation only in the `pending` status.


Process allocations for a payout request in a batch
Use this process to manually process allocations for a specific payout request that is in a batch.
To process a batch of payout requests, see [Manage batches](#manage-batches).

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout request batches**.
3. In the **ID** column, press a batch ID of the batch that contains the payout request you want to process.
4. In the **Payout request ID** column, press the payout request ID you want to process.
5.   1. In the **New allocations** table, in the **Allocation** column, enter the amount for the new allocation.
  2. Press **Add allocation**.
6. In the **Allocations** table, on the right of the allocation, press **Process**. 
Alternatively, to process all allocations for the payout request, press **Process all**.


### Review a payout request

Use this process to review and approve a payout request.
This action is available for payout requests that are in the `ready` status.

To review a batch of payout requests, see [Manage batches](#manage-batches).

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout requests**.
3. Use this process to filter by payout requests that are ready for review.
  1. In the top right of the table, press **Filters**.
  2. In the **Filter** dropdown, select **Status**.
  3. In the **Operation** dropdown, select **is in**.
  4. In the **Value** field, select **ready**.
  5. Press **Apply filter**.
4. Select from the following:
  1. In the **ID** column, press a payout request ID. 
Ensure that the payout request has the `ready` status.
  2. Review the payout request details, such as the requested amount, currency, exposure amount, and payment instrument.

Use this process to manually review a specific payout request that is in a batch.
To review a batch of payout requests, see [Manage batches](#manage-batches).
  1. In the left navigation bar, press **Data tables**, then press **Payments**.
  2. Press **Payout request batches**.
  3. In the **ID** column, press a batch ID of the batch that contains the payout request you want to review.
  4. In the **Payout request ID** column, press the payout request ID you want to review.
  5. Review the payout request details, such as the requested amount, currency, exposure amount, and payment instrument.
5. Select one of the following actions:
When a payout request is approved, allocation of funds to payment instruments is available.
To approve a payout request: In the top right of the page, press **Approve**.
Canceling a payout request cancels its `pending` allocations.
To cancel a payout request: In the top right of the page, press **Cancel**.
When a payout request is blocked, approval, allocation, processing, split, merge, and cancellation are not available.
Cancellation of pending allocations is not available while the payout request is blocked.
To block a payout request: In the right of the page, press **Block**.
Sending a payout request to pending does not restart the pending period configured for the website.
To return a payout request to pending: In the right of the page, press **Return to pending**.


### Split a payout request

Use this process to split a payout request into multiple requests with different amounts.
Split a request when the full amount exceeds the amount restrictions, but a smaller amount does not.

For example, if a payout request for `$4,000` cannot be processed, but `$3,000` can be processed, split the request into two.
Use this approach to process the portion that can proceed without blocking the entire request.

The value of the original payout request is divided into the new payout requests.
The new payout requests are created in the `pending` status.
The parent payout request transitions to the `split` status.
The new requests must not exceed the value of the original payout request.

This action is available for payout requests that are in the `pending`, `ready`, or `approved` status.

Select from the following:

Split a payout request
1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout requests**, then in the **ID** column, press a payout request ID.
3. In the top right, press **Split**.
4. In the **Payout request 1** field, enter the amount you want to assign to the first payout request.
5. In the **Payout request 2** field, enter the amount to assign to the second payout request.
To remove an amount, press **Delete**.
6. Optionally, to split the payout request into more than two payout requests, press **Add another amount** and assign an amount to the payout request.
7. In the **Split reason** field, select one of the following reasons:
  - Payment instrument limit
  - Processor limit
  - Risk review
  - Compliance review
  - Partial processing
  - Operational reconciliation
  - Other
8. Optionally, in the **Description** field, provide additional information on why the payout request was split.
9. Press **Split**.
The total of all amounts must equal the amount of the original payout request.


Split a payout request in a batch
Use this process to split a specific payout request that is in a batch.
For more information, see [Manage batches](#manage-batches).

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout request batches**.
3. In the **ID** column, press a batch ID of the batch that contains the payout request you want to split.
4. In the **Payout request ID** column, press the payout request ID you want to split.
5. In the top right, press **Split**.


## View payout requests

Use this process to view payout requests.
To view payout requests in a batch, see [View batches](#view-batches).

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout requests**, then in the **ID** column, press a payout request ID.


## View payout allocations

Use this process to view payout allocations.

1. In the left navigation bar, press **Data tables**, then press **Payments**.
2. Press **Payout allocations**.
3. To view a single allocation, in the **Payout request ID** column, press a payout request ID.
4. In the **Allocations** table, on the right of the allocation, press **View**.


## Filter payout requests

Use this process to filter payout requests by their current status.

Filter by `batch ID`, `block reason`, `blocked`, `created time`, `customer ID`, `split reason`, `status`, `updated time`, `website ID`.
Apply multiple filters at the same time.

1. In the left navigation bar, press **Data tables**, press **Payments**, then press **Payout requests**.
2. In the top right of the table, press **Filters**.
3. In the **Filter** dropdown, select **Status**.
4. In the **Operation** dropdown, select **is in**.
5. In the **Value** field, select one or more of the following:
  - **Pending**: The payout request is in the pending period configured for the website when automatic transition is enabled. \
New payout requests may be configured to begin in the `ready` status.
If the initial payout request state is not configured, the default status is `ready`.
For more information, see [Edit payout request settings](/docs/settings/organizations-and-websites#edit-payout-request-settings).
  - **Ready**: The pending period is complete, and the payout request is ready for approval.
  - **Approved**: The payout request is approved, and funds are ready to allocate.
  - **In-progress**: Allocations are being processed.
  - **Fulfilled**: The payout request is paid in full.
  - **Canceled**: The payout request is canceled.
  - **Split**: The payout request is split into multiple child payout requests.
  - **Merged**: The payout request is merged from a split.
6. Press **Apply filter**.
7. Optionally, to create a new segment based on the filtered data, press **Save segment as**.
Then, enter a name for the new segment, and press **Save**.


## Related topics

- [Edit payout request settings](/docs/settings/organizations-and-websites#edit-payout-request-settings)
- [Set up a gateway](/docs/settings/set-up-a-gateway)
- [Set payout limits](/docs/settings/manage-payment-gateways#set-payout-limits)
- [Payout method configuration](/docs/settings/payout-method-configuration)
- [Ready to payout requested](/docs/automations/event-types#ready-to-payout-requested)
- [Customize tables](/docs/data-tables/customize-tables)
- [Payments](/docs/data-tables/manage-payments)
- [Segments](/docs/settings/segments)