Skip to main content
PATCH
/
config
Update your current platform configuration
curl --request PATCH \
  --url https://public-test.blips.network/config \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "umaDomain": "uma.example.blips",
  "ppvDomain": "pay.example.blips",
  "webhookEndpoint": "https://api.demo-bank.com/webhooks/blips",
  "quoteFeePolicy": {
    "senderServiceFeeBps": 37,
    "receiverServiceFeeBps": 19
  }
}
'
{
  "id": "PlatformConfig:019542f5-b3e7-1d02-0000-000000000003",
  "umaDomain": "uma.example.blips",
  "ppvDomain": "pay.example.blips",
  "webhookEndpoint": "https://api.demo-bank.com/webhooks/blips",
  "quoteFeePolicy": {
    "senderServiceFeeBps": 37,
    "receiverServiceFeeBps": 19
  },
  "supportedCurrencies": [
    {
      "currencyCode": "USD",
      "minAmount": 100,
      "maxAmount": 1000000,
      "enabledTransactionTypes": [
        "OUTGOING",
        "INCOMING"
      ],
      "requiredCounterpartyFields": [
        {
          "profile": "FULL_NAME",
          "mandatory": true
        },
        {
          "profile": "BIRTH_DATE",
          "mandatory": true
        },
        {
          "profile": "NATIONALITY",
          "mandatory": true
        }
      ]
    }
  ],
  "createdAt": "2025-06-15T12:30:45Z",
  "updatedAt": "2025-06-15T13:05:12Z"
}

Authorizations

Authorization
string
header
required

Integration-key Basic Auth (clientId:clientSecret) as documented in docs/public/AUTHENTICATION.md.

Body

application/json
ppvDomain
string

Public-facing PPV domain bound to this platform configuration. Proxy and routing remain operator-managed and out of scope for the public contract. Compatibility callers that still send platformDomain are mapped to this field.

umaDomain
string

Compatibility-oriented, future-facing UMA domain bound to this platform configuration.

webhookEndpoint
string

Configured webhook endpoint for payment-status delivery.

supportedCurrencies
object[]

Supported currencies and payout policy bounds configured for this platform.

quoteFeePolicy
object

Platform-level sender and receiver service-fee policy inputs used for newly created quotes.

Response

Updated current platform configuration returned.

Frozen MVP platform configuration response.

id
string
required

Stable platform configuration identifier.

umaDomain
string | null
required

Bounded readback of the compatibility-oriented, future-facing UMA domain for this configuration context.

ppvDomain
string | null
required

Bounded readback of the active public-facing PPV domain for this configuration context. Proxy and routing remain operator-managed and out of scope for the public contract.

webhookEndpoint
string | null
required

Configured webhook endpoint for payment-status delivery.

quoteFeePolicy
object
required

Platform-level sender and receiver service-fee policy inputs used for newly created quotes.

supportedCurrencies
object[]
required
createdAt
string<date-time>
required

Configuration creation timestamp.

updatedAt
string<date-time>
required

Most recent configuration update timestamp.