Create a beneficiary
POST
/v1/beneficiaries请求参数
Body Params application/json
entity
object
optional
The entity who receives the payout.
type
string
required
One of "business" or "individual" is required
business
object
optional
Conditional required: one of "business" or "individual" is required
individual
object
optional
Conditional required: one of "business" or "individual" is required
destination_data
object
required
Create a new card or bank account for payouts was sent to.
destination_type
string
required
Can be bank_account
(for company) or card
(for individual)
bank_account
object
optional
Condtional requried, one of card and bank_account is required.
card
object
optional
Condtional requried, one of card and bank_account is required.
nickname
string
optional
Nickname of beneficiary for quickly retrieving
metadata
object
optional
Set of key-value pairs attaching to an object. This can be a channel for customers that provides additional material about the beneficiary
livemode
boolean
optional
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Example
{
"entity": {
"type": "individual",
"individual": {
"address": {
"city": "seattle",
"country": "US",
"line1": "422 Ave",
"state": "Washington",
"postal_code": "98109"
},
"additional_info": {
"email": "liuyidao@126.com",
"phone": "12093321241",
"last_name": "Wick",
"first_name": "John",
"id_type": "social_security",
"id_country_iso_code": "US",
"id_number": "WA112313411"
}
}
},
"nickname": "test2",
"destination_data": {
"destination_type": "bank_account",
"bank_account": {
"country": "US",
"currency": "USD",
"swift": "ABOCUSSE080",
"account_holder_name": "Bill Han",
"account_holder_type": "individual",
"routing_number": "1051000017",
"account_number": "123123123",
"bank_name": "Bank of America"
}
}
}
示例代码
Responses
OK(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
Data Schema
No schema defined
Example
Not configured
Last modified: 4 个月前