Function: GetPayeeDetails

The GetPayeeDetails function returns information for a specific payee.

This API call requires you to enter a payee ID (idap). You can find the payee ID on the payee's record in the Tipalti Hub or you can get a list of all payee IDs by using the CreatePayeeStatusFile API.

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

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

<payerName>string</payerName>

<timestamp>double</timestamp>

<key>string</key>

<idap>string</idap>

</GetPayeeDetails>

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

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

<GetPayeeDetailsResult>

<errorMessage>string</errorMessage>

<errorCode>string</errorCode>

<b>boolean</b>

<i>integer</i>

<d>double</d>

<s>string</s>

<Name>string</Name>

<CompanyName>string</CompanyName>

<Alias>string</Alias>

<Address>string</Address>

<PaymentMethod>string</PaymentMethod>

<Email>string</Email>

</GetPayeeDetailsResult>

</GetPayeeDetailsResponse>

</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
idap Unique payee identifier (the payee ID)
  • Max. length = 64
  • Valid characters:
    • Numbers
    • Letters
    • Commas
    • Periods
    • Underscores
    • Dashes
  • No spaces allowed
 Mandatory string

Response parameters

The result of the GetPayeeDetails function is provided in the "s" parameter.

Element

Description

Data Type
GetPayeeDetailsResult Contains the response parameters

TipaltiPayeeDetailsResponse (extension of type TipaltiResponse)

TipaltiPayeeDetailsResponse

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
Name Payee first and last name

 

 string
CompanyName Payee company name
  • Max. length = 70
  • Valid characters:
    • Latin and numeric (cannot be only numeric)
    • Spaces, periods, dashes (cannot be the first character)—e.g., "Company 24", "Company Inc.", "12-up"
 string
Alias An alternate name for the payee, if applicable Max. length = 250 string
Address Payee address (street1, street2, city, state, zip, country)   string
PaymentMethod Payee payment method

Valid values:

  • NoPM
  • PayPal
  • WireTransfer
  • Payoneer
  • ACH
  • Check
  • Global ACH/Local bank transfer
  • HoldMyPayments
  • Custom
  • Intercash
string
Email Payee email address string