For AI agents: the docs index is at https://docs.vitessepsp.com/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Vitesse Knowledge Hub
HomeDocumentationAPI ReferenceChangelog
User guideDeveloper guideAPI ReferenceContactVitesse Knowledge Hub
API Reference
User guideDeveloper guideAPI ReferenceContact
HomeDocumentationAPI ReferenceChangelog
  • Welcome to the Vitesse API reference
  • Accounts
    • List accountsget
    • Retrieve an account.get
    • Search accounts by name or currencyget
    • List account entriesget
  • Account Balances
    • List account balancesget
    • Retrieve an account balanceget
  • Account Movements
    • List account movementsget
    • Retrieve account movementget
    • Create account movementpost
    • Approve or cancel an account movementput
    • Validate account movementpost
  • Payment requests
    • Create payment requestpost
      • Prioritise a Vendor Pay payment requestput
      • Immediately process a Vendor Pay payment requestput
    • Cancel a payment requestput
      • List cancellation reasonsget
  • Payment methods
    • List payment methodsget
    • List permitted payment methodsget
  • Manage payments
    • List payment requestsget
    • Retrieve a payment requestget
      • List payment request search filtersget
    • Search payment requestsget
    • Validate payment requestpost
  • Manage stored recipients
    • List all stored recipientsget
    • Retrieve a stored recipientget
    • Search stored recipientsget
      • Retrieves stored recipients search filtersget
    • Create stored recipientpost
    • Activate stored recipientput
    • Deactivate stored recipientput
    • Amend stored recipient.put
      • Amend stored recipient external idput
      • Amend stored recipient payment method details.put
      • Amend stored recipient details.put
    • Validate recipient detailspost
    • Archive stored recipientput
    • Get merchant audit history.get
  • Manage programmes
    • List programmesget
    • Retrieve a programmeget
    • Search programmesget
    • Search programme accountsget
  • Manage schedulers
    • List payment schedulersget
    • Create a schedulerpost
    • Set default schedulerput
    • Update a schedulerput
    • Delete a schedulerdel
  • Manage cheques
    • Retrieve voided chequeget
    • Retrieve postal cheque file copyget
    • Retrieve eCheck file copyget
    • Void a chequepost
  • Rules
    • Retrieves single-payment payout details field specificationget
    • Retrieves payee-capture payout details field specificationget
  • Calculate Currency Exchangepost
  • Notifications
    • List notification reminder channelsget
    • List notification reminder time periodsget
  • Webhooks
    • Retrieve webhookget
    • Update webhookput
    • Delete webhookdel
    • Retrieve all webhook eventsget
    • Retrieve all webhooksget
    • Create webhookpost
    • Update webhook authenticationput
    • Rotate secretput
    • Reveal secretget
    • Enable webhookput
    • Disable webhookput
  • Transaction API reference
    • Accounts
      • List accountsget
      • Retrieve account funding mapget
      • List account funding panelget
    • Account Balances
      • Retrieve account balanceget
    • Transactions
      • Search transactionsget
      • Retrieve transactionget
    • Transaction Requests
      • Create transaction requestpost
      • Validate transaction requestpost
      • Retrieve transaction requestget
      • Cancel transaction requestput
    • TransactionKey
      • Check deferred transaction request by transaction keyget
      • Check transaction request by transaction keyget
    • Stored Recipient
      • List stored recipientsget
      • Create stored recipientpost
      • Retrieve stored recipientget
      • Update stored recipientput
      • Delete stored recipientdel
    • DeferredTransactionRequests
      • List deferred transaction requestsget
      • Create deferred transaction requestpost
      • Retrieve deferred transaction requestget
      • Validate deferred transaction requestpost
      • Create deferred transaction request with grouppost
    • DeferredTransactionGroups
      • List deferred transaction groupsget
      • Create deferred transaction grouppost
      • Retrieve deferred transaction groupget
      • List deferred transaction group transactionsget
    • Foreign exchange
      • List foreign exchange rate groupsget
      • List indicative foreign exchange ratesget
      • Retrieve foreign exchange rate groupget
      • List foreign exchange rates for a send accountget
      • Create foreign exchange rate grouppost
    • Events
    • List rulesget
  • Retrieve a stored recipientget
  1. Administration

Manage cheques

Cheque void

Retrieve and manage cheque void requests.

Endpoints:

  • Retrieve voided cheque
  • Void a cheque

Cheque file copies

Retrieve PDF copies of electronic and postal cheques.

Endpoints:

  • Retrieve postal cheque file copy
  • Retrieve eCheck file copy

Updated 16 days ago


Delete a scheduler
Retrieve voided cheque

Updated 16 days ago


Delete a scheduler
Retrieve voided cheque
    • Cheque void
    • Cheque file copies

Main sections

  • Vitesse solution
  • Treasury
  • Payments
  • Vitesse online
  • Vitesse API
  • MAS
  • Transaction API
  • API reference

Quick links

  • Core concepts
  • UK hub payment coverage
  • US hub payment coverage
  • Vitesse API
  • API reference
  • Make a single payment
  • Make batch file payments
  • Reporting

Contact Vitesse

Vitesse Support: Contact us Website: https://www.vitesse.io/