Payouts
Update a payout
Update details of a specific payout.
PATCH
/
payouts
/
{id}
curl --request PATCH \
--url https://api.sulu.sh/v0/payouts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"status": "pending",
"metadata": {},
"transferredAmountInCents": 123,
"transactionId": "<string>",
"failureCode": "<string>",
"failureMessage": "<string>"
}'
{
"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
200
application/json
Payout updated successfully
The response is of type object
.
curl --request PATCH \
--url https://api.sulu.sh/v0/payouts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"status": "pending",
"metadata": {},
"transferredAmountInCents": 123,
"transactionId": "<string>",
"failureCode": "<string>",
"failureMessage": "<string>"
}'
{
"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
}
Assistant
Responses are generated using AI and may contain mistakes.