Moving Money with the Flash Funds API

 
Once a card has been added to a ProPay account for use with Flash Funds, transferring money via the API is quite simple.  Just give us the ProPay account number, and an amount and the money will appear in the merchants bank account in a few minutes.  That’s all there is to it.
How to call this method?

Example Request

Example Response

Implementation Details
Request Submission

Response Handling

Request Submission

Response Handling

Request Submission

Response Handling

Request Submission

Response Handling

Request Values
Response Values
How to call this method?

You should submit a post of XML data to the following URL
 
HTTP URL(s)
Example Request

Example Response

<?xml version='1.0'?>
<!DOCTYPE Request.dtd>
<XMLRequest>
<certStr>My certStr</certStr>
<class>partner</class>
<XMLTrans>
<transType>45</transType>
<accountNum>123456</accountNum>
<amount>100</amount>
</XMLTrans>
</XMLRequest>
<XMLResponse>
<XMLTrans>
<transType>45</transType>
<accountNum>123456</accountNum>
<status>00</status>
</XMLTrans>
</XMLResponse>
Implementation Details
Request Submission

namespace MSAPI_ProcessTransaction
 {
 using System;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Net;
 using System.Text;
 using System.Xml;
 using System.Xml.Linq;
 using System.Xml.Serialization;

/*
 ProPay provides the following code “AS IS.”
ProPay makes no warranties and ProPay disclaims all warranties and conditions, express, implied or statutory,
 including without limitation the implied warranties of title, non-infringement, merchantability, and fitness for a particular purpose.
 ProPay does not warrant that the code will be uninterrupted or error free,
 nor does ProPay make any warranty as to the performance or any results that may be obtained by use of the code.
 */
 public class ProcessTransactionTransType45
 {
 public static void ProcessTransaction()
 {
 var processRequest = new XmlTransactionRequest { CertificationString = "YourCertStringGoesHere", TerminalID = "YourTermId", };
 var xmlTransaction = new XmlProcessTransaction
 {
 TransType = "45",
 accountNum = "12345678",
 amount = "2000",
 };
 processRequest.Transactions.Add(xmlTransaction);
 string request = XmlSerializer<XmlTransactionRequest>.WriteToString(processRequest);
 SubmitRequest(request);
 }

private static void SubmitRequest(string request)
 {
 byte[] dataToSend = Encoding.UTF8.GetBytes(request);

// Change the following URL to point to production instead of integration
 WebRequest webRequest = WebRequest.Create("https://xmltest.propay.com/API/PropayAPI.aspx");
 webRequest.Method = "POST";
 webRequest.ContentLength = dataToSend.Length;
 webRequest.ContentType = "text/xml";
 Stream dataStream = webRequest.GetRequestStream();
 dataStream.Write(dataToSend, 0, dataToSend.Length);
 dataStream.Close();

string response = string.Empty;

try
 {
 WebResponse apiResponse = webRequest.GetResponse();


using (StreamReader sr = new StreamReader(apiResponse.GetResponseStream()))
 {
 response += sr.ReadToEnd();
 }
 }
 catch (WebException wex)
 {
 HttpWebResponse httpResponse = wex.Response as HttpWebResponse;
 using (Stream responseStream = httpResponse.GetResponseStream())
 using (StreamReader reader = new StreamReader(responseStream))
 {
 response = reader.ReadToEnd();
 }
 }

 ParseResponse(response);
 }

private static void ParseResponse(string response)
 {
 var load = XDocument.Parse(response);
 var transType = Convert.ToInt32(load.Descendants().First(p => p.Name.LocalName == "transType").Value);
 var status = load.Descendants().First(p => p.Name.LocalName == "status").Value;
 var accountNum = load.Descendants().First(p => p.Name.LocalName == "accountNum").Value;
 }
 }

public class XmlProcessTransaction : XmlTransaction
 {
 [XmlElement("accountNum")]
 public string accountNum = string.Empty;
 [XmlElement("amount")]
 public string amount = string.Empty;
 }

public static class XmlSerializer<T>
 {
 public static XmlSerializer Serializer = new XmlSerializer(typeof(T));
 public static string WriteToString(T data)
 {
 return WriteToString(data, Encoding.UTF8);
 }
 public static string WriteToString(T data, Encoding encoding)
 {
 string retVal;
 using (MemoryStream memoryStream = new MemoryStream())
 {
 using (XmlTextWriter xmlTextWriter = new XmlTextWriter(memoryStream, encoding))
 {
 Serializer.Serialize(xmlTextWriter, data);
 }

retVal = encoding.GetString(memoryStream.ToArray());
 }

return retVal;
 }
 }

[XmlInclude(typeof(XmlProcessTransaction))]
 public class XmlTransaction
 {
 [XmlElement("transType")]
 public string TransType = string.Empty;
 }
 [XmlRoot("XMLRequest")]
 public class XmlTransactionRequest
 {
 [XmlElement("certStr")]
 public string CertificationString = string.Empty;
 [XmlElement("termid")]
 public string TerminalID = string.Empty;
 [XmlElement("XMLTrans")]
 public List<XmlTransaction> Transactions = new List<XmlTransaction>();
 }
 }

Response Handling

Request Submission

/**
 * ProPay provides the following code “AS IS.” ProPay makes no warranties and
 * ProPay disclaims all warranties and conditions, express, implied or
 * statutory, including without limitation the implied warranties of title,
 * non-infringement, merchantability, and fitness for a particular purpose.
 * ProPay does not warrant that the code will be uninterrupted or error free,
 * nor does ProPay make any warranty as to the performance or any results that
 * may be obtained by use of the code.
 */


<?php
class ProPayApi
{
/* change this to the production url for going live after testing https://api.propay.com */
private $_apiBaseUrl = 'https://xmltestapi.propay.com';

/* for xml */
/** @var \SimpleXMLElement */
private $_xmlRequestObject;
/** @var \SimpleXMLElement */
private $_xmlResponseObject;
/** @var string */
private $_xmlUrl;

/**
* sets the xml request object
* @param string $xmlData - containing XML
* @return $this
*/
public function setXMLRequestData($xmlData) {
$this->_xmlRequestObject = simplexml_load_string($xmlData);
return $this;
}

/**
* @param string $xmlData - containing XML
* @return $this
*/
public function setXMLResponseData($xmlData) {
$this->_xmlResponseObject = simplexml_load_string($xmlData);
return $this;
}

/**
* @return mixed
*/
public function getXMLRequestObject() {
return $this->_xmlRequestObject;
}

/**
* @return mixed
*/
public function getXMLResponseObject() {
return $this->_xmlResponseObject;
}

/**
* @param \SimpleXMLElement $xmlObject
* @return $this
*/
public function setXMLRequestObject(\SimpleXMLElement $xmlObject) {
$this->_xmlRequestObject = $xmlObject;
return $this;
}

/**
* @param \SimpleXMLElement $xmlObject
* @return $this
*/
public function setXMLResponseObject(\SimpleXMLElement $xmlObject) {
$this->_xmlResponseObject = $xmlObject;
return $this;
}

/**
* sets the url for the XML request
* @param string $xmlUrl
* @return $this
*/
public function setXMLUrl($xmlUrl) {
$this->_xmlUrl = $xmlUrl;
return $this;
}

/**
* posts XML to the server
* @return $this
*/
public function postXML() {
$header = [
"Content-type:text/xml; charset=\"utf-8\"",
"Accept: text/xml"
];


$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => $this->_xmlUrl,
CURLOPT_TIMEOUT => 30,
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $this->_xmlRequestObject->asXML(),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => $header,
CURLOPT_SSL_VERIFYPEER => 0,
CURLOPT_SSL_VERIFYHOST => 0,
CURLOPT_HTTPAUTH => CURLAUTH_ANY
]);
$result = curl_exec($curl);
$this->_xmlResponseObject = simplexml_load_string($result);
curl_close($curl);
return $this;
}
}

$proPayAPI = new ProPayApi();
$data = "<?xml version='1.0'?>
<!DOCTYPE Request.dtd>
<XMLRequest>
</XMLRequest>";
$simpleXML = new \SimpleXMLElement($data);
$simpleXML->addChild('certStr','cert string here');
$simpleXML->addChild('termId','terminal id here');
$simpleXML->addChild('class','partner');
$simpleXML->addChild('XMLTrans');
$simpleXML->XMLTrans->addChild('transType', 209);
$simpleXML->XMLTrans->addChild('accountNum', 123456789);
$simpleXML->XMLTrans->addChild('ccNum', '4747474747474747');
$simpleXML->XMLTrans->addChild('expDate', '1219');
$simpleXML->XMLTrans->addChild('cardholderName', 'TesterMcTest');
$simpleXML->XMLTrans->addChild('streetAddress', '3400 Ashton Blvd');
$simpleXML->XMLTrans->addChild('state', 'UT');
$simpleXML->XMLTrans->addChild('zipCode', '84043');

// returns XML
$result =
$proPayAPI->setXMLUrl('https://xmltest.propay.com/API/PropayAPI.aspx')
->setXMLRequestData($simpleXML->asXML())
->postXML()
->getXMLResponseObject()->asXML();

// if you prefer a simpleXML object you just retrieve the object back to work with that
$result = $proPayAPI->getXMLResponseObject();

Response Handling

Request Submission

Response Handling

Request Submission

Response Handling

Request Values

Element

Type

Max

Required

Notes

accountNum

Int(32)

 

Required

Assigned to each account by ProPay.

amount

Int(32)

 

Required

The value representing the number of pennies in USD, or the number of [currency] without decimals.

Response Values

Element

Type

Notes

status

string

Result of the transaction request. See ProPay Appendix for result code definitions

accountNum

integer

Echo of the account the API request was made for

How to call this method?

Example Request

Example Response

Implementation Details
Request Submission

Response Handling

Request Submission

Response Handling

Request Submission

Response Handling

Request Submission

Response Handling

Request Values
Response Values