The POST /payout_methods/{id}/verify_bank_deposits call allows your platform to verify a payout method. Payout methods represent payout targets, such as bank accounts.
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, PAYOUT_METHOD_CANNOT_BE_VERIFIED
NOT_AUTHORIZED
UNEXPECTED_ERROR
{- "microdeposits": [
- 7,
- 8
]
}
{- "id": "00000000-0000-0000-0000-000000000008",
- "resource": "payout_methods",
- "path": "/payout_methods/00000000-0000-0000-0000-000000000008",
- "owner": {
- "id": "9cdedade-fadd-ef62-bcca-e5bbe55d3797",
- "resource": "legal_entities",
- "path": "/legal_entities/9cdedade-fadd-ef62-bcca-e5bbe55d3797"
}, - "create_time": 1672904373,
- "nickname": "Another bank account US",
- "type": "payout_bank_us",
- "status": "verified",
- "payout_bank_us": {
- "account_type": "checking",
- "last_four": "6761"
}, - "custom_data": null,
- "api_version": "3.1"
}