MUmuralpay
Accounts

Create an Account

Changed on

Creates a Mural Account that you can deposit funds into and perform payouts from.

post/api/accounts

Request

Headers

on-behalf-ofstring

Organization ID to act on behalf of

Request body

descriptionstring

The description of the Account

namestring required

The name of the Account

Example request

{
  "developerFees": {
    "payinsDeveloperFees": [
      {
        "developerFeePercentage": 2.5,
        "type": "usd"
      },
      {
        "developerFeePercentage": 1.8,
        "type": "eur"
      },
      {
        "developerFeePercentage": 2,
        "type": "mxn"
      },
      {
        "developerFeePercentage": 1.5,
        "type": "brl"
      },
      {
        "developerFeePercentage": 2,
        "type": "ars"
      }
    ]
  },
  "payinsSettlementStrategies": [
    {
      "settlementStrategy": {
        "type": "holdInFiat"
      },
      "type": "usd"
    }
  ]
}

Response

Create an Account

createdAtstring date-time required
descriptionstring

The description of the Account

idstring uuid required

The unique identifier for the Account

isApiEnabledboolean required

Whether or not the Account can be managed by the API. Accounts created in the platform will not be enabled unless you grant API access to the Account in the platform.

namestring required

The name of the Account

status'INITIALIZING' | 'ACTIVE' required

The status of the Account. Will start in INITIALIZING and move to ACTIVE once the Account is ready to use.

updatedAtstring date-time required

Example response

{
  "accountDetails": {
    "balancesV2": [
      {
        "exponent": 6,
        "value": "2500000"
      }
    ],
    "payinMethods": [
      {
        "supportedDestinationTokens": [
          {
            "fees": {
              "fixedTransactionFee": {
                "fiatCurrencyCode": "USD"
              }
            },
            "transactionMinimum": {
              "fiatCurrencyCode": "USD"
            }
          }
        ]
      }
    ],
    "walletDetails": {
      "walletAddress": "0x0000000000000000000000000000000000000000"
    }
  }
}

Changes

  • 65aadbefe527Revision changes
    • warning

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

    • warning

      added the new SignedAgreementRequiredException 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 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

    • info

      added the new optional request property

    • info

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

    • info

      added the non-success response with the status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      removed from the ///////// response property oneOf list for the response status