POST /storefront/payout-requests

Creates a payout request.

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

ID of the cashier resource that sends the payout request.

amount Number Yes

Amount of the payout.

paymentInstrumentId String Yes

ID of the requested payment instrument to offer for the payout.

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.