Function: GetPayerEntities

The GetPayerEntities function returns a list of payer entities.

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

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

<payerName>string</payerName>

<timestamp>double</timestamp>

<key>string</key>

</GetPayerFees>

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

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

<GetPayerEntitiesResult>

<errorMessage>string</errorMessage>

<errorCode>string</errorCode>

<b>boolean</b>

<i>integer</i>

<d>double</d>

<s>string</s>

<PayerEntities>

<PayerEntityInfo>

<EntityName>string</EntityName>

<LegalName>string</LegalName>

<IsDefault>boolean</IsDefault>

<BrandName>string</BrandName>

<ExternalID>string</ExternalID>

</PayerEntityInfo>

<PayerEntityInfo>

<EntityName>string</EntityName>

<LegalName>string</LegalName>

<IsDefault>boolean</IsDefault>

<BrandName>string</BrandName>

<ExternalID>string</ExternalID>

</PayerEntityInfo>

</PayerEntities>

</GetPayerEntitiesResult>

</GetPayerEntitiesResponse>

</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
GetPayerEntitiesResult Contains the response parameters TipaltiGetPayerEntitiesResponse (extension of type TipaltiResponse)

TipaltiGetPayerEntitiesResponse

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
b If the return code is Boolean, this parameter will carry the value.   boolean
i If the return code is integer, this parameter will carry the value.   integer
d If the return code is double, this parameter will carry the value.   double
s If the return code is string, this parameter will carry the value.   string
PayerEntities
  • List of payer entities
  • Each payer entity is of type PayerEntityInfo
   Array of PayerEntityInfo
PayerEntityInfo

element

Description

Limitation

Data Type
EntityName The name of the payer entity in Tipalti
  • Max. length = 100
  • Alphanumeric characters only
 string
LegalName Legal name of payer   string
IsDefault Indicates if the payer entity is the default for the payer   boolean
BrandName The brand name of the payer   string
ExternalId The payer entity ID in the ERP Max. length = 200 string