Skip to content

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

  1. Read

    GET operations state their permission, query fields, pagination, and response shape.

  2. Command

    Supported writes use a unique Idempotency-Key and may require a current version or stronger verification.

  3. Decode

    Treat authentication, permission, conflict, validation, throttling, and service failures differently.

  4. Observe

    Preserve the request ID so your team and Saleringo can discuss the same attempt.

Request and result

Example governed command
POST /cases
Authorization: Bearer <server-token>
Idempotency-Key: <unique-command-key>
Content-Type: application/json

{ "subject": "Callback request" }
Example accepted result
HTTP 201
X-Request-Id: req_...

{ "id": "case_...", "status": "open" }

Failure handling

API failure handling
StatusMeaningClient action
401Credential is missing, expired, or invalidStop; refresh through the approved server flow.
403Identity lacks the exact permission or scopeDo not retry; request an access review.
409State, version, idempotency, or approval conflictsRead the conflict and reconcile before another command.
422The request does not match the published schemaCorrect the named fields; do not retry unchanged.
429The integration is sending too quicklyHonor the supplied wait guidance and apply backoff.
5xxA temporary service failure may have occurredPreserve 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.