Version: 1
Transactions API
Every scheme-level operation performed against an order is recorded as
a Transaction. As an acquirer you have read-only access to the
transactions of every merchant under your acquirer.
Transaction types
| Type | Created by |
|---|---|
purchase | Single-message purchase (authorize + capture) |
authorize | Authorization only |
verify | Zero-value card validation |
capture | Capture of an authorization |
void | Release of an authorization hold |
refund | Return of captured funds |
extension | Renewal of a long-running authorization hold |
reversal | Nullification of an uncertain transaction |
Statuses
initiated— request is in flight.approved— scheme and issuer approved.failed— declined by scheme or issuer (inspectresponse_codeandmessage).timeout— gateway did not receive a scheme response within the allotted time.system_error— internal error before scheme submission.
Required permission: orders_read.
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_* |