Function: PayeeStatusUpdate

The PayeeStatusUpdate function allows you to update the payee status where the valid values for payee status are as follows.

  • Active
  • Suspended
  • Blocked

If you block/ suspend a payee, a reason must be provided.

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

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

<payerName>string</payerName>

<idap>string</idap>

<timestamp>double</timestamp>

<key>string</key>

<status>string</status>

<reason>string</reason>

</PayeeStatusUpdate>

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

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

<PayeeStatusUpdateResult>

<errorMessage>string</errorMessage>

<errorCode>string</errorCode>

<b>boolean</b>

<i>int</i>

<d>double</d>

<s>string</s>

</PayeeStatusUpdateResult>

</PayeeStatusUpdateResponse>

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

Current time (UTC) when the request is sent

 Unix time Mandatory double
key Encryption key   Mandatory string
status The status of the payee

Valid values:

  • Active
  • Suspended
  • Blocked
 Mandatory string
reason The reason the payee status is "Blocked" or "Suspended" Max. length = 250 Mandatory string

Response parameters

element

description

data type
PayeeStatusUpdateResult 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

If the errorCode returned is "ParameterError", then the errorMessage is one of the following:

  • Status parameter is empty.
  • Status parameter is invalid. Only "Active", "Suspended" and "Blocked" statuses are supported.
  • Update has failed due to a missing blocked or suspended reason.
  • Update has failed. Please submit a ticket to our Support Team.