Developers

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.
Download PDFView PDF

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.
Download PDFView PDF

Custom Payment Redirect

Custom white-label for merchants who want to offload PCI Compliance responsibility to Sparrow and implement 3D Secure transaction processing.

Download PDFView PDF

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.

Download PDFView PDF

Echo Web Services – Invocation Specification

The Invocation Specification provides details regarding the Echo Data Exchange and how it delivers data to external web services
Download PDFView PDF

Fubon/China Union Pay Integration

Fubon and China Union Pay merchant accounts will communicate through their secured sites
with their associated banks to process 3DS cards. All payments will be processed through the SPARROW redirect. This document provides detail regarding transaction variables, process workflow and return values for these processors
Download PDFView PDF

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.

Download PDFView PDF

Merchant Public API

The SPARROW gateway provides a set of services which can be used for integration to merchant’s systems. The Merchant Public API provides the following RESTful services:

    • Account service – an auxiliary service used to obtain the authentication token required for invoking other Merchant Public API services
    • Transaction service ‐ this service allows merchants to run a query of transactions processed by the merchant in the Sparrow Gateway
    • Terminal service – this service provides control functions over transaction processing

Download PDFView PDF

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.

Download PDFView PDF

Portfolio

Learn more about SPARROW’s client diversity, mobile compatible solutions, global reach and company milestones
Download PDFView PDF

Redirect 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.
Download PDFView PDF

SPARROW Service API- 3D Secure Fields

3-D Secure is an authenticated payment system used to improve online transaction security and encourage
the growth of e-commerce payments. It is easy to use, without complex integration with a commercial MPI system. This document describes the set up and process for using SPARROWs 3D secure integration
Download PDFView PDF

Sparrow Client(Front-end) API

The SPARROW Client API (SCA) allows merchants to receive payments without storing payment information on their servers (PCI DSS license is not required) as well as without using the Payment Redirect.
Download PDFView PDF

Sparrow PGP

Download File

Settlement API

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.

Download PDFView PDF

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.

Download PDFView PDF