Reference
Specs, lookup tables, and behavioral references for the Von Payments API.
API surface
- API reference — complete endpoint catalog (OpenAPI 3.1)
- Session object — full schema, fields, lifecycle states
- Payment intent object — the six-value status set, what each state permits, and which ones a refund requires
- Buyers — the buyer record, the name fields that belong to the charge rather than the record, and erasing a stored email
- Tokens —
vp_pmt_*payment-method tokens: minting, reuse, and their single-use default - Refunds — full and partial refunds, the four 2xx shapes, and which of them moved money
- Capabilities — what your connection supports, and why
succeededis not evidence a payment was never disputed - Statement descriptors — what the buyer sees on their statement
- Discovery endpoint — runtime API discovery (
GET /.well-known/vonpay.json) - Versioning — API version policy + deprecation timeline
Operational reference
- API keys — key formats (
vp_sk_*secret,vp_pk_*publishable,whsec_*webhook-signing), rotation, scoping - Security — webhook signatures, TLS, encryption at rest, key rotation
- Rate limits — per-key limits, backoff guidance
- Error codes — every error code, what triggers it, how to recover
Testing
- Test cards — sandbox card numbers + decline-trigger PANs