Create A Payout Method
In this section, you will learn how to:
- Submit your submerchant's payout method information using the Legal Entity ID in a
POST /payout_methods
API request - 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 aPOST /payout_methods
request with the Legal Entity ID received in step 1.Required Payout Method Fields
Download .xlsClick to view all required Payout Method fields
Field | Requirement |
---|---|
legal_entity_id | required |
nickname | required |
type | requires payout_bank_us value |
custom_data | optional |
payout_bank_us | required |
Fields nested in the payout_bank_us object | |
account_number | required |
account_type | required |
routing_number | required |
Fields nested in the rbits object are not applicable | |
Fields nested in the token object, if applicable | |
id | required |
permissioned_fields | optional |
Unique-Key header | optional |
WePay-Risk-Token header | conditionally required if tokenizing without the WePay JS |
Client-IP header | conditionally required if tokenizing without the WePay JS |
A request may look like this:
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"
}'
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.