Business Settings - Read
GET
{{baseUrl}}/{{stage}}/external/businesses/{{businessID}}/settings
Get Business Settings
GET {{baseUrl}}/{{stage}}/external/businesses/{{businessID}}/settingsRequest
Headers
| Header | Value | Required |
|---|---|---|
X-Business-Key | businessKey | ✅ |
Accept | application/json | ✅ |
Path Parameters
| Parameter | Type | Description |
|---|---|---|
businessID | string | Your business NRS ID |
Request Body
Response
Success (200)
{
"responseCode": "00",
"responseMessage": "Business settings retrieved successfully",
"settings": {
"webhookUrl": "https://api.yourcompany.com/webhooks/invoices",
"webhookAuthConfigured": true,
"qrCodePublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA...\n-----END PUBLIC KEY-----",
"qrCodeCertificate": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAKL0UG...\n-----END CERTIFICATE-----"
}
}Response Fields
| Field | Type | Description |
|---|---|---|
responseCode | string | 00 = success, 02 = business not found |
responseMessage | string | Human-readable status message |
settings | object | Current business configuration |
settings.webhookUrl | string | null | Configured webhook URL for notifications |
settings.webhookAuthConfigured | boolean | true if webhook auth token is set (actual value not returned for security) |
settings.qrCodePublicKey | string | null | Public key for QR code generation |
settings.qrCodeCertificate | string | null | Certificate for QR code signing |
webhookAuth value is never returned in responses for security. Only a boolean flag indicating if it's configured.Errors
{
"responseCode": "03",
"responseMessage": "Invalid or expired business key"
}{
"responseCode": "02",
"responseMessage": "Business not found with ID: {businessID}"
}businessID in URL matches your registered NRS ID{
"responseCode": "99",
"responseMessage": "An internal error occurred while retrieving settings",
"requestId": "req_xyz123"
}requestId if persistent.Example Request
Use Cases
/businesses/{businessID}/settings - Update settingsRequest
None
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff '{{baseUrl}}/{{stage}}/external/businesses/{{businessID}}/settings'Response Response Example
{}Modified at 2026-08-21 08:47:57