Function: GetLastPaymentDetailsByIDAP
The GetLastPaymentDetailsByIDAP function returns details for the last payment order A single payment instruction for a payee of a specific payee. The system searches for the payment order by payee IDAP.
- EAT Encryption Additional Terms parameter:None
- Current API version: V3
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>
<GetLastPaymentDetailsByIdap xmlns="http://Tipalti.org/">
<payerName>string</payerName>
<timestamp>double</timestamp>
<key>string</key>
<idap>string</idap>
</GetLastPaymentDetailsByIDAP>
</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>
<GetLastPaymentDetailsByIDAPResponse xmlns="http://Tipalti.org/">
<GetLastPaymentDetailsByIDAPResult>
<errorMessage>string</errorMessage>
<errorCode>string</errorCode>
<LastSubmissionDate>dateTime</LastSubmissionDate>
<PaymentStatus>string</PaymentStatus>
<Alerts>string</Alerts>
<ValueDate>dateTime</ValueDate>
<AmountSubmitted>string</AmountSubmitted>
<AmountSubmittedCurrency>string</AmountSubmittedCurrency>
<PaymentAmountInWithdrawCurrency>string</PaymentAmountInWithdrawCurrency>
<WithdrawCurrency>string</WithdrawCurrency>
<PaymentAmount>string</PaymentAmount>
<PaymentCurrency>string</PaymentCurrency>
<RefCode>string</RefCode>
</GetLastPaymentDetailsByIDAPResult>
</GetLastPaymentDetailsByIDAPResponse>
</soap12:Body>
</soap12:Envelope>
Request parameters
|
element |
description |
limitation |
Mandatory? |
data type |
|---|---|---|---|---|
| payerName | The name of the payer, as assigned by Tipalti |
|
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) |
|
Mandatory | string |
Response parameters
|
element |
description |
data type |
|---|---|---|
| GetLastPaymentDetailsByIDAPResult | Contains the response parameters | TipaltiPayeeLastPaymentResponse (extension of type TipaltiResponse) |
TipaltiPayeeLastPaymentResponse
|
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 |
| LastSubmissionDate | The date and time the payment was submitted to Tipalti | MMM DD, YYYY hh:mm:ss.sss | dateTime |
| PaymentStatus | The status of payment order | See Statuses. | string |
| Alerts | Indicates the reason why a payment has been deferred | string | |
| ValueDate | Estimated date and time the payee will receive the funds | MMM DD, YYYY hh:mm:ss.sss | dateTime |
| AmountSubmitted | The amount submitted for payment | string | |
| AmountSubmittedCurrency | The currency of the amount submitted | Length = 3 (per ISO 4217) | string |
| PaymentAmountInWithdrawCurrency | The amount paid to the payee in the payer account currency - includes payee foreign exchange fees | string | |
| WithdrawCurrency | The currency of the payer account used for the payment | Length = 3 (per ISO 4217) | string |
| PaymentAmount | The amount paid to the payee (in the payment currency) | string | |
| PaymentCurrency | The payment currency selected by the payee | Length = 3 (per ISO 4217) | string |
| RefCode | The reference code for the payment order |
|
string |