Payout
POST
/payoutsCreate
Body — 1:1 with CreatePayoutDTO. Required: currency, bank_account_id, amount, and the owner: account (acct_…, paid from its own balance when balance_id is omitted) or, deprecated, customer_id + balance_id (both required only when account is omitted).
Request
Example
curl -X POST 'https://api.paycose.com/api/v1/app1/platform/wallet/payouts/' \
-H 'X-Session-Token: {{session_token}}' \
-H 'X-Country: {{country}}' \
-H 'X-Test-Mode: {{x_test_mode}}' \
-d '{
"account": "{{account_id}}",
"customer_id": "<string>",
"currency": "USD",
"balance_id": "<string>",
"bank_account_id": "{{bank_account_id}}",
"amount": 1000,
"application_fee_amount": 0,
"application_fee": 0,
"metadata": {},
"forex_quote_id": "<string>",
"allow_overpay": false,
"labels": [
"<string>"
]
}'Headers
| Name | Value | Description |
|---|---|---|
| X-Session-Token | {{session_token}} | |
| X-Country | {{country}} | |
| X-Test-Mode | {{x_test_mode}} | true=wallet_test, false=wallet_live (default). Toggle the x_test_mode collection variable to flip every applicable request. |
Body
| Name | Type | Value |
|---|---|---|
| account | string | {{account_id}} |
| customer_id | string | <string> |
| currency | string | USD |
| balance_id | string | <string> |
| bank_account_id | string | {{bank_account_id}} |
| amount | number | 1000 |
| application_fee_amount | number | 0 |
| application_fee | number | 0 |
| metadata | object | {…} |
| forex_quote_id | string | <string> |
| allow_overpay | boolean | false |
| labels | array | [1] |
{
"account": "{{account_id}}",
"customer_id": "<string>",
"currency": "USD",
"balance_id": "<string>",
"bank_account_id": "{{bank_account_id}}",
"amount": 1000,
"application_fee_amount": 0,
"application_fee": 0,
"metadata": {},
"forex_quote_id": "<string>",
"allow_overpay": false,
"labels": [
"<string>"
]
}Responses
200200 OK
Headers
| Name | Value |
|---|---|
| Content-Type | application/json |
Body
{
"id": "<string>",
"object": "<string>",
"livemode": false,
"created_at": null,
"updated_at": null,
"customer_id": "<string>",
"bank_account_id": "<string>",
"balance_id": "<string>",
"amount": 0,
"application_fee_amount": 0,
"account": "<string>",
"application_fee": "<string>",
"plane": "<string>",
"connected_settlement": "<string>",
"net_amount": 0,
"currency": "<string>",
"scaling_factor": 0,
"manual": {
"file_id": "<string>",
"reference_id": "<string>",
"verified": false
},
"approved_by": "<string>",
"approved_by_type": "<string>",
"approved_at": "<RFC3339 timestamp>",
"request_sent_to_bank_at": "<RFC3339 timestamp>",
"instruction_state": "<string>",
"status": "<string>",
"paid": false,
"sent": false,
"canceled": false,
"failed": false,
"failure_code": "<string>",
"failure_message": "<string>",
"provider": "<string>",
"reference_id": "<string>",
"metadata": {},
"labels": "<core.Labels>",
"customer": {
"id": "<string>",
"object": "<string>",
"livemode": false,
"created_at": null,
"updated_at": null,
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"address": {
"city": "<string>",
"country": "<string>",
"line1": "<string>",
"line2": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"shipping": {
"name": "<string>",
"phone": "<string>",
"address": {
"city": "<string>",
"country": "<string>",
"line1": "<string>",
"line2": "<string>",
"postal_code": "<string>",
"state": "<string>"
}
},
"is_system": false,
"is_application_customer": false,
"capabilities": {
"charge": false,
"transfer": false,
"payout": false
},
"tax_ids": [
{
"type": "<string>",
"value": "<string>",
"country": "<string>",
"verification_status": "<string>"
}
],
"metadata": {},
"labels": "<core.Labels>",
"invoice_settings": {},
"tax_exempt": "<string>",
"preferred_locales": [
"<string>"
],
"business_name": "<string>",
"currency": "<string>"
}
}400400 Bad Request
Headers
| Name | Value |
|---|---|
| Content-Type | application/json |
Body
{
"object": "error",
"code": "<string>",
"key": "<string>",
"i18n_key": "<string>",
"message": "<string>",
"request_id": "<string>"
}