TipaltiPayeeSOAPV6
Obtain or update payee info.
The following operations are supported. For a formal definition, please review the Service Description.
-
CancelInvoice
Cancel Invoice -
ClosePayeeAccount
Close Payee account.
EAT - null -
CreatePayeeInfoAutoIdap
Creates payee with basic info, and auto generated idap.
State can either be null, or a valid 2 letter US state.
If skipNulls=true this service will ignore parameters with null value.
Country is a 2 letter ISO 3166 code.
EAT - street1 -
GetExtendedPODetails
Returns details of a given payment order. Searches for the payment order by refCode.
Response contains these properties: RefCode, SubmittionDate, AmountSubmitted, AmountSubmittedCurrency, PaymentMethod, Status, PayerFees, PayeeFees, SubmittedCurrencyToPayeeCurrencyFxRate,
PayerFxFees, WithdrawCurrency, WithdrawAmount, ValueDate, Message, BankingMessage, EmailSubject, TxnReference, PaymentAmount, PaymentCurrency, ErrorMessages, ScheduledDate.
If a specific property is not availble, it will not appear in the result.
Additional properties may be added in future releases.
EAT - poRefCode -
GetExtendedPODetailsList
Returns details of a given payment orders. Searches for the payment orders by refCodes.
Response contains these properties: RefCode, SubmittionDate, AmountSubmitted, AmountSubmittedCurrency, PaymentMethod, Status, PayerFees, PayeeFees, SubmittedCurrencyToPayeeCurrencyFxRate,
PayerFxFees, WithdrawCurrency, WithdrawAmount, ValueDate, Message, BankingMessage, EmailSubject, TxnReference, PaymentAmount, PaymentCurrency, ErrorMessages, ScheduledDate.
If a specific property is not availble, it will not appear in the result.
Additional properties may be added in future releases.
EAT - null -
GetExtendedPayeeDetails
Returns details of a given payee.
Response contains this properties: Alias, CompanyName, Email, FirstName, MiddleName, LastName, PaymentMethod, Street1, Street2, City, State, Zip, Country, Phone, PaymentCurrency, Payable.
If a specific property is not available than it will not appear in the result.
Additional properties may be added in future releases.
EAT - not required -
GetExtendedPayeeDetailsList
Returns details of given payees.
Response contains this properties: Alias, CompanyName, Email, FirstName, MiddleName, LastName, PaymentMethod, Street1, Street2, City, State, Zip, Country, Phone, PaymentCurrency, Payable.
If a specific property is not available than it will not appear in the result.
Additional properties may be added in future releases.
EAT - null -
GetInvoicesPayableAmount
Returns the payable amount for all payees. The payable amount is the sum of all approved invoices which were not paid yet.
Passing null as the idap parameter will return total sum amount of payable invoices for the payer.
Passing the id of the payee will return the payable sum amount of the invoices for that payee.
Amount will be returned at the double value parameter 'd' in TipaltiResponse structure.
EAT - not required. -
GetLastPaymentDetailsByIdap
Returns details of a given payment order. Searches for the latest payment order by idap.
Response contains these properties: RefCode, LastSubmissionDate, Status, Alerts, ValueDate, PaymentAmountInWithdrawCurrency.
Additional properties may be added in future releases.
EAT - null -
GetPODetails
Returns details of a given payment order. Searches for the payment order by refCode.
The refCode is the identifier which was provided by the payer upon payment order creation
EAT - poRefCode -
GetPayeeDetails
Returns details of a given payee.
EAT - null -
GetPayeeInvoiceList
Returns an invoice list for a given payee. You may choose to include paid invoices or not.
EAT - not required. -
GetPayeeInvoicesChangedSinceTimestamp
Returns all invoices reference codes that were updated since the given date.
EAT - The timestamp to check from, in UTC -
GetPayeePendingInvoiceTotal
Returns invoice details for the payee.
Result contains 3 values:
ApprovedUnpaidTotal - The total amount of the invoices to this payee which the payee approved but need to be paid.
UnapprovedTotal - the total value of invoices that were released but the payee did not approve yet.
UnreleasedTotal - the total value of invoices that were created but not released. No EAT -
GetPayeesChangedSinceTimestamp
Returns the ids of all payees whose last change date is after a given date.
EAT - The timestamp to check from, in UTC -
PayeePayable
If a payment request had issues, the payee might not get paid.
Possible reasons for not paying are - missing tax documents, payment below threshold, account locked, address missing, or other.
Returns true if payable. If returned false, s will contain the reason for not being payable.
EAT - amount -
PayeePaymentMethod
Returns the name of the selected payment method, or NULL if the call resulted in an error.
EAT - not required. -
PayeeStatusUpdate
Update the status of payee.
Valid values for status are : Active, Suspended, Blocked
When blocking a payee, a blocking reason may be suppliedEAT - null -
PayeeUpdateAddress
Updates payee address. This address must match the one in the payee bank records.
State can either be null, or a valid 2 letter US state. Country is a 2 letter ISO 3166 code.
If skipNulls=true this service will ignore parameters with null value. If skipNulls=false the null values will overwrite existing values.
EAT - street1 -
PayeeUpdateEmail
Updates payee email address for communication (not PayPal email).
EAT - email -
PaymentsBetweenDates
Returns the amounts submitted, pending and rejected for the time period.
EAT - from -
UpdateOrCreatePayeeInfo
Updates payee's basic info. If the payee does not exist, it will be created. The details must match the ones in the payee bank records.
State can either be null, or a valid 2 letter US state.
If skipNulls=true this service will ignore parameters with null value. If skipNulls=false the null values will overwrite existing values.
Country is a 2 letter ISO 3166 code.
EAT - street1 -
UpdatePayeeCustomFields
Update payee custom fields.
EAT - null