API responses

Success

HTTP 2xx:

{
  "status": "success",
  "data": { }
}

The resource is in data. Initialize is HTTP 201. Verify is HTTP 200.

{
  "status": "failed",
  "error": "invalid_credentials",
  "message": "A human-readable explanation"
}

Branch on error. Include X-Request-Id from the response headers when you contact support.

Checkout charges return HTTP 201 with outer status success. The payment state is data.status:

{
  "status": "success",
  "data": {
    "status": "awaiting_transfer",
    "reference": "VPY_TXN_…",
    "accountNumber": "0012345678"
  }
}

Outer `status`	`data.status`	Meaning
`success`	`pending`, `awaiting_transfer`, `fingerprint_required`, `3ds_required`, `processing`	Continue the flow.
`success`	`success`	Paid. Verify on the server.
`success`	`failed`	Charge failed. Customer can retry.
`failed`	—	The HTTP call failed. Read `error`.

Webhook bodies are { "event", "data", "timestamp" }. See Webhooks.

Call	Auth
Initialize, verify	Secret key (`x-api-key` or Bearer)
Checkout card / transfer	Access code (`x-access-code`)