Exigo Web Services API v2018.8.27.1

FundPaymentCard

Creates a new payout and funds a payment card for one or more bills and updates status

Input Properties

FundPaymentCardRequest
PropertyData TypeNotes
PaymentCardTypeIDInt32
BillIDListInt32[]
CustomerIDInt32Unique numeric identifier for customer record.
BankAccountIDInt32
ReferenceStringOptional.
TransactionNoteStringOptional.
PaymentDateDateTimeOptional.
CustomerKeyStringOptional. Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

Output Properties

FundPaymentCardResponse
PropertyData TypeNotes
PayoutIDInt32
TotalDollarAmountDecimal

SOAP Request

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /3.0/ExigoApi.asmx HTTP/1.1
Host: api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.exigo.com/FundPaymentCard"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Header> <ApiAuthentication xmlns="http://api.exigo.com/"> <LoginName>string</LoginName> <Password>string</Password> <Company>string</Company> <Identity>string</Identity> <RequestTimeUtc>dateTime</RequestTimeUtc> <Signature>string</Signature> </ApiAuthentication> </soap:Header> <soap:Body> <FundPaymentCardRequest xmlns="http://api.exigo.com/"> <PaymentCardTypeID>int</PaymentCardTypeID> <BillIDList> <int>int</int> </BillIDList> </FundPaymentCardRequest> </soap:Body> </soap:Envelope>

SOAP Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <FundPaymentCardResult xmlns="http://api.exigo.com/" /> </soap:Body> </soap:Envelope>

C#

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.LoginName = "yourLoginName";

    auth.Password = "yourPassword";

    auth.Company = "yourCompany";

    api.ApiAuthenticationValue = auth;

 

    //Create Request

    FundPaymentCardRequest req = new FundPaymentCardRequest();

 

    req.PaymentCardTypeID = 1;

 

    //Add BillIDList

    List<Int32> billidlist = new List<Int32>();

    billidlist.Add(1);

    billidlist.Add(2);

 

    //Now attach the list to the request

    req.BillIDList = billidlist.ToArray();

    req.CustomerID = 1;             //Unique numeric identifier for customer record.

    req.BankAccountID = 1;

    req.Reference = "1";

    req.TransactionNote = "1";

    req.PaymentDate = DateTime.Today;

    req.CustomerKey = "1";          //Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

 

    //Send Request to Server and Get Response

    FundPaymentCardResponse res = api.FundPaymentCard(req);

 

    //Now examine the results:

    Console.WriteLine("PayoutID: {0}", res.PayoutID);

    Console.WriteLine("TotalDollarAmount: {0}", res.TotalDollarAmount);

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

VB.Net

Try

    'Create Main API Context Object

    Dim api as new ExigoApi()

 

    'Create Authentication Header

    Dim auth as new ApiAuthentication()

    auth.LoginName = "yourLoginName"

    auth.Password = "yourPassword"

    auth.Company = "yourCompany"

    api.ApiAuthenticationValue = auth

 

    'Create Request

    Dim req as new FundPaymentCardRequest()

 

    req.PaymentCardTypeID = 1

 

    'Add BillIDList

    Dim billidlist As New List(Of Int32)()

    billidlist.Add(1)

    billidlist.Add(2)

 

    'Now attach the list to the request

    req.BillIDList = billidlist.ToArray()

    req.CustomerID = 1

    req.BankAccountID = 1

    req.Reference = "1"

    req.TransactionNote = "1"

    req.PaymentDate = DateTime.Today

    req.CustomerKey = "1"

 

    'Send Request to Server and Get Response

    Dim res As FundPaymentCardResponse = api.FundPaymentCard(req)

 

    'Now examine the results:

    Console.WriteLine("PayoutID: {0}", res.PayoutID)

    Console.WriteLine("TotalDollarAmount: {0}", res.TotalDollarAmount)

Catch ex As Exception

    Console.WriteLine("Error: " & ex.Message)

End Try

PHP

Note: PHP is not officially supported.

<?php

try

{

    //Setup the SoapClient and Authentication

    $api = new SoapClient("http://api.exigo.com/3.0/ExigoApi.asmx?WSDL");

    $ns = "http://api.exigo.com/";

    $auth = array()

    $auth["LoginName"] = new SoapVar("yourLoginName",XSD_STRING,null,null,null,$ns);

    $auth["Password"] = new SoapVar("yourPassword",XSD_STRING,null,null,null,$ns);

    $auth["Company"] = new SoapVar("yourCompany",XSD_STRING,null,null,null,$ns);

    $headerBody = new SoapVar($auth, SOAP_ENC_OBJECT);

    $header = new SoapHeader($ns, 'ApiAuthentication', $headerBody);

    $api->__setSoapHeaders(array($header));

 

    //Create Request

 

    $req->PaymentCardTypeID = 1;

 

    //Add BillIDList

 

 

 

    //Now attach the list to the request

    req.BillIDList = array(billIDLis1,billIDLis2);

    $req->CustomerID = 1;

    $req->BankAccountID = 1;

    $req->Reference = "1";

    $req->TransactionNote = "1";

    $req->PaymentDate = 1;

    $req->CustomerKey = "1";

 

    //Send Request to Server and Get Response

    $res = $api.FundPaymentCard($req);

 

    //Now examine the results:

}

catch (SoapFault $ex)

{

    echo "Error: ", $ex->getMessage();

}

?>

Java

Note: Java is not officially supported.

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.setLoginName("yourLoginName");

    auth.setPassword("yourPassword");

    auth.setCompany("yourCompany");

    api.setApiAuthenticationValue(auth);

 

    //Create Request

    FundPaymentCardRequest req = new FundPaymentCardRequest();

 

    req.setPaymentCardTypeID(1);

 

    //Add BillIDList

    ArrayOfSystem.Int32 billidlist = new ArrayOfSystem.Int32();

 

    Int32 billIDLis1 = new Int32();

    billidlist.Add(billIDLis1);

 

    Int32 billIDLis2 = new Int32();

    billidlist.Add(billIDLis2);

 

    //Now attach the list to the request

    req.setBillIDList(billidlist);

    req.setCustomerID(1);

    req.setBankAccountID(1);

    req.setReference("1");

    req.setTransactionNote("1");

    req.setPaymentDate(1);

    req.setCustomerKey("1");

 

    //Send Request to Server and Get Response

    FundPaymentCardResponse res = api.getExigoApiSoap().fundPaymentCard(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

    System.out.println("Error: " + ex.getMessage());

}

CSV

This method does not support csv output.