The POST /payout_methods call allows your platform to create a new payout method owned by a legal entity. Payout methods represent payout targets, such as bank accounts.
Api-Version required | string Example: 3.0 |
Content-Type required | stringapplication/json Example: application/json |
Unique-Key | string |
WePay-Risk-Token | string This header is required when tokenizing Payment Methods, Legal Entities, and Payout Methods when the tokenization JS library is not being used. |
Client-IP | string This header is required when tokenizing Payment Methods, Legal Entities, and Payout Methods when the tokenization JS library is not being used. |
legal_entity_id required | string [ 1 .. 255 ] characters ID of the object or resource. | ||||||
nickname required | string [ 1 .. 64 ] characters | ||||||
type required | string Possible values:
| ||||||
object or null Any custom data your platform chooses to attach to this resource. The custom data must be key-value pairs and not contain any personally identifiable information (PII) or payment card (PCI) data. | |||||||
object Define how to payout a merchant based in the US via paper check. Note: Paper checks require permission from WePay, and only US-based merchants can receive payouts via paper check. Reach out to your integration team for further information. | |||||||
object | |||||||
object | |||||||
object | |||||||
object A Plaid processor token to make Plaid API calls. | |||||||
Array of objects or null Any rbit data your platform chooses to attach to this resource. The rbit data must be key-value pairs and can be an array of rbit objects. | |||||||
object A previously created token. Note: Using tokens to pass highly-sensitive data directly to WePay may help your platform avoid certain compliance and regulatory overhead. Learn more about tokens here. |
resource required | string Helps organize information by identifying the resource type of the object data.
| ||||||
id required | string The ID of the payout method, generated by WePay when the payout method is created. | ||||||
path required | string The path of resource and resource ID. | ||||||
api_version | string | ||||||
create_time | integer <int64> >= 0 The time (in UNIX) when the payout method was created. | ||||||
object or null Any custom data your platform chooses to attach to this resource. The custom data must be key-value pairs and not contain any personally identifiable information (PII) or payment card (PCI) data. | |||||||
nickname | string [ 1 .. 64 ] characters The nickname of the payout method. | ||||||
object Details the owner resource and owner path. | |||||||
object Define how to payout a merchant based in the US via paper check. Note: Paper checks require permission from WePay, and only US-based merchants can receive payouts via paper check. Reach out to your integration team for further information. | |||||||
object Contains parameters relevant to the payout method. | |||||||
object Contains parameters relevant to the payout method. | |||||||
object Contains parameters relevant to the payout method. | |||||||
status | string Describes the status of the payout method. Possible values include:
| ||||||
type | string Possible values:
|
INVALID_PARAMS, MERCHANT_ACCOUNT_CANNOT_ACCEPT_PAYMENTS
NOT_AUTHORIZED
UNEXPECTED_ERROR
{- "custom_data": {
- "my_key": "invoice #54321"
}, - "legal_entity_id": "42d2c2f1-5aeb-4929-944f-e220b4c9425b",
- "nickname": "bofa checking 6789",
- "type": "plaid_processor_token",
- "plaid_processor_token": {
- "processor_token": "processor-sandbox-0asd1-a92nc",
- "plaid_account_id": "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D"
}
}
{- "create_time": 1480700534,
- "custom_data": null,
- "id": "0102b1c6-2bc7-448a-aa1d-076b1637547c",
- "nickname": "Foo Bar Bank",
- "owner": {
- "id": "3cd20b3c-4008-400b-b708-2b844ce7be84",
- "path": "/legal_entities/3cd20b3c-4008-400b-b708-2b844ce7be84",
- "resource": "legal_entities"
}, - "path": "/payout_methods/0102b1c6-2bc7-448a-aa1d-076b1637547c",
- "payout_bank_us": {
- "account_type": "checking",
- "last_four": "4739"
}, - "resource": "payout_methods",
- "status": "active",
- "type": "payout_bank_us",
- "api_version": "3.0"
}