Last updated

This page describes how to configure which payout methods are displayed to the customer in a payout form and the order in which they are displayed.

Rules are configurations that are triggered by events, such as a customer requesting a payout. When a customer requests a payout, the ready to payout event is triggered, and depending on the configuration in the rule, the payout method configuration is applied. Creating payout method configurations adds rules to the ruleset of the Ready to payout requested event.

Configure methods to display in a payout form

This process describes how to create payout method configuration. Payout method configurations are created as rules that are added to the ruleset of the Ready to payout requested event.

  1. In the left navigation bar, press Settings .

  2. In the Payment forms section, press Payout method configuration.

  3. Select from the following:

    • Create a rule - rules can stop subsequent rules in the event list from being processed
      1. Press Create rule.
      2. In the Rule name field, enter a name for your rule.
      3. Optionally, to add labels that help you identify the rule: In the Labels field, add one or more labels.
      4. Optionally, to specify that when this rule occurs, subsequent rules in the event list are not processed, select the Stop further processing checkbox.
    • Create a bind - binds always execute regardless of rule based events
      1. Press Create bind.
      2. In the Bind name field, enter a name for your bind.
  4. Optionally, specify conditions for when the payout method configuration is displayed
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Select filter dropdown, select a filter.
    3. In the next field, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the next field, enter or select values.
    5. Press Add filter.
  5. In the Actions section, press Add action, then select Adjust ready to payout.

  6. Press + Add payout method, select a payout method, then press Add.
    Available payout methods are based on your active payout gateways.
    To set up a new payout gateway, or to add or remove payout methods for an existing payout gateway, see Set up a payout gateway.

  7. Optionally, to add another payout method, press + Add payout method, select a payout method, then press Add.

  8. Optionally, to prioritize payout methods that are associated with a customer's active payout instruments, select the Prioritize active payout instruments checkbox.
    At the point of payout, these methods are displayed at the top of the list of available payout methods.

  9. Drag and drop payout methods to set the display order.

  10. Press Save rule or Save bind.

Copy payout method configuration rules into a draft ruleset

Each event maintains a list of rules and binds that are to be executed under specified conditions when the event occurs. These lists are called rulesets. Rulesets are executed in the order they are listed on the event. Draft rulesets provide a means of testing and comparing changes with the active ruleset before publishing. To edit draft rulesets, see Edit draft rulesets.

Use this process to copy payment method configurations into a draft ruleset of the Ready to payout requested event.

  1. In the left navigation bar, press Settings .
  2. In the Payment forms section, press Payout method configuration.
  3. Press Copy into draft.
  4. In the Name field, enter a name for the draft ruleset.
  5. In the Description field, enter a description for the draft ruleset.
  6. Optionally, to designate the current ruleset as the starting point for your draft ruleset, select the Copy current ruleset checkbox.
  7. Press Save ruleset.

View payout method configuration rules

  1. In the left navigation bar, press Settings .
  2. In the Payment forms section, press Payout method configuration.
  3. Press Rules or Binds.