v1

latestOpenAPI 3.1.02026-07-2656114159.7 KB

Issuing

Simulate Card Transaction

Sandbox only. Triggers a simulated card spend (DEBIT) or credit (CREDIT). Transaction history and balance update when PayVessel processes the event. Not available in production.

post/pms/api/external/request/virtual-cards/{card_id}/mock-transaction/

Path parameters

card_idstring uuid required

PayVessel card ID

Headers

api-keystring required

Your Payvessel public API key

api-secretstring required

Your Payvessel secret

Content-Type'application/json' required

Request content type

Request body

amountstring required

Transaction amount in USD (e.g. 1.50)

type'DEBIT' | 'CREDIT'

DEBIT simulates a card spend; CREDIT simulates a refund or credit

Example request

{
  "amount": "1.50"
}

Response

Simulation accepted

statusboolean

Indicates whether the request succeeded

messagestring

Human-readable result message