Strike icon

Strike

Interact with Strike API for Bitcoin and Lightning payments

Payout → Initiate

AI-generated

Summary

Initiate a payout by sending a PATCH request to the Strike API to trigger the payout process for a specified payout ID.

Inputs

  • Payout ID (required) — The unique identifier of the payout to initiate.

Output shape

a single record containing the updated payout details after initiation

The output returns the payout object as returned by the Strike API after initiating the payout. Errors may be returned in an error envelope if the operation fails and 'continue on fail' is enabled.

Examples

Example 1: Initiate payout with ID 'payout_1234567890abcdef'

Set Resource to 'Payout', Operation to 'Initiate', and provide 'payout_1234567890abcdef' as the Payout ID input.

Discussion