LIlightsparkdev
Platform Configuration

Update platform configuration

Changed on

Update the platform configuration settings

patch/config

Request

  • Base URL
    https://api.uma.money/umaaas/2025-05-15
  • URL
    https://api.uma.money/umaaas/2025-05-15/config
  • Auth
    HTTP basic

Request body

umaDomainstring
webhookEndpointstring

Example request

{
  "umaDomain": "mycompany.com",
  "webhookEndpoint": "https://api.mycompany.com/webhooks/uma",
  "supportedCurrencies": [
    {
      "currencyCode": "USD",
      "minAmount": 100,
      "maxAmount": 1000000,
      "requiredCounterpartyFields": [
        {
          "name": "FULL_NAME",
          "mandatory": true
        },
        {
          "name": "BIRTH_DATE",
          "mandatory": true
        },
        {
          "name": "NATIONALITY",
          "mandatory": true
        }
      ],
      "umaProviderRequiredUserFields": [
        "NATIONALITY",
        "BIRTH_DATE"
      ],
      "umaProviderRequiredCounterpartyUserFields": [
        "FULL_NAME",
        "COUNTRY_OF_RESIDENCE"
      ],
      "enabledTransactionTypes": [
        "OUTGOING",
        "INCOMING"
      ]
    }
  ]
}

Response

Configuration updated successfully

idstring

System-generated unique identifier

umaDomainstring

UMA domain for this platform

proxyUmaaasSubdomainstring

The subdomain that incoming requests will be proxied to

webhookEndpointstring

URL where webhook notifications will be sent

createdAtstring date-time

Creation timestamp

updatedAtstring date-time

Last update timestamp

Example response

{
  "id": "Platform:019542f5-b3e7-1d02-0000-000000000003",
  "umaDomain": "platform.uma.domain",
  "proxyUmaaasSubdomain": "platform",
  "webhookEndpoint": "https://api.mycompany.com/webhooks/uma",
  "supportedCurrencies": [
    {
      "currencyCode": "USD",
      "minAmount": 100,
      "maxAmount": 1000000,
      "requiredCounterpartyFields": [
        {
          "name": "FULL_NAME",
          "mandatory": true
        },
        {
          "name": "BIRTH_DATE",
          "mandatory": true
        },
        {
          "name": "NATIONALITY",
          "mandatory": true
        }
      ],
      "umaProviderRequiredUserFields": [
        "NATIONALITY",
        "BIRTH_DATE"
      ],
      "umaProviderRequiredCounterpartyUserFields": [
        "FULL_NAME",
        "COUNTRY_OF_RESIDENCE"
      ],
      "enabledTransactionTypes": [
        "OUTGOING",
        "INCOMING"
      ]
    }
  ],
  "createdAt": "2023-06-15T12:30:45Z",
  "updatedAt": "2023-06-15T12:30:45Z"
}

Changes

  • 723ce326c29cRevision changes
    • info

      removed the INVALID_PAYREQ_RESPONSE enum value from the response property for the response status

    • info

      removed the LOOKUP_REQUEST_FAILED enum value from the response property for the response status

    • info

      removed the QUOTE_REQUEST_FAILED enum value from the response property for the response status

  • 2e2b5ba6d69bRevision changes
    • warning

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

    • warning

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

    • warning

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

    • info

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

    • info

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

    • info

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