nspay

Overview

Public merchant API for the nspay payment gateway.

nspay exposes a small JSON API for merchants to create payments and payouts, confirm pending operations, and read the current state of an operation. Once an operation reaches a terminal status, the gateway also pushes a webhook to the URL configured for the merchant.

What you get

  • POST /v1/payment — create a payment (the merchant collects funds).
  • POST /v1/payout — create a payout (the merchant sends funds out).
  • POST /v1/confirm_payment — confirm a pending payment with a required receipt upload.
  • POST /v1/get_operation_state — read the latest state of an operation by ID.
  • Webhook callbacks — POSTed to the merchant's configured URL when an operation transitions into a terminal status.

Where to start

  1. Read Getting started for the request shape, transport, and environment basics.
  2. Get an API key and start sending the X-API-Key header on every /v1 request.
  3. Skim Concepts for status, amount, currency, and identifier semantics.
  4. Use the API reference for endpoint-by-endpoint details.
  5. Wire up Webhooks so you receive terminal status updates without polling.

On this page