Create a payout
POST/v1/payouts请求参数
Three-letter ISO currency code, in lowercase.
Conditional required. Amount (in cents) to be transferred to your bank account or debit card.
Source currency, i.e. the currency that the Payer uses to fund the payment
Conditional required. Source amount in source_currency
An arbitrary string attached to the object. Often useful for displaying to users.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
The type what the payouts is，it can be "local","global" and 'to_China'
ID of the beneficiary the payout was sent to. Conditional required: one of beneficiary and beneficiary_data are required.
Beneficiary details of the payout are added if there is no existing one. Conditional required: one of beneficiary and beneficiary_data are required.
A list of payment intent id attached to this payout object.
{
"payment_amount": 1000,
"payment_currency": "GBP", //the currency that the beneficiary receives
"source_currency":"USD", //the currency that the Payer uses to fund the payment
"type": "global",
"beneficiary_data": {
"entity": {
"type": "business",
"company_registered_name": "Wooshpay",
"business": {
"address": {
"city": "seattle",
"country": "US",
"line1": "422 Ave",
"state": "Washington",
"postal_code": "98109"
},
"additional_info": {
"business_area": "",
"business_phone_number": "12093321241",
"business_registration_number": "WF123123131",
"legal_rep_first_name": "John",
"legal_rep_last_name": "Wick",
"legal_rep_id_type": "social_security",
"legal_rep_id_number": "WA112312313411",
"legal_rep_email": "woosh@gmail.com",
"legal_rep_phone": "202312314"
}
}
},
"nickname": "test1",
"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
{
"id": "po_1597440940476203008",
"object": "payout",
"created": 1669694576000,
"currency": "CNY",
"amount": 666,
"description": "You can add description here",
"metadata": null,
"status": "pending",
"destination": {
"id": "ba_1597440945916215296",
"object": "bank_account",
"created": 1669694575000,
"country": "CN",
"currency": "CNY",
"customer": null,
"fingerprint": "eb5b68642b4eabe8c8adb110240150e5386cacea",
"last4": "0002",
"metadata": null,
"swift": null,
"account_holder_name": "xxxx ltd",
"account_holder_type": "company",
"bank_name": null,
"routing_number": null
},
"livemode": false,
"type": "bank_account",
"method": "standard",
"beneficiary": {
"id": "bf_1597440940492980224",
"object": "beneficiary",
"type": "business",
"business": {
"address": {
"city": "Beijing",
"country": "CN",
"line1": "Block 3A",
"line2": "XX Park",
"state": "Beijing",
"postal_code": "323111"
},
"company_registered_name": "XXX ltd",
"additional_info": {
"business_area": null,
"business_phone_number": null,
"business_registration_number": "32342353535334234MCA4",
"legal_rep_first_name": "Ming",
"legal_rep_last_name": "Zhang",
"legal_rep_id_type": "NATIONAL_ID",
"legal_rep_id_number": "233923874838920238X",
"legal_rep_email": "xxx@email.com",
"legal_rep_phone": "13727282938"
}
},
"payee": null
},
"balance_transaction": null,
"failure_balance_transaction": null,
"failure_code": null,
"failure_message": null,
"payment_intents_id": [
"pi_1577840204872417280"
],
"currency_account": null
}