Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.payvessel.com/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to test card spend and transaction history without real merchant charges. It calls the issuer’s sandbox mock API; PayVessel ingests the result via webhook and updates balance from the issuer.
Sandbox only. Not exposed in production. Your integration should only call this when using sandbox API keys and https://sandbox.payvessel.com.

​
How it works

  1. Create and activate a card (Create a Card, then poll Get a Card until ACTIVE).
  2. POST a simulation with amount and type (DEBIT or CREDIT).
  3. Issuer fires a webhook — PayVessel records the transaction and refreshes card balance.
  4. Verify with Get Card Transactions.

​
Request fields

FieldRequiredDescription
amountYesUSD amount (e.g. "1.50")
typeNoDEBIT (default) = spend; CREDIT = refund/credit

​
When to use

  • End-to-end testing of spend notifications in your app
  • QA of transaction lists and balances in sandbox
  • Demo environments without real card networks

​
Limitations

  • Card must be ACTIVE and fully linked to the issuer (not pending activation)
  • Balance shown in the response may change again after the webhook syncs
  • Production requests return a validation error

API Reference — Try it

Run this endpoint in the browser (sandbox)