API reference
Implement only the operations and permissions published for your approved scope.
Review one complete request, response, permission, idempotency, and failure contract before requesting the full approved integration package.
Implementation checklist
Read
GET operations state their permission, query fields, pagination, and response shape.
Command
Supported writes use a unique Idempotency-Key and may require a current version or stronger verification.
Decode
Treat authentication, permission, conflict, validation, throttling, and service failures differently.
Observe
Preserve the request ID so your team and Saleringo can discuss the same attempt.
Request and result
POST /cases
Authorization: Bearer <server-token>
Idempotency-Key: <unique-command-key>
Content-Type: application/json
{ "subject": "Callback request" }HTTP 201
X-Request-Id: req_...
{ "id": "case_...", "status": "open" }Failure handling
| Status | Meaning | Client action |
|---|---|---|
| 401 | Credential is missing, expired, or invalid | Stop; refresh through the approved server flow. |
| 403 | Identity lacks the exact permission or scope | Do not retry; request an access review. |
| 409 | State, version, idempotency, or approval conflicts | Read the conflict and reconcile before another command. |
| 422 | The request does not match the published schema | Correct the named fields; do not retry unchanged. |
| 429 | The integration is sending too quickly | Honor the supplied wait guidance and apply backoff. |
| 5xx | A temporary service failure may have occurred | Preserve IDs; retry only when the operation permits it. |
Implementation support
Do not send credentials, customer secrets, or raw payment data. Include the contract version, environment, operation, timestamp, and non-sensitive correlation ID.