TipaltiPayerSOAPV5
Click here for a complete list of operations.
GetBalances
Get balances in your accounts. Returns account provider, account identifier, currency and amount in balance.
Note: when submitting a payment, the balance may take some time before it is updated
EAT - none
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /v5/PayerFunctions.asmx HTTP/1.1
Host: api.tipalti.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://Tipalti.org/GetBalances"
<?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>
<GetBalances xmlns="http://Tipalti.org/">
<payerName>string</payerName>
<timestamp>double</timestamp>
<key>string</key>
</GetBalances>
</soap:Body>
</soap:Envelope>
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>
<GetBalancesResponse xmlns="http://Tipalti.org/">
<GetBalancesResult>
<errorMessage>string</errorMessage>
<errorCode>int</errorCode>
<AccountInfos>
<TipaltiAccountInfo>
<Provider>None or Citi_Deprecated or PayPal or Payoneer or Payer or Tipalti or WellsFargo or Earthport or Skrill or EntroPay or Intercash or AstroPay or Chexx or JPMorgan or Citi or JPMorganWallets or CitiConnect or Marqeta</Provider>
<AccountIdentifier>string</AccountIdentifier>
<Balance>double</Balance>
<Currency>string</Currency>
</TipaltiAccountInfo>
<TipaltiAccountInfo>
<Provider>None or Citi_Deprecated or PayPal or Payoneer or Payer or Tipalti or WellsFargo or Earthport or Skrill or EntroPay or Intercash or AstroPay or Chexx or JPMorgan or Citi or JPMorganWallets or CitiConnect or Marqeta</Provider>
<AccountIdentifier>string</AccountIdentifier>
<Balance>double</Balance>
<Currency>string</Currency>
</TipaltiAccountInfo>
</AccountInfos>
</GetBalancesResult>
</GetBalancesResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /v5/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>
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>int</errorCode>
<AccountInfos>
<TipaltiAccountInfo>
<Provider>None or Citi_Deprecated or PayPal or Payoneer or Payer or Tipalti or WellsFargo or Earthport or Skrill or EntroPay or Intercash or AstroPay or Chexx or JPMorgan or Citi or JPMorganWallets or CitiConnect or Marqeta</Provider>
<AccountIdentifier>string</AccountIdentifier>
<Balance>double</Balance>
<Currency>string</Currency>
</TipaltiAccountInfo>
<TipaltiAccountInfo>
<Provider>None or Citi_Deprecated or PayPal or Payoneer or Payer or Tipalti or WellsFargo or Earthport or Skrill or EntroPay or Intercash or AstroPay or Chexx or JPMorgan or Citi or JPMorganWallets or CitiConnect or Marqeta</Provider>
<AccountIdentifier>string</AccountIdentifier>
<Balance>double</Balance>
<Currency>string</Currency>
</TipaltiAccountInfo>
</AccountInfos>
</GetBalancesResult>
</GetBalancesResponse>
</soap12:Body>
</soap12:Envelope>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /v5/PayerFunctions.asmx/GetBalances HTTP/1.1 Host: api.tipalti.com Content-Type: application/x-www-form-urlencoded Content-Length: length payerName=string×tamp=string&key=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<TipaltiGetBalanceResponse xmlns="http://Tipalti.org/">
<errorMessage>string</errorMessage>
<errorCode>int</errorCode>
<AccountInfos>
<TipaltiAccountInfo>
<Provider>None or Citi_Deprecated or PayPal or Payoneer or Payer or Tipalti or WellsFargo or Earthport or Skrill or EntroPay or Intercash or AstroPay or Chexx or JPMorgan or Citi or JPMorganWallets or CitiConnect or Marqeta</Provider>
<AccountIdentifier>string</AccountIdentifier>
<Balance>double</Balance>
<Currency>string</Currency>
</TipaltiAccountInfo>
<TipaltiAccountInfo>
<Provider>None or Citi_Deprecated or PayPal or Payoneer or Payer or Tipalti or WellsFargo or Earthport or Skrill or EntroPay or Intercash or AstroPay or Chexx or JPMorgan or Citi or JPMorganWallets or CitiConnect or Marqeta</Provider>
<AccountIdentifier>string</AccountIdentifier>
<Balance>double</Balance>
<Currency>string</Currency>
</TipaltiAccountInfo>
</AccountInfos>
</TipaltiGetBalanceResponse>