Swagger UI

Vibrant Push To Pay API
 1.0 
OAS3

The Vibrant Push To Pay API description. To use this API you will need a partner login.

payment_intents

Use this endpoint to get or create payment intents - they can also be created through the terminals endpoint to start the payment flow immediately.

charges

Use this endpoint to get charges

refunds

Use this endpoint to get refunds

terminals

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

webhooks

Setup webhooks in order to get the Events served as they happen.

events

All state changes will create an Event. Events can be fetched here or subscribe to them by webhooks

products

For Mobile POS - use this to setup some nice products.

spots

Use spots to group terminals at same location - or limit the product list at some terminals using spots.

users

Setup users with access restriction and keep track of user performance.

orders

Orders include sales staus, which terminal made the sale, credit card details, orderItems with products and prices and more.

files

Upload product images and other company material.

balance_transactions

payouts

accounts

card_transactions

devices

receipts