1.0
OAS3
The Vibrant Push To Pay API description. To use this API you will need a partner login.
Use this endpoint to get or create payment intents - they can also be created through the terminals endpoint to start the payment flow immediately.
Use this endpoint to get charges
Use this endpoint to get refunds
Use this endpoint to create, update, get terminals. Also used to perform terminal commands, i.e. process payment intents and refunds or cancel any pending commands
Setup webhooks in order to get the Events served as they happen.
All state changes will create an Event. Events can be fetched here or subscribe to them by webhooks
For Mobile POS - use this to setup some nice products.
Use spots to group terminals at same location - or limit the product list at some terminals using spots.
Setup users with access restriction and keep track of user performance.
Orders include sales staus, which terminal made the sale, credit card details, orderItems with products and prices and more.
Upload product images and other company material.
WIP