Agreements API
An Agreement is a stored cardholder mandate that authorizes a
merchant to submit future transactions against a saved card without
the cardholder present. Agreements are created implicitly by merchants
as part of their order flow; as an acquirer you can list, inspect and
disable the agreements of every merchant under your acquirer.
Agreement types
| Type | Use-case |
|---|---|
unscheduled | Card-on-file charged when the customer takes an action. |
recurring | Fixed-cadence subscriptions. |
registered | Card stored for future consented purchases. |
installment | Fixed-count, fixed-amount instalment plans. |
Disabling
Agreements are soft-disabled via PUT /v1/agreements/:id/disable.
Disabled agreements reject new transactions (the active flag
becomes false); historical orders remain unaffected. Re-enabling is
not supported.
Required permissions: agreements_read, agreements_disable.
Authentication
- HTTP: Bearer Auth
Acquirer API key sent as a bearer token:
Authorization: Bearer acquirer_key_...
Keys are created from the Acquirer Dashboard and carry an explicit set of permissions. Every request is scoped to the acquirer that owns the key — resources of other acquirers are never visible. Keys may be IP-restricted; requests from non-whitelisted IPs are rejected with HTTP 401. See the Authentication page for details.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | acquirer_key_* |