API Reference

Initialize payout

post
https://example.com/v1/pay/payout/initialize

Initialize a new payout to a beneficiary. The payout request requires the x-starks-signature header. The value of this header is a HMAC SHA512 signature of the request body signed using your secret key. Verifying the header signature is done before processing your request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Details of the payout to initialize

number
required
≥ 0.01
string
enum
required
uuid
required
string
string

User-provided reference for the payout

Headers
string
required
length ≥ 1

Starks API Key for authentication

Responses

Updated 7 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago