Skip to main content
PATCH
Update the surcharge rate

Authorizations

Authorization
string
header
default:sk_test_DEMO0000_replace_with_your_sandbox_key
required

API key authentication. Issued by the Safariat admin or via the partner portal. The secret is shown only once at generation.

Production sk_live_* keys must additionally sign every write request (POST/PUT/DELETE) with the X-Timestamp and X-Signature headers. Sandbox sk_test_* keys are exempt from request signing: X-Signature and X-Timestamp are not required for writes in the sandbox (so the developer-portal "Try it" playground works end to end). The Idempotency-Key header remains required on writes in both environments.

Body

application/json
surcharge_rate_bps
integer
required

New surcharge rate (bps). Must be ≤ surcharge_cap_bps.

Required range: x >= 0
Example:

1500

Response

Updated configuration

Partner self-service configuration (ADR-029).

surcharge_rate_bps
integer
required

The bank's surcharge rate in basis points (100 bps = 1 %). Defaults to 0.

Required range: x >= 0
surcharge_cap_bps
integer | null

Ceiling set by Safariat (bps). null ⇒ surcharge disabled (rate must stay 0).

Required range: x >= 0