PATCH /payout-request-allocations/{id}

Updates the status of a payout request allocation with a specified ID.

Only the processing and canceled statuses can be set with this operation. The processing status transitions an allocation from pending when payment processing begins. The canceled status stops the allocation before it is processed.

The completed and failed statuses are set automatically during transaction processing. Allocations are always created in the pending status.

Servers

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
status String Yes

New status for the allocation. Use processing to move an allocation from pending to processing, which begins payment processing. Use canceled to stop the allocation before it is processed.

Valid values:

  • "processing"
  • "canceled"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.