MUmuralpay
Payouts

Execute a Payout Request

Changed on

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.

post/api/payouts/payout/{id}/execute

Request

Path parameters

idstring uuid required

Payout request ID

Headers

on-behalf-ofstring

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.

transfer-api-keystring required

Transfer API key required to execute this request.

Request body

exchangeRateToleranceMode'STRICT' | '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).

Response

Successfully executed Payout Request

createdAtstring date-time required
idstring uuid required
memostring
sourceAccountIdstring 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.

transactionHashstring

The transaction hash of the blockchain transaction. Present when the status is EXECUTED.

updatedAtstring date-time required

Example response

{
  "payouts": [
    {
      "amount": {
        "tokenSymbol": "USDC"
      },
      "details": {
        "feeTotal": {
          "tokenSymbol": "USDC"
        },
        "fiatAmount": {
          "fiatCurrencyCode": "USD"
        },
        "transactionFee": {
          "tokenSymbol": "USDC"
        }
      },
      "recipientInfo": {
        "details": {
          "details": {
            "truncatedBankAccountNumber": "****1234"
          }
        }
      }
    }
  ]
}

Changes

  • 65aadbefe527Revision changes
    • breaking

      added to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      added the new InsufficientBalanceError enum value to the / response property for the response status

    • warning

      added the new PayoutQuoteExpiredException enum value to the / response property for the response status

    • warning

      added the new TRON enum value to the //// response property for the response status

    • warning

      added the new TRON enum value to the ////// response property for the response status

    • warning

      added the new mxn-debit-card enum value to the //// response property for the response status

    • warning

      added the new usd-el-salvador enum value to the //// response property for the response status

    • info

      added response discriminator for the response status

    • info

      added response discriminator for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the SOLANA enum value from the //// response property for the response status

    • info

      removed the SOLANA enum value from the ////// response property for the response status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status