Skip to main content

API Reference Overview

This API reference documents the v2024-10-01 wrapper contract.

Authentication​

  • Use your sandbox key from the onboarding process.
  • Send all required PayWise headers (PW-subscription-key, PW-... tracing headers).

Required headers​

  • PW-subscription-key
  • PW-Origin-Country
  • PW-Request-Date
  • PW-IP-Address
  • User-Agent

Versioning​

All wrapper endpoints are version-pinned through query param:

  • ?version=2024-10-01

Errors​

Responses follow the standard envelope:

  • status
  • code
  • message
  • request_id
  • timestamp

Idempotency​

For write endpoints, send a stable transaction/request identifier and safely retry on network failure using the same idempotency key/input.

Endpoint groups​