Payouts
Cancel an end-user custodial Payout Request
Changed onCancels a Payout Request.
post/api/payouts/payout/end-user-custodial/cancel/{id}
Request
- Base URLhttps://api.muralpay.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
Payout request ID
Headers
on-behalf-ofstring required
Organization ID to act on behalf of
idempotency-keystring uuid
Optional UUID to safely retry requests without creating duplicate operations. Subsequent requests with the same key and identical body return the original cached response with an idempotency-replayed: true response header. Keys expire after 24 hours.
Response
Successfully canceled Payout Request
Changes
- warning
added the new
SignedAgreementRequiredExceptionenum value to theresponse property for the response status - info
added the non-success response with the status
- info
added the non-success response with the status
- warning