Skip to main content
GET
/
config
Get your current platform configuration
curl --request GET \
  --url https://{publicHost}/config \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "PlatformConfig:019542f5-b3e7-1d02-0000-000000000003",
  "webhookEndpoint": "https://api.demo-bank.com/webhooks/blips",
  "supportedCurrencies": [
    {
      "currencyCode": "USD",
      "minAmount": 100,
      "maxAmount": 1000000,
      "enabledTransactionTypes": [
        "OUTGOING",
        "INCOMING"
      ],
      "requiredPayerDataFields": [
        {
          "name": "FULL_NAME",
          "mandatory": true
        },
        {
          "name": "BIRTH_DATE",
          "mandatory": true
        },
        {
          "name": "NATIONALITY",
          "mandatory": true
        }
      ]
    }
  ],
  "strictPayerDataRequired": true,
  "createdAt": "2025-06-15T12:30:45Z",
  "updatedAt": "2025-06-15T12:30:45Z"
}

Authorizations

Authorization
string
header
required

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

Response

Current platform configuration returned.

Frozen MVP platform configuration response.

id
string
required

Stable platform configuration identifier.

webhookEndpoint
string | null
required

Configured webhook endpoint for payment-status delivery.

supportedCurrencies
object[]
required
strictPayerDataRequired
boolean
required

When true, every required payer-data field listed for a supported currency must be supplied before the flow can proceed.

createdAt
string<date-time>
required

Configuration creation timestamp.

updatedAt
string<date-time>
required

Most recent configuration update timestamp.