v1

latestOpenAPI 3.0.02026-07-2464438356.8 KB

Accounts

Set settlement strategy for an Account

Sets or updates the settlement strategy for a specific Account. The settlement strategy controls how incoming payins are settled: either held as fiat, or automatically on-ramped to the Account destination token.

put/api/accounts/{id}/set-settlement-strategy

Path parameters

idstring uuid required

Mural Account ID

Headers

on-behalf-ofstring

Organization ID to act on behalf of

Request body

Example request

{
  "payinsSettlementStrategies": [
    {
      "settlementStrategy": {
        "type": "holdInFiat"
      },
      "type": "usd"
    }
  ]
}

Response

Set settlement strategy for 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"
    }
  }
}