nspay

Get operation state

POST /v1/get_operation_state

Read the latest state of an operation by its server-issued operation_id. Useful when you missed a webhook and want to reconcile the operation, or to poll while building an integration.

Endpoint

POST /v1/get_operation_state
Content-Type: application/json
X-API-Key: nspay_live_…

Request

FieldTypeRequiredNotes
operation_idstring (UUID)yesThe server-issued ID returned by /v1/payment or /v1/payout.

Example

curl -X POST https://api.nspay.tech/v1/get_operation_state \
  -H "Content-Type: application/json" \
  -H "X-API-Key: nspay_live_…" \
  -d '{"operation_id": "f6c2e7d4-3e5b-4f1f-8a02-9d6c7e8a1b22"}'

Response

200 OK with the operation object.

Polling guidance

Webhooks are the canonical signal for terminal status. Poll only as a fallback — for example, when building integration tooling or recovering from a missed delivery. There is no ETag or version field; each call returns the current state at read time.

Errors

  • 400operation_id missing or not a UUID.
  • 401X-API-Key missing or invalid.
  • 404 — no operation with that operation_id in this shop's scope.

On this page