Function: GetPayerFees

The GetPayerFees function returns a list of payer or payee fees per entity An entity can be a subsidiary, division, business unit, brand, etc. of your organization. Entities can have similar or different AP processes and workflows. charged between specific dates. The entity is defined according to the virtual account from which the fees were collected.

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

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

<payerName>string</payerName>

<timestamp>double</timestamp>

<key>string</key>

<beginDateTimeStamp>double</beginDateTimeStamp>

<endDateTimeStamp>double</endDateTimeStamp>

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

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

<GetPayerFeesResult>

<errorMessage>string</errorMessage>

<errorCode>string</errorCode>

<b>boolean</b>

<i>integer</i>

<d>double</d>

<s>string</s>

<TipaltiFees>

<TipaltiFee>

<TipaltiFeeReference>string</TipaltiFeeReference>

<FeeCollectionDate>dateTime</FeeCollectionDate>

<FeeCurrency>string</FeeCurrency>

<FeeAmount>double</FeeAmount>

<FeeDescription>string</FeeDescription>

<PayerEntityName>string</PayerEntityName>

<Provider>string</Provider>

<AccountIdentifier>string</AccountIdentifier>

</TipaltiFee>

<TipaltiFee>

<TipaltiFeeReference>string</TipaltiFeeReference>

<FeeCollectionDate>dateTime</FeeCollectionDate>

<FeeCurrency>string</FeeCurrency>

<FeeAmount>double</FeeAmount>

<FeeDescription>string</FeeDescription>

<PayerEntityName>string</PayerEntityName>

<Provider>string</Provider>

<AccountIdentifier>string</AccountIdentifier>

</TipaltiFee>

</TipaltiFees>

</GetPayerFeesResult>

</GetPayerFeesResponse>

</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
beginDateTimeStamp Start of date range Unix time Mandatory double
endDateTimeStamp End of date range Unix time Mandatory double

Response parameters

element

description

data type
GetPayerFeesResult Contains the response parameters TipaltiGetPayerFeesResponse (extension of type TipaltiResponse)

TipaltiGetPayerFeesResponse

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
TipaltiFees
  • List of payer fees
  • Each fee is of type TipaltiFee.
   Array of TipaltiFee
TipaltiFee

element

Description

Limitation

Data Type
TipaltiFeeReference Tipalti-generated reference code for payer fees   string
FeeCollectionDate The date and time the fee is collected YYYY-MM-DDThh:mm:ss, where T indicates the start of the time section dateTime
FeeCurrency The currency of the fee Length = 3 (per ISO 4217) string
FeeAmount
  • The amount of the fee
  • The value equals the daily sum of transaction fees (both payer and payee transaction fees) + payer FX fees + lifting fees for all finalized payments.
   double
FeeDescription A description of the fee collected (e.g., transaction fee, lifting fee, foreign exchange fee, etc.)   string
PayerEntityName The name of the payer entity linked to the fee
  • Max. length = 100
  • Alphanumeric characters only
 string
Provider Name of the provider that has paid the fees

Valid values:

  • None
  • PayPal
  • Payoneer
  • Payer
  • Intercash
  • Tipalti
  • WellsFargo
  • Earthport
  • External
string
AccountIdentifier An identifier for the provider account   string