API Descriptions: There are two primary options in which transactions can be submitted through the SPARROW API. Additional APIs are available to automate tokenization, ecommerce, mobile and secure redirect payments.
Service API for Developers
The most transparent method of submitting transactions is through the Services API method. This document describes the architecture and implementation of Services API.
The Payment Redirect Method allows merchants to send consumers to a secure web page for credit card and ACH processing. The Redirect API explains how to call the secure payment pages and how to receive transaction information when the sale is complete. The Redirect payment processing takes the merchants’ systems out of scope for PCI compliance.
Client-side Payment API
The merchant is able to receive payments without storing payment information on their servers (PCI DSS license is not required). This method uses client-side scripting at the merchant’s site, which allows you to integrate without using the “Payment Redirect” API.
Merchant Upload API
Use: Integrated merchant boarding. Upload a single or large lists of merchants for boarding and gateway processing. This document describes Merchant upload API.
- Upload merchant in xlsx format using Merchant Upload page.
- Upload merchant in xml format using API.
Note: Users can also create merchants manually using board merchant wizard.
Data Vault Payment Type API
The Data Vault payment type API allows merchants to create, read, update and delete Data Vault customers and their tokenized payment types.
Custom Payment Redirect
Custom white-label for merchants who want to offload PCI Compliance responsibility to Sparrow and implement 3D Secure transaction processing.
Transaction Query API
Merchant is able to query the database for historical transaction data. This API method allows for a multitude of parameters to facilitate robust transaction queries that will simplify merchant reconciliation and 3rd party reports.
Creates a batch of settlement files and sends the information to the processors. It allows users to send settlement for multiple transactions and provides flexibility to control how, when, and which transactions should be settled.
Merchant Public Services Split Funding API
The Sparrow Gateway provides a set of services which can be used for integrating the gateway with merchant’s IT systems. Merchant Public API provides the following RESTfull services:
- Account service – it is auxiliary service to obtain the authentication token required for invoking other Merchant Public API services
- Transaction service – this service allows querying transactions processed by the merchant in the Sparrow Gateway
- Terminal service – this service provides control functions over transaction processing
- Split Funding service – this service provides control functions over split funding groups
This document provides architectural overview of Merchant Public API and describes the services included into this API.