Data tables
/
Manage payments
/
Payout requests
Last updated

Payout requests

This topic describes how to view and allocate customer requested payouts. Customers can make requests for payout amounts that they want to receive. Users, or members, of your organization manage these requests by assigning funds to be paid out to specified payment instruments.

All payout request are added to the Payout requests segment which is located in the Payments data table. This segment has no filters and will show all payout requests. To apply filters, see Filter payout requests.

Payout request process

This procedure describes a typical payout request process.

  1. A payout request form URL is generated on the customers behalf and is shared with the customer — see Request a payout.
  2. The customer provides a payment instrument for the payout request.
  3. The payout request is processed and funds are allocated to the related payment instrument — see Allocate funds.

View payout requests

Use this process to view customer payout requests.

  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.

Filter payout requests

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

  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: Payout request is created but the customer has not responded.
    • Instrument-selected: Payout request is created and the customer has selected their payment instrument.
    • Partially-fulfilled: Payout request is partially paid.
    • Fulfilled: Payout request is paid in full.
  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.

A segment is a filtered view of a data set. To add or manage segments, or to apply or edit filters on a segment, see Segments.

Allocate funds

Use this procedure to process a customer's payout request and to allocate funds to the related payment instrument.

To retry an allocation, repeat this process. You may retry the allocation on the same payment instrument, or choose a new payment instrument.

  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.
    In the table, all available payment instruments that can receive a payout are displayed. Specific payment instruments may be displayed more than once if they have been processed through separate gateways. Each line in the table represents different exposure on the specific payment instrument.
  3. In the Allocate field, enter the amount you want to payout to a specific payment instrument and through a specific gateway. You may choose payment instruments which have not been used yet.
  4. In the top right, to allocate the funds to the payout request, press Allocate.

Cancel a payout request

Use this process to cancel a payout request. A payout request can only be canceled if it has the pending or instrument-selected 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 top right, press Cancel.
  4. In the Cancellation reason field, enter a reason for the cancellation.
  5. In the Canceled by section, specify if the payout request was canceled by the customer or merchant.
  6. Press Cancel payout request.

Request a payout

Use this process to generate a payout request form link and to share it with a customer. Payout request forms enable customers to select a payment instrument for their payout. The unique link can be used in customer emails or live chat. This process is often used by Customer Support Representatives.

To generate a request payout link for a customer:

  1. In the navigation bar, press Data tables, and press Customers.
  2. In the list of customers, select the customer that you would like to share the request payout link with.
  3. In the top right of the screen, 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 Generate URL.
  10. Copy the URL and share it with the customer.

Provide a payment instrument for a payout request

This process describes how the customer provides a payment instrument for a payout request that is generated on their behalf, using the Request a payout procedure.

  1. The customer visits a URL that is generated using the Request a payout procedure.
  2. The customer select a payment instrument or enters a new payment instrument.
  3. The customer clicks Continue to submit the payout request.

Configure a gateway for payouts

To configure how a gateway manages payout requests, set the ready to payout instruction in gateway account settings. For more information, see Set up a gateway for payments.

Configure payout methods

To configure which payment methods are displayed when a customer requests a payout, see Adjust ready to payout.

Previous page
Next page