PATCH /payout-requests/{id}
Updates a payout request with a specified ID. Use this operation to update the status, description, and blocked state.
Servers
- https://api-sandbox.rebilly.com/organizations/{organizationId}
- https://api.rebilly.com/organizations/{organizationId}
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
description |
String | No |
Description of the payout request. |
blockDescription |
String | No |
Additional description for blocking the payout request. |
blocked |
Boolean | No |
Specifies whether the payout request is blocked or unblocked.
This field can only be applied to payout requests in the following statuses:
When a payout request is blocked, it cannot:
|
status |
String | No |
Status of the request. Valid values:
|
blockReason |
Object | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.