Payouts
Create a new payout
Payouts
Create a new payout
Create a new payout for an organization.
POST
/
payouts
curl --request POST \
--url https://api.sulu.sh/v0/payouts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"organizationId": "<string>",
"description": "<string>",
"amountInCents": 123,
"currency": "<string>",
"method": "bank_transfer",
"sourceId": "<string>",
"destinationId": "<string>",
"metadata": {}
}'
{
"id": "<string>",
"object": "payout",
"organizationId": "<string>",
"status": "pending",
"description": "<string>",
"amountInCents": 123,
"currency": "<string>",
"method": "bank_transfer",
"sourceId": "<string>",
"destinationId": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"platformFee": 123,
"methodFee": 123,
"transactionId": "<string>",
"failureCode": "<string>",
"failureMessage": "<string>",
"transferredAmountInCents": 123
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
201
application/json
Payout created successfully
The response is of type object
.
curl --request POST \
--url https://api.sulu.sh/v0/payouts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"organizationId": "<string>",
"description": "<string>",
"amountInCents": 123,
"currency": "<string>",
"method": "bank_transfer",
"sourceId": "<string>",
"destinationId": "<string>",
"metadata": {}
}'
{
"id": "<string>",
"object": "payout",
"organizationId": "<string>",
"status": "pending",
"description": "<string>",
"amountInCents": 123,
"currency": "<string>",
"method": "bank_transfer",
"sourceId": "<string>",
"destinationId": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"platformFee": 123,
"methodFee": 123,
"transactionId": "<string>",
"failureCode": "<string>",
"failureMessage": "<string>",
"transferredAmountInCents": 123
}