API Reference

Execute a Payout Request

post
https://api.muralpay.com/api/payouts/payout//execute

Executes a Payout Request. A payout carrying a developer fee must belong to a child organization; if it does not, it cannot be executed and must be recreated.

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

Payout request ID

Body Params
string
enum
Defaults to FLEXIBLE

Exchange rate checking behavior for payout execution. FLEXIBLE: Execute the payout regardless of exchange rate changes. STRICT: Fail with PayoutQuoteExpiredException if rates have changed (see Errors section in documentation).

Allowed:
Headers
string

Organization ID to act on behalf of

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.

string
required

Transfer API key required to execute this request.

Responses

400

The payout request cannot be executed — for example, it carries a developer fee but does not belong to a child organization.

401

Unauthorized

409

TransactionInProgressError

IdempotencyConflictError

422

IdempotencyKeyExpiredError

Updated 5 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?