Skip to main content
PATCH
Update platform configuration

Authorizations

Authorization
string
header
required

API token authentication using format <api token id>:<api client secret>

Body

application/json
umaDomain
string
Maximum string length: 200
Pattern: ^[A-Za-z0-9]([A-Za-z0-9-]{0,61}[A-Za-z0-9])?(\.[A-Za-z0-9]([A-Za-z0-9-]{0,61}[A-Za-z0-9])?)*$
Example:

"mycompany.com"

webhookEndpoint
string
Example:

"https://api.mycompany.com/webhooks/uma"

supportedCurrencies
object[]
embeddedWalletConfig
object

Update or create the embedded-wallet configuration for this platform. Fields omitted from the nested object are left unchanged. Omit this field at the top level to leave the embedded-wallet configuration unchanged entirely.

cardTokenization2faConfig
object

Update card-tokenization authentication branding and delivery settings. Fields omitted from the nested object are left unchanged. Changes apply to subsequent delivery attempts.

cardConfigs
object

Update platform-level card settings. Fields omitted from the nested object are left unchanged. Set each limit within its documented range, or send null to clear it. Set pinTargetOrigin to configure the website that hosts PIN-entry iframes, or supply null to clear it. Omit this field at the top level to leave all card settings unchanged.

feeConfigs
object[]

Merge-by-key upsert of platform fee configs. A cross-currency transaction fee config is keyed by (feeType, sourceCurrency) and a rail fee config by (feeType, rail, direction, originator). Setting variable and fixed fees to 0 for an existing config deactivates it. Omit this field to leave fee configs unchanged.

A fee charged for a cross-currency transaction. There can be at most one cross-currency transaction fee config for a given source currency. The fee will apply to all cross-currency transactions that originate in the source currency.

Response

Configuration updated successfully

id
string

System-generated unique identifier

Example:

"PlatformConfig:019542f5-b3e7-1d02-0000-000000000003"

umaDomain
string

UMA domain for this platform

Maximum string length: 200
Pattern: ^[^\u0000-\u001f\u007f]*$
Example:

"platform.uma.domain"

proxyUmaSubdomain
string

The subdomain that incoming requests will be proxied to

Maximum string length: 200
Pattern: ^[^\u0000-\u001f\u007f]*$
Example:

"platform"

webhookEndpoint
string

URL where webhook notifications will be sent

Example:

"https://api.mycompany.com/webhooks/uma"

supportedCurrencies
object[]

List of currencies supported by the platform. This is what the platform's customers are able to hold, send, and receive.

isRegulatedFinancialInstitution
boolean

Whether the platform is a regulated financial institution. This is used to determine if the platform's customers must be KYC/KYB'd by Lightspark via the KYC link flow. This can only be set by Lightspark during platform creation.

Example:

false

embeddedWalletConfig
object

Embedded-wallet branding and OTP settings for this platform. Present only when the platform has configured embedded-wallet support; omitted otherwise.

cardTokenization2faConfig
object

Branding and sender configuration for card-tokenization authentication messages. This configuration is independent of embedded-wallet support.

cardConfigs
object

Platform-level settings for cards issued by this platform.

feeConfigs
object[]

Platform-collected fees that should be added on top of Grid-collected fees. Contains every currently-active fee config for the platform.

A fee charged for a cross-currency transaction. There can be at most one cross-currency transaction fee config for a given source currency. The fee will apply to all cross-currency transactions that originate in the source currency.

createdAt
string<date-time>

Creation timestamp

Example:

"2025-06-15T12:30:45Z"

updatedAt
string<date-time>

Last update timestamp

Example:

"2025-06-15T12:30:45Z"