Function: GetProviderAccounts

The GetProviderAccounts function returns a list of the payer's payment provider accounts.

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>

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

<payerName>string</payerName>

<timestamp>double</timestamp>

<key>string</key>

</GetProvidersAccounts>

</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>

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

<GetProvidersAccountsResult>

<errorMessage>string</errorMessage>

<errorCode>string</errorCode>

<AccountsInfo>

<AccountInfo>

<Provider>string</Provider>

<AccountIdentifier>string</AccountIdentifier>

<Currency>string</Currency>

<DisplayName>string</DisplayName>

<PayerEntityName>string</PayerEntityName>

</AccountInfo>

<AccountInfo>

<Provider>string</Provider>

<AccountIdentifier>string</AccountIdentifier>

<Currency>string</Currency>

<DisplayName>string</DisplayName>

<PayerEntityName>string</PayerEntityName>

</AccountInfo>

</AccountsInfo>

</GetProvidersAccountsResult>

</GetProvidersAccountsResponse>

</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
GetProviderAccountsResult Contains the response parameters TipaltiGetProvider
AccountsResponse

TipaltiGetProviderAccountsResponse

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. string
AccountsInfo
  • List of accounts information
  • Each account is of type AccountInfo.
   Array of AccountInfo
AccountInfo

element

DESCRIPTION

LIMITATION

DATA TYPE
Provider The provider name

Valid values:

  • None
  • PayPal
  • Payoneer
  • Payer
  • Intercash
  • Tipalti
  • WellsFargo
  • Earthport
  • External
string
AccountIdentifier An identifier for the provider account   string
Currency Payment provider account currency Length = 3 (per ISO 4217) string
DisplayName The name of the provider account, as displayed in Tipalti
  • For virtual accounts (VAs), the display name of the VA is returned.
  • For the Account Direction model, the actual bank name displays.
 string
PayerEntityName The name of the payer entity linked to the provider account
  • Max. length = 100
  • Alphanumeric characters only
 string