--- title: "Search Payout Requests" method: POST path: "/api/payouts/search" tags: ["Payouts"] --- # Search Payout Requests `POST /api/payouts/search` Get all Payout Requests associated with the provided Organization ID and filtered by the provided statuses. ## Query parameters - `limit` number - `nextId` string, uuid ## Headers - `on-behalf-of` string ## Request body - MuralSearchPayoutRequestsInput - `filter` PayoutStatusFilter — Filter based on the status of the Payout Request. A Payout that matches any of the provided statuses will be returned - `statuses` string[], required - `type` 'payoutStatus', required ## Response `200` Returned Payout Requests - object - `nextId` string, uuid - `total` number, required - `results` PayoutRequest[] - `createdAt` string, date-time, required - `id` string, uuid, required - `memo` string - `payouts` PayoutRequestRecipientInfo[], required — Information associated with each recipient's payout included in the original payout request. - `amount` TokenAmount, required - `tokenAmount` number, required — The token amount. - `tokenSymbol` string, required — The token symbol. - `createdAt` string, date-time, required - `details` union, required - FiatPayout — Details pertaining to a specific recipient's payout - `developerFee` DeveloperFee - `developerFeePercentage` number - `exchangeFeePercentage` number, required — The total fee for the transaction (in percentile) applied at transaction execution time. This is applied to the source token amount. For example, a value of 3 means 3%. - `exchangeRate` number, required — The exchange rate for the transaction. The rate at which the token amount will be converted to fiat. The units are destination fiat per token. - `feeTotal` TokenAmount, required - `tokenAmount` number, required — The token amount. - `tokenSymbol` string, required — The token symbol. - `fiatAmount` SimpleFiatAmount, required - `fiatAmount` number, required — The fiat amount. - `fiatCurrencyCode` 'USD' | 'COP' | 'ARS' | 'EUR' | 'MXN' | 'BRL' | 'CLP' | 'PEN' | 'BOB' | 'CRC' | 'ZAR', required — The fiat currency code. - `fiatAndRailCode` 'usd' | 'cop' | 'cop-bre-b' | 'cop-cobre-balance' | 'ars' | 'eur' | 'mxn' | 'brl' | 'clp' | 'pen' | 'bob' | 'crc' | 'zar' | 'usd-peru' | 'usd-china' | 'usd-panama' | 'usd-hong-kong', required — The fiat and rail code, if applicable, for the payout. This corresponds to the type discriminator of the fiatAndRailDetails field in the payout request. - `fiatPayoutStatus` union, required — The status of the fiat payout to the recipient. A successful payout will follow these statuses: created → pending → on-hold (optional) → completed. If a payout fails, it will transition to refundInProgress → refunded. A payout can be canceled before initiation, resulting in the canceled status. The failed status is deprecated and will be replaced by the refund flow. - PayoutCreatedStatus — Status when the transaction hasn't been executed yet and the payout is created. This is the initial status of a fiat payout. - … - PayoutPendingStatus — Status when the transaction has been initiated and the payout is pending. The funds have been transferred to the provider and payout is being processed. - … - PayoutOnHoldStatus — Status when the transaction has been initiated and the payout is on hold. Review of the transaction is being conducted and the Mural team will reach out if more information is needed. - … - PayoutCompletedStatus — Status when the transaction has been executed and the payout is completed. The funds have been received by the recipient. This is a terminal status. - … - PayoutFailedStatus — DEPRECATED: Status when the transaction has been initiated but the payout has failed. This is a terminal status. Reach out to Mural support - … - PayoutCanceledStatus — Status when the transaction wasn't initiated because the sender canceled the transaction. This is a terminal status. - … - PayoutRefundInProgressStatus — Status when a refund has been initiated for a previously failed payout. The refund is currently being processed. - … - PayoutRefundedStatus — Status when a payout has been successfully refunded. The funds have been returned to the sender. This is a terminal status. - … - `transactionFee` TokenAmount, required - `tokenAmount` number, required — The token amount. - `tokenSymbol` string, required — The token symbol. - `type` 'fiat', required - BlockchainPayout - `blockchain` 'ETHEREUM' | 'POLYGON' | 'BASE' | 'CELO' | 'PLASMA' | 'SOLANA', required — The destination blockchain. SOLANA is returned only for USD payouts. - `status` 'AWAITING_EXECUTION' | 'PENDING' | 'EXECUTED' | 'FAILED' | 'CANCELED', required — The status of the blockchain payout. The initial status is AWAITING_EXECUTION, and the status will change to PENDING. EXECUTED, FAILED, and CANCELED are terminal statuses. EXECUTED indicates the blockchain transaction associated with the transfer has been executed. - `transactionHash` string, nullable — On-chain hash for this recipient's settlement. Present for USD payouts to external wallets (populated once settlement completes); absent for USDC payouts — read the top-level `transactionHash` on the payout request in that case. - `type` 'blockchain', required - `walletAddress` string, required — The destination wallet address. EVM (0x-prefixed hex) or Solana (base58-encoded 32-byte pubkey), matching the blockchain value. - `id` string, uuid, required - `recipientInfo` union, required — Information about how this payout recipient was specified - either via counterparty reference or inline details - CounterpartyPayoutRecipientInfo — Recipient information for payouts created using counterparty and payout method references - `counterpartyId` string, uuid, required — The ID of the counterparty used as the recipient - `payoutMethodId` string, uuid, required — The ID of the payout method used as the payout method - `type` 'counterparty', required - InlinePayoutRecipientInfo — Recipient information for payouts created using inline recipient and payout details - `details` union, required — Details about the inline recipient, discriminated by payout type (fiat or blockchain) - InlineFiatPayoutRecipientDetails — Details about an inline fiat payout recipient. This includes recipient information and bank details. - … - InlineBlockchainPayoutRecipientDetails — Details about an inline blockchain payout recipient. This includes recipient information and wallet details. - … - `name` string, required — The name of the recipient - `type` 'inline', required - `updatedAt` string, date-time, required - `sourceAccountId` string, uuid, required - `status` 'AWAITING_EXECUTION' | 'CANCELED' | 'PENDING' | 'EXECUTED' | 'FAILED', required — DEPRECATED: use `statusV2` instead. The status of the overall payout request. The initial status is AWAITING_EXECUTION, and the status will change to PENDING. EXECUTED, FAILED, and CANCELED are terminal statuses. EXECUTED indicates the blockchain transaction associated with the entire payout has been executed, but that does not mean your recipients have received funds. Check the individual recipientsPayoutDetails for the status of each recipient. - `statusV2` union, required — The initial status is `awaitingExecution`, and the status will change to `pending`. `executed`, `failed`, and `canceled` are terminal statuses. `executed` indicates the blockchain transaction associated with the entire payout has been executed, but that does not mean your recipients have received funds. Check the individual recipientsPayoutDetails for the status of each recipient. - PayoutRequestAwaitingExecutionStatusV2 - `type` 'awaitingExecution', required - PayoutRequestPendingStatusV2 - `type` 'pending', required - PayoutRequestExecutedStatusV2 - `type` 'executed', required - PayoutRequestFailedStatusV2 — Status metadata for a failed payout request. - `errorDescription` string, required — Human-readable explanation of why the payout request failed. - `type` 'failed', required - PayoutRequestCanceledStatusV2 - `type` 'canceled', required - `transactionHash` string — The transaction hash of the blockchain transaction. Present when the status is EXECUTED. - `updatedAt` string, date-time, required ## Other responses - `401` — Unauthorized - `403` — SignedAgreementRequiredException --- [API](https://skmtc.net/muralpay/apis/mural-api.md) · [All operations](https://skmtc.net/muralpay/apis/mural-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/muralpay/mural-api/versions/437d277f5948/schema)