Function: CreatePayeeStatusFile

The CreatePayeeStatusFile function creates a CSV file with the status of all payees in the system. Use the changesSinceDate parameter to limit the report to only payees who changed their information after a specified date.

The CSV file is placed in the payer's SFTP Secure File Transfer Protocol (SFTP) is a secure version of File Transfer Protocol (FTP), which facilitates data access and data transfer over a Secure Shell (SSH) data stream. folder and has the following format: payee ID, payment method, payability status, payability status reason. If a file with the same file name already exists in the folder, it will be replaced.

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>

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

<payerName>string</payerName>

<timestamp>double</timestamp>

<key>string</key>

<saveToFile>string</saveToFile>

<changesSinceDate>double</changesSinceDate>

</CreatePayeeStatusFile>

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

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

<CreatePayeeStatusFileResult>

<errorMessage>string</errorMessage>

<errorCode>string</errorCode>

<b>boolean</b>

<i>integer</i>

<d>double</d>

<s>string</s>

</CreatePayeeStatusFileResult>

</CreatePayeeStatusFileResponse>

</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
saveToFile Indicates in which FTP folder to save the CSV file
  • Max. length = 260
  • Must contain only characters valid for file names
 Mandatory string
changesSinceDate
  • Used to limit the report to only payees who changed their information after a specified date
  • If null, information is fetched for all payees
 Unix time Optional double

Response parameters

element

description

data type
CreatePayeeStatusFileResult Contains the response parameters TipaltiResponse

TipaltiResponse

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