Function: GetPODetails

The GetPayeesChangedSinceTimestamp function returns the IDs of all payees whose information has changed after a given date.

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 /v3/payeefunctions.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>

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

<payerName>string</payerName>

<idap>string</idap>

<timestamp>double</timestamp>

<key>string</key>

<poRefCode>string</poRefCode>

</GetPODetails>

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

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

<soap12:Body>

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

<GetPODetailsResult>

<errorMessage>string</errorMessage>

<errorCode>string</errorCode>

<b>boolean</b>

<i>integer</i>

<d>double</d>

<s>string</s>

<RefCode>string</RefCode>

<SubmittionDate>dateTime</SubmittionDate>

<AmountSubmitted>double</AmountSubmitted>

<PaymentMethod>string</PaymentMethod>

<POStatus>string</POStatus>

<PayerFees>double</PayerFees>

<PayeeFees>double</PayeeFees>

<ErrorMessages>

<string>string</string>

<string>string</string>

</ErrorMessages>

<ValueDate>dateTime</ValueDate>

<Message>string</Message>

<BankingMessage>string</BankingMessage>

<EmailSubject>string</EmailSubject>

<TxnReference>string</TxnReference>

<PaymentAmount>double</PaymentAmount>

<PaymentCurrency>string</PaymentCurrency>

<LiftingFees>double</LiftingFees>

<EstimatedProviderFees>double</EstimatedProviderFees>

</GetPODetailsResult>

</GetPODetailsResponse>

</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
poRefCode The reference code for the payment order
  • ASCII: max. length = 16 (Account Direction model: max. length = 15)
  • Valid special characters: hyphens, underscores
 Mandatory string

Response parameters

element

description

data type
GetPODetailsResult Contains the response parameters TipaltiPaymentOrderResponse (extension of type TipaltiResponse)

TipaltiPaymentOrderResponse

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
RefCode The reference code for the payment order
  • ASCII: max. length = 16 (Account Direction model: max. length = 15)
  • Valid special characters: hyphens, underscores
 string
SubmittionDate The date and time the payment was submitted to Tipalti MMM DD, YYYY hh:mm:ss.sss dateTime
AmountSubmitted The amount submitted for payment   double
PaymentMethod Payee payment method

Valid values:

  • NoPM
  • PayPal
  • WireTransfer
  • Payoneer
  • ACH
  • Check
  • Global ACH/Local bank transfer
  • HoldMyPayments
  • Custom
  • Intercash
string
POStatus The status of the payment order See Statuses. string
PayerFees The fee amount that the payer paid to Tipalti   double
PayeeFees
  • The part of the Tipalti transaction fee (which is based on the payer agreement with Tipalti) that is incurred by the payee
  • The fee is based on the payee selected payment method and is deducted from the amount paid to the payee.
   double
ErrorMessages If the payment has errors, a list of these errors is returned.   Array of string
ValueDate Estimated date and time the payee will receive the funds MMM DD, YYYY hh:mm:ss.sss dateTime
Message The payer's EWalletMessage that was attached to the payment
  • Max. length = 160
  • Default = null
 string
BankingMessage The payer's banking message that was attached to the payment
  • Max. length = 160
  • Default = null
  • Supported for:
    • ACH
    • Check
    • Global ACH/Local bank transfer
    • Wire transfer
string
EmailSubject The payer's EmailMessage that was attached to the payment
  • Max. length = 255
  • Default = null
 string
TxnReference Payment provider's transaction reference code Max. length = 450 string
PaymentAmount The amount paid to the payee in the currency selected by the payee   double
PaymentCurrency The payment currency selected by the payee Length = 3 (per ISO 4217) string
LiftingFees Fee charged by the bank on a returned payment   double
EstimatedProviderFees Additional fees that may be required by the provider   double
string

element

description

limitation

data type
string The payment error See Payment error codes. string