Custom API Integrations
Authvia has a robust set of RESTful API calls that allow partners and independent developers to create custom integrations and applications based on the Authvia billing, payment, and messaging platform.
Integrating with an existing billing system, CRM, or payment gateway is quick and simple.
Whether you’re building a custom interface, running a transaction, or simply sending a bill notification via our SMS messaging, our technical support team can assist with the design architecture and deployment of a custom billing solution utilizing your current infrastructure, payment partners, and customer database.
All Authvia API requests and responses are transmitted over HTTPS using a Secure Socket Layer (SSL) or Transport Layer Security (TLS) as a sublayer. These standard internet security protocols ensure that API calls are transmitted in an encrypted format.
API request and response payloads are formatted as application/JSON. For reporting outputs, the API responds with a CSV export files.
Authvia API V2 documentation is available at http://docs.p2d.io/reference
[Note: Our Authvia API V1 is no longer supported. Applications built on our previous V1 version are encouraged to move to the latest AuthVia API V2 version. All new requests for developer credentials will be associated with the AuthVia API V2 sandbox.]
Authvia API Use Cases
Use Case 1 – Existing Customer Base Opting Into Text-Pay
Your business already has several registered users and would like to offer them the ability to pay via text. This initiative is part of your business’s push to go to a paperless billing system. Unfortunately, you’ve never asked for or collected their cell phone numbers as part of their user profile. To promote text-pay you’ve sent out emails to encourage users to visit their user profile and select the text-pay opt-in button.
When a user selects this button, they are asked to provide their mobile number. After you collect their number, you create a basic user within Authvia and then update that record with the payment method information you already have on file. This is done either synchronously or asynchronously as a grouped set of Authvia API calls.
The next time a bill is ready, you create a payable via the Authvia API. This triggers a text-pay message to be sent to the cell phone associated with that user. The user responds by replying with the last 4-digits of their phone number and the payment is automatically processed by your gateway.
Use Case 2 – New Customer Registrations Opting into Text-Pay
Your website hosts a web form for customers to create an account so they can make online payments. As part of that registration form you collect contact information and a credit card payment method. You would also like to add the option to pay by text. You do this by adding an opt-in to text-pay section on your registration form, which collects the registrant’s mobile phone number.
Once the customer submits the registration, you create a user in your system and a basic user within Authvia, immediately updating the Authvia record with the payment method information that was also submitted. This is done either synchronously or asynchronously as a grouped set of Authvia API calls.
The next time a bill is ready, you create a payable via the Authvia API. This triggers a text-pay message to be sent to the cell phone associated with the user record. The user responds by replying with the last 4-digits of their phone number and the payment is automatically processed by your gateway.
Use Case 3 – Custom Customer Management Portal Design
You already have a website where customers can open support tickets and signup for new services. You would like to leverage this website and expand functionality to take both web and text-based payments by allowing users to create accounts and save a payment method on file.
The Authvia API is perfect for developers looking to build custom user interfaces to serve their customer base. Using Authvia’s API, customer accounts can be created, payment methods securely added, and credit cards or bank account information securely stored as tokens. At no point will actual credit numbers or bank account details be stored in the raw. From within this custom consumer portal, web-based transactions can be securely made, by leveraging the stored information hosted by Authvia.
Use Case 4 – A New Invoice is Generated for a Customer
You have already set up a number of basic user accounts within Authvia and attached a payment method to each of these customers. Every 15th of the month your business generates bills for the upcoming month. As part of that process, you send out an email with the bill details – amount owed and due date. You would like to replace this customer contact mechanism with text-pay to increase response rates, increase cash flow through early payments, and reduce late payments.
When the monthly bills are generated, instead of generating a personalized email with the payment information, a request into the Authvia API is made to create a payable. Creating the payable triggers a text-pay message to be sent to the customer’s cell phone. The customer responds to the text by replying with the last 4-digits of their phone number and the payment is automatically processed via your gateway.
Use Case 5 – Customer Support Functions
Having customer support rely on multiple systems is time consuming and results in a poor customer experience. Using the Authvia API allows customer support organizations to programmatically integrate bill payment activities, user account maintenance, and merchant configuration settings within a central customer support application.
High volume support tasks are accessed through the support application UI, while the individual tasks are accomplished programmatically using specific API endpoints.