Get the Payout Request status

Use the get payout request endpoint to fetch a payout request which will allow you to get the status of the associated payout(s). See the bottom of this page for more information on the various statuses that can occur.

Example request

curl --request GET \
     --url http://app.muralpay.com/api/payouts/payout/d1cd7a75-fcf9-4624-b2fe-080e920e2e8f \
     --header 'accept: application/json' \
     --header 'authorization: Bearer $API-KEY' \
     --header 'on-behalf-of: 807742f0-e76c-44cd-bbe9-30b02e0060f4'

Example response

{
    "id": "d1cd7a75-fcf9-4624-b2fe-080e920e2e8f",
    "createdAt": "2025-04-05T04:24:03.862Z",
    "updatedAt": "2025-04-05T04:24:03.862Z",
    "transactionHash": "0x786e4eefde9260c82eed6861be085f724b21ab67d9ffca39a34ed2b80b100ff7",
    "sourceAccountId": "5d75e362-0812-4ea8-b203-c7c3a09f8473",
    "memo": "test",
    "status": "EXECUTED",
    "payouts": [
        {
            "id": "34998641-c981-44bc-beda-14b930999284",
            "createdAt": "2025-04-05T04:24:03.869Z",
            "updatedAt": "2025-04-05T04:26:24.198Z",
            "amount": {
                "tokenSymbol": "USDC",
                "tokenAmount": 100
            },
            "details": {
                "type": "fiat",
                "fiatAndRailCode": "cop",
                "fiatAmount": {
                    "fiatAmount": 305421.23,
                    "fiatCurrencyCode": "COP"
                },
                "transactionFee": {
                    "tokenSymbol": "USDC",
                    "tokenAmount": 0.35
                },
                "exchangeFeePercentage": 1.4,
                "exchangeRate": 3108.613065,
                "feeTotal": {
                    "tokenSymbol": "USDC",
                    "tokenAmount": 1.75
                },
                "fiatPayoutStatus": {
                    "type": "pending",
                    "initiatedAt": "2025-04-05T04:27:01.901Z"
                }
            }
        }
    ]
}

Payout Request Statuses

The top level Payout Request status refers to the initiation of all payouts within the Payout Request. Therefore, EXECUTED does not necessarily mean that funds have been received for each payout. See the corresponding Fiat Payout Status for that information.

• AWAITING_EXECUTION: The transaction was created and waiting to be executed.
• PENDING: The transaction is being executed.
• EXECUTED: The transaction was executed. Any blockchain payouts will be completed. Any fiat payouts will have been initiated but funds may not have been delivered.
• FAILED: The transaction execution failed. Please contact [email protected]
• CANCELED: The transaction was canceled.

Individual Payout Statuses

Individual payout can be of type fiat or blockchain.

Fiat Payout Statuses

Statuses for each Fiat payout associated with the overall Payout Request.

• PAYOUT_CREATED: The payout has been created but not executed.
• PAYOUT_PENDING: The funds have been received by our local banking provider and are being processed.
• PAYOUT_ON_HOLD: The payout is on hold for compliance review, please reach out to [email protected] for more details on how to remediate.
• PAYOUT_COMPLETED: The funds have been sent to the recipient. This is a terminal status.
• PAYOUT_FAILED: The payout failed, see response body for details.
• CANCELED: The payout was canceled, response body for details.

Blockchain Payout Statuses

Statuses for each blockchain payout associated with the overall Payout Request.

• AWAITING_EXECUTION: The transaction was created and waiting to be executed.
• PENDING: The transaction is being executed.
• EXECUTED: The transaction was executed.
• FAILED: The transaction execution failed. Please contact support.
• CANCELLED: The transaction was cancelled.