Create A Payout Method

 

In this section, you will learn how to:

  1. Submit your submerchant's payout method information using the Legal Entity ID in a POST /payout_methods API request
  2. Find the Payout Method ID in the id parameter on the API response

The Payout Method that you'll create here represents the submerchant's bank account that they wish their funds to be dispersed to. You'll need to provide your submerchants with an online form to submit their data. Note that your form should also collect the cadence by which the submerchant would like to be paid out (daily, weekly, monthly). Store this selection to use in step 3.

Once you have the payout method data, send a POST /payout_methods request with the Legal Entity ID received in step 1.

Required Payout Method Fields

Download .xls
Click to view all required Payout Method fields
FieldRequirement
legal_entity_idrequired
nicknamerequired
typerequires payout_bank_us value
custom_dataoptional
payout_bank_usrequired
Fields nested in the payout_bank_us object
account_numberrequired
account_typerequired
routing_numberrequired
Fields nested in the rbits object are not applicable
Fields nested in the token object, if applicable
idrequired
permissioned_fieldsoptional
Unique-Key headeroptional
WePay-Risk-Token headerconditionally required if tokenizing without the WePay JS
Client-IP headerconditionally required if tokenizing without the WePay JS

A request may look like this:

Copy
Copied
curl -X POST \
  --url 'https://stage-api.wepay.com/payout_methods' \
  -H 'App-Id: App-Id'\
  -H 'App-Token: App-Token'\
  -H 'Accept: application/json'\
  -H 'Api-Version: 3.1'\
  -H 'Content-Type: application/json' \
  --data-raw '{
    "legal_entity_id": "{id-from-step-1}",
    "nickname": "nickname6",
    "payout_bank_us": {                   //you can tokenize a payout bank account, too
      "account_number": "account_number",
      "account_type": "checking",
      "routing_number": "routing_number"
    },
    "type": "payout_bank_us"
  }'
If you would like to tokenize the payout bank account, follow this guide and replace the payout_bank_us parameter with the token parameter, and the type value with token.The response to your POST /payout_methods request will contain a Payout Method ID in the id response parameter. You'll associate the Payout Method ID with the submerchant's Account in the next step.