Manage payout requests ExperimentalThis feature is experimental and may change.

This topic describes how to manage customer payout requests. Customers can request payout amounts that they want to receive. 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.

This procedure describes the payout request process.

1. A payout request is created using a payout form and the customer adds or selects a payment instrument for the payout. 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.

   • 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, Split, Block, Cancel, Add payment instrument(applicable only to payout requests in the pending status)

2. The payout request is ready for review. For more information, see Review a payout request.

   Available actions: Approve, Split, Return to pending, Block, Cancel

3. A member of your organization reviews and approves the payout request and is assigned the approved status. The payout request is approved and funds can be allocated. For more information, see Review a payout request.

   Available actions: Allocate funds, Split, Block, Cancel

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 and Process allocations

   Available actions: Process, Block, Cancel

5. The allocations have been processed. The payout request is fulfilled and is assigned the fulfilled status.

Use batches to approve, allocate, process, cancel, or block multiple payout requests at once instead of processing each request individually.

You can create a batch from any payout request status and include payout requests with different statuses in the same batch.

Use this process to create a batch of payout requests.

1. In the left navigation bar, press Data tables, then press Payments.

2. Press Payout requests.

3. Select from the following:

   Manually add specific payout requests to a batch

   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 Create batch.
   3. Select Selected rows, then press Create batch.
   Add payout requests that match a filter to a batch

   This process describes how to add all payout requests that have the pending status to a batch. For more information, see Filter payout requests.

   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 pending.
   5. Press Apply filter.
   6. In the top of the table press Create batch.
   7. Select Current filter, then press Create batch.

Use this process to mark payout requests as ready, review, approve, allocate, process, block, or unblock a batch of payout requests. To create a batch of payout requests, see 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:

   Mark payout requests in a batch as ready

   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.

   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.
   Review payout requests in a batch

   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 .
      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.
   Automatically allocate funds for a batch

   This action is available when payout requests in the batch are in the approved status.

   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 payout methods, 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.
   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.
   Process payout request allocations in a batch

   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.
   View completed payout requests in a batch

   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.
   Block or unblock a batch

   This action is available for payout requests in all statuses.

   Select from the following:

   Block a batch

   To block a batch: In the top right of the page, press Block.
   Alternatively, to block a specific payout request in a batch, see Block a payout request.

   Unblock a batch

   Use this process to unblock a specific payout request in a batch.

   1. In the table, press Blocked.
   2. In the Payout request ID column, press the payout request ID you want to unblock.
   3. In the right of the page, press Unblock.

   View blocked batches

   To view blocked batches: In the top of the table, press Blocked.

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. Optionally, filter the batches by status

   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:

   View the details of the batch

   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.
   View the payout requests in the batch

   Each payout request in the batch displays status, payout request ID, customer, amount, and the date it was submitted.

   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.
   View the allocations of a batch of payout requests

   To view all allocations for all payout requests in the batch: In the top right of the table, press . To hide all allocations for all payout requests in the batch: In the top right of the table, press .

   Alternatively, to view the allocations for a single payout request, in the Payout request ID column, press a payout request ID.

   Filter payout requests in a batch

   Use this process to filter payout requests that are displayed in a batch based on specific criteria. For example, you can filter payout requests that are in a specific currency, associated with a specific customer, and more. 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.
   Refresh payout requests in a batch

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

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.

Use this process to create a payout request on a customer's behalf. This process also generates a link where the customer can add a payment instrument to the payout request. You can 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 , then press Request payout.
4. Optionally, if you have configured custom domains, in the Custom domain field, select a domain. For more information, see 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.
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.

This section describes how to manage payout requests. To manage multiple payout requests at once, see Batch payout requests.

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.

You can 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:

To approve a payout request, see Review a payout request. To approve a batch of payout requests, see Manage batches.

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:

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 status.

Select from the following:

Use this process to temporarily block actions on a payout request. For example, a payout request can be blocked if it requires further investigation, such as suspected fraud, Know Your Customer (KYC) verification, Anti-Money Laundering (AML) review, account verification, duplicate requests, insufficient documentation, or risk review.

When you block a payout request, actions such as approval, allocation, and processing are not available until the request is unblocked.

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

Select from the following:

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:

Use this process to cancel a payout request. When a payout request is canceled, pending or processing 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.

Select from the following:

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.

Select from the following:

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:

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:

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.

1. In the left navigation bar, press Data tables, then press Payments.

2. Press Payout requests.

3. Optionally, filter the payout requests by the `ready` status

   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:

   Review a payout request

   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.
   Review a payout request in a batch

   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.

   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:

   Approve the payout request

   Approving a payout request enables allocation of funds to payment instruments.

   To approve a payout request: In the top right of the page, press Approve.

   Cancel the payout request

   Canceling a payout request cancels any pending or processing allocations.

   To cancel a payout request: In the top right of the page, press Cancel.

   Block the payout request

   Blocking a payout request prevents approval, allocation, and processing.

   To block a payout request: In the right of the page, press Block.

   Return to pending

   Sending a payout request to pending doesn't 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.

Use this process to split a payout request into multiple requests with different amounts. Split requests when the full amount cannot be processed due to amount restrictions, but a smaller amount can be processed.

For example, if a payout request for $4,000 cannot be processed, but $3,000 can be processed, split the request into two. This allows you 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, and the new requests cannot 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:

Use this process to view payout requests. To view payout requests in a batch, see 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.

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.

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

You can filter by batch ID, block reason, blocked, created time, customer ID, split reason, status, updated time, website ID. You can also apply multiple filters.

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 can 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.

   • Ready: The pending period is complete, and the payout request is ready for approval.
   • Approved: The payout request is approved and funds can be allocated.
   • 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.

• Edit payout request settings
• Set up a gateway
• Payout method configuration
• Ready to payout requested
• Customize tables
• Payments
• Segments