Process Payment on File API Call

Learn how to connect your POS to PeopleVine and leverage our payment on file API for enabling convenience to your customers.

In this tutorial we will show you how to leveage the PeopleVine API to process a payment for an order you synced with our platform (please note, the order must already be synced with our platform).  This is used when you want to allow your members and/or customers to user their credit card on file for closing out a ticket at your POS.

To get started, please ensure you have setup your API account and key and have submitted for approval.  Search API on 

API Endpoint:

Request Object: this object will contain a few pieces of data:

  • authenticate_no - this ID is generated when your system is connected via our internal integrations
  • ticketID - this ID is the ID you use to reference the order in your system.  It will be used for saving the order, retreiving the order and process payments against the order
  • business_location_no - this ID is the ID of the location your POS is integrated with
  • provider - please enter your integration's name (<= 25 chars)
  • default_customer_no - this ID should represent the customer_no used when no person is identified
  • payment_type - the type of transcation you're looking to process
    • verify - used to verify if they have a card on file and a balance
    • cardonfile - charge their payment method on file
    • paywithbalance - charge their digital currency (gift certificates)
    • house - charge to their house account
    • balancethencard - charge their digital currency (gift certificates first, then charge their payment method on file)
  • amount - total amount to be charged (not including tip)
  • tip - total tip to be charged.  If a tip is not provided, the payment will be authorized.  Once the tip is provided on order-sync, the charge will automatically capture.
  • payment_id - this ID should reference the payment on your side.  When you complete the transaction you will need to include the ID so we can assign the tip.

e.g. {authenticate_no: 1234, ticketID: '20190726-12345', business_location_no: 2345, provider: 'mypos', default_customer_no: 3456, payment_type: 'cardonfile', amount: 123.45, tip: 0, payment_id: '20190726-12345-9876'}

Response Object: Upon processing the payment, verifying or failing, the API method will provide a reply upon processing.  Please allow proper processing time beforing timing out due to connecting to merchant provider's gateway for processing.  The response will contain the following information:

  • transaction_no - this is the ID in PeopleVine to reference this transaction
  • transaction_id - this is the ID of the transaction from the merchant processor
  • processorResponse - this includes details on whether or not the charge or verification was successful
    • wasProcessed - true if it was processed, false if it was not
    • charge_amount - the amount that was charged, in case there wasn't enough balance on their house credits
    • response - a response message related to the success or failure of the charge
      • Success
        • APPROVED #1234 - when a transaction is approved we will include the transaction_no
        • LAST NAME CC 0.00 - when verifying you will get back their last name, CC if they have a payment method on file and a decimal if they have a balance on their house credits
      • Failures
        • **NOT A MEMBER** - when verifying and we couldn't find the member
        • **NO PROCESSOR** - if no credit card processor is setup
        • **PAYMENT FAILED** - if we werent' able to charge their card due to being declined
        • **DECLINED** - if we werent' able to charge their card due to being declined
        • **NO CARD ON FILE** - when we are unable to find a payment method on file
        • **ADD MEMBER ID** - when we are unable to identify a person on the order

You will need to pass in the payment_id value along with the completed order when a tip is applied to the order.

An example of the flow on how we validate and/or respond to the payment being applied.

Additional Help Tutorials

Find more ways to grow on PeopleVine.

Add Venue Locations to Your Event Setup

You can customize the list of locations where you host your events by following these steps. You can use it to provide locations that are within your space or remote locations.

Posted November 19, 2019

Need to Resend an E-mail/Newsletter to Someone Individually? And even include cc.

You can use the Send Email feature on the CRM to send an e-mail directly to a person, using an existing template.

Posted November 15, 2019

How to Setup a Portal to Allow Your Partners/Operators to Redeem Gift Cards

See how to setup a portal designed for your partners to redeem rewards/gift cards.

Posted November 14, 2019

Integrating and Configuring your Aireus POS with PeopleVine

This step-by-step guide will show you how to utilize the Aireus POS integration with PeopleVine and configure the initial pieces.

Posted November 13, 2019

Understand How Subscriptions are Processed and How to Put on Hold

In this article, we'll share with you the various statuses available for subscriptions and how to leverage them to put people on hold and/or control their access.

Posted November 4, 2019

We Added New Newsletter Snippets and Perfected the Others

You may notice some new snippets in the builder, we just launched 12 additional snippets to help you build better newsletters.

Posted October 31, 2019

Add a CC Email to a CRM Account for their Admin or Another Inbox to get the Same

You can now add a CC Email address to a CRM record that is used to carbon copy any outgoing e-mail to this person.

Posted October 30, 2019

We Updated the Plot on a Map and Added New Reports to Target Groups

With the updated "plot on a map" feature you get a better view of where your customers live. And with our new CRM reports, you can totals of people by location.

Posted October 28, 2019

People Can Transfer Tickets to Other People To Build Your CRM

The goal is to build your CRM of loyal customers and the best way to do that is enabling your ticket purchasers to allow others to participate in the experience with them.

Posted October 28, 2019

Leverage Excel to Build Custom Reports and Charts that Stay Updated

Using the data export engine and the power of excel, you can build out charts, reports and dashboards leveraging live data as it's generated in PeopleVine.

Posted October 26, 2019

Introducing the Reporting Guidebook - An Outline of Available Reports

See samples of the types of reports PeopleVine can generate in order to get a snapshot of your business in real-time.

Posted October 26, 2019

Deploy Your PeopleVine App to the App Store Under Your Brand & Developer Account

Looking to add an app to your digital portfolio? This article will show you how to ensure your brand is all over it including being the publisher, your app name, icon and more. As well helps you gain access to statistics and reviews.

Posted October 24, 2019

How to Setup a Magic Link Login for Your Members who Forget Their Password

You can setup a magic link login form so it's only one-click for your members to access their account.

Posted October 23, 2019

Upcoming Birthdays, Anniversary, Member, Member Since, Applied and Applied On are Now Standard in the CRM

We started to merge our member and CRM experiences into one, as majority of your data is from members.

Posted October 23, 2019

Setup an Application to Capture Spouse/Partner Info and Link Together

Make sure you follow these steps when setting up your application and looking to include spouse or partner information in the application.

Posted October 22, 2019

© PeopleVine 2019. Powered by PeopleVine. Terms of use | Privacy & cookies