Function: GetBalances

The GetBalances function returns the payer's payment provider account balances. When submitting a payment, it may take some time for the balance to be updated.

The following is a sample SOAP 1.2 request and response. In the request, you need to replace the data types in yellow with actual values.

SOAP 1.2: Request

POST /payerfunctions.asmx HTTP/1.1

Host: api.tipalti.com

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

<?xml version="1.0" encoding="utf-8"?>

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

<soap12:Body>

<GetBalances xmlns="http://Tipalti.org/">

<payerName>string</payerName>

<timestamp>double</timestamp>

<key>string</key>

</GetBalances>

</soap12:Body>

</soap12:Envelope>

SOAP 1.2: Response

HTTP/1.1 200 OK

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

<?xml version="1.0" encoding="utf-8"?>

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

<soap12:Body>

<GetBalancesResponse xmlns="http://Tipalti.org/">

<GetBalancesResult>

<errorMessage>string</errorMessage>

<errorCode>integer</errorCode>

<AccountInfos>

<TipaltiAccountInfo>

<AccountType>string</AccountType>

<Balance>double</Balance>

<currency>string</currency>

</TipaltiAccountInfo>

<TipaltiAccountInfo>

<AccountType>string</AccountType>

<Balance>double</Balance>

<currency>string</currency>

</TipaltiAccountInfo>

</AccountInfos>

</GetBalancesResult>

</GetBalancesResponse>

</soap12:Body>

</soap12:Envelope>

Request parameters

element	description	limitation	Mandatory?	data type
payerName	The name of the payer, as assigned by Tipalti	Max. length = 50 Value is case sensitive	Mandatory	string
timestamp	Current time (UTC) when the request is sent	Unix time	Mandatory	double
key	Encryption key		Mandatory	string

Response parameters

element	description	data type
GetBalancesResult	Contains the response parameters	TipaltiGetBalanceResponse

TipaltiGetBalanceResponse

element	description	Limitation	data type
errorMessage	A description of the error	See API error codes.	string
errorCode	The status of the error	See API error codes.	integer
AccountInfos	List of accounts information Each account is of type TipaltiAccountInfo		Array of TipaltiAccountInfo

TipaltiAccountInfo

element	description	limitation	data type
AccountType	Type of Tipalti account	Valid values: Bank PayPal PrePaidCard Intercash	string
Balance	The total amount of funds available in the account		double
currency	Payment provider account currency	Length = 3 (per ISO 4217)	string