Cancel payout

View as Markdown
Cancels a pending payout by marking it as canceled. Only payouts in CREATED status can be canceled. Once a payout is approved or initiated, it can no longer be canceled.

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

Path parameters

payout_idstringRequiredformat: "uuid"

Response

Payout canceled successfully

Errors

404
Not Found Error