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 card on file
    • paywithbalance - charge their digital currency (gift certificates)
    • house - charge to their house account
  • 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.

Prompt Questions When Checking Someone In At Your Space

Now when your members are checked in using the Control Panel, /Checkin or when scanning their QR code you can prompt a form to capture information on their visit.

Posted August 10, 2019

Ready for a Real Billing Platform (for those not using PeopleVine Billing)

Migrate to PeopleVine Billing for Memberships and streamline your business with the ultimate in "lock-down" abilities for non-payers. Get paid on-time and all the time with PeopleVine Billing.

Posted August 9, 2019

PeopleVine + SevenRooms = Hospitality Perfected

We are proud to introduce our latest update to the platform that includes a tighter integration with SevenRooms to create the ultimate hospitality experience.

Posted August 9, 2019

PeopleVine Webhooks Sync Your Data in Real-Time with Any Other System (if you needed to)

With PeopleVine Webhooks, you can sync every touchpoint with your existing systems to keep your legacy platforms updated in real-time. This article will show you how to setup a webhook and dynamically populate the data into it.

Posted July 29, 2019

Leverage "Get Items" to Automatically Issue Perks to Members + Re-Issue Perks

You can leverage the "get items" feature in order to issue perks to your members after signing up and renewing annually.

Posted July 29, 2019

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.

Posted July 27, 2019

HAPI - Setup a custom page displaying available locations based on the user's location

This code sample provides a way to automatically sort your locations by the closest distance to the user.

Posted July 22, 2019

Add Facebook Pixel Tracking to Your Website - Step by Step Guide

See how to add a Facebook Tracking Pixel to your website and start to target specific actions.

Posted July 12, 2019

New Reports + Improved Reporting Engine

Check out the new reporting tools and grid view with sorting and filtering of the live data.

Posted July 9, 2019

Get Notified When a Member Checks In

You can subscribe to text message alerts when a specific member or members from a specific membership program arrive at your space.

Posted July 9, 2019

How to Utilize and Change the Default Event Graphic

When adding an event to your calendar, having a photo just makes it look that much more enticing, therefore, if you forget one, we'll add a default one for you. But if you don't like ours, read this article to see how you can change it.

Posted July 9, 2019

What happens when the POS and PeopleVine connection stops?

We'll share with you some tips and steps for handling the exception when a POS and PeopleVine connection stops.

Posted June 25, 2019

The Ultimate Agency Tool - Import a Folder of Snippets Directly into the Drag and Drop Builder

Instead of taking the time to copy and paste the HTML, enter a title and take a screenshot, you can now drag and drop folders full of HTML snippets and we'll set them up, categorize them and add a screenshot of the rendered snippet.

Posted June 22, 2019

Improved Transaction Email with Option to Download as PDF

We have made it easier to send someone a transaction receipt by including an out-of-the-box template and a new option to download as a PDF.

Posted June 18, 2019

Make Your Order Receipts Member Friendly

You now have better control over the items that show up on an order receipt in your member portal.

Posted June 18, 2019

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