MUmuralpay
Payouts

Create a Payout Request

Changed on

Creates a Payout Request. The Payout Request can have multiple recipients, each of which can be a fiat or blockchain payout. Developer fees can only be applied on behalf of a child organization, so a payout carrying a developer fee must be created using the on-behalf-of header.

post/api/payouts/payout

Request

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.

Request body

memostring
sourceAccountIdstring uuid required

The ID of the source account to be used for the payout

Example request

{
  "payouts": [
    {
      "amount": {
        "tokenSymbol": "USDC"
      },
      "amountV2": {
        "sourceCurrency": {
          "fiatCurrencyCode": "USD"
        },
        "value": "10050"
      },
      "payoutDetails": {
        "fiatAndRailDetails": {
          "documentNumber": "20-12345678-9"
        }
      },
      "supportingDetails": {
        "supportingDocument": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAA..."
      }
    }
  ]
}

Response

The successfully created 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

      removed the enum value SOLANA of the request property /////

    • 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

      the ///////// request property's max was set to 100.00

    • warning

      the ///////// request property's max was set to 100.00

    • warning

      the ///////// request property's min was set to 0.00

    • warning

      the ///////// request property's min was set to 0.00

    • warning

      removed the request property //////

    • warning

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

    • warning

      added the new PayoutComplianceValidationFailedError enum value to the response property for the response status

    • warning

      added the new PayoutMethodError enum value to the response property for the response status

    • warning

      added the new PayoutMinimumNotMetError 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 the new optional request property //

    • info

      added the new optional request property /////

    • info

      the request property // became optional

    • info

      request property // deprecated

    • info

      added the new TRON enum value to the request property /////

    • info

      added to the //// request property oneOf list

    • 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

      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