Payee Onboarding via API

UpdateOrCreatePayeeInfo API

The UpdateOrCreatePayeeInfo function allows the creation or updating of a particular payee

1. This API call requires you to enter a payee ID (idap) to query.
2. EAT parameter: Street1
3. SkipNulls
   1. • If passing null values in the request and are to be ignored, skipNulls = 1 (TRUE)
      • If skipNulls = 0, the request will use the values in the parameters and replace existing values
4. If the address is changed via this API call, the payment method in the iFrame/Portal is invalidated. The payee is notified and when they next log into the iFrame/Portal, the details on the "Payment Method" page must be completed again.

For additional information please refer to our documentation.

Authorization string

let encoded = payer+idap+now;
//let encoded = payer+idap+now+street1;
//If EAT Parameter is passed

Example Request Code 

curl --location --request POST 'https://api.sandbox.tipalti.com/v9/PayeeFunctions.asmx' \
--header 'Content-Type: text/xml; charset=utf-8' \
--data-raw '<x:Envelope
xmlns:x="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tip="http://Tipalti.org/">
<x:Header/>
<x:Body>
<tip:UpdateOrCreatePayeeInfo>
<tip:payerName></tip:payerName>
<tip:idap></tip:idap>
<tip:timestamp></tip:timestamp>
<tip:key></tip:key>
<tip:skipNulls>1</tip:skipNulls>
<!-- If passing null values in the request and are to be ignored, skipNulls = 1 (TRUE) -->
<!-- If skipNulls = 0, the request will use the values in the parameters and replace existing values -->
<tip:overridePayableCountry>false</tip:overridePayableCountry>
<tip:item>
<tip:Idap></tip:Idap>
<tip:FirstName></tip:FirstName>
<tip:LastName></tip:LastName>
<tip:Street1></tip:Street1>
<!-- if Street 1 has a value, include it as an EAT parameter -->
<!-- The authentication key should look like let encoded = payer+idap+now+street1; -->
<!-- Optional -->
<tip:Street2></tip:Street2>
<tip:City></tip:City>
<tip:State></tip:State>
<tip:Zip></tip:Zip>
<!-- <tip:Country></tip:Country> -->
<!-- If updating a payee, and Country = null, remove from request regardless of skipNulls -->
<!-- If skipNulls =0, country is required when creating a payee-->
<tip:Email></tip:Email>
<tip:Alias></tip:Alias>
<tip:Company></tip:Company>
<tip:PreferredPayerEntity></tip:PreferredPayerEntity>
<!-- <tip:MiddleName></tip:MiddleName> -->
<!-- Not applicable for this workflow -->
<!-- <tip:ApAccountNumber></tip:ApAccountNumber> -->
<!-- <tip:PayerEntityName></tip:PayerEntityName> -->
<tip:PaymentTermId></tip:PaymentTermId>
<tip:CountryName></tip:CountryName>

<!--Not applicable for this workflow, If using Quickbooks only -->
<!-- <tip:ErpCurrency></tip:ErpCurrency> -->

<tip:PayeeEntityType>Individual</tip:PayeeEntityType>
<!-- If not using PayeeEntityType, do not include in request -->

<!-- Not applicable for this workflow -->
<!-- <tip:ApAccountExternalId></tip:ApAccountExternalId> -->

<!-- If payee needs different language -->
<!-- <tip:Language></tip:Language> -->

<!-- The payee ID in the ERP (e.g., in NetSuite it is the vendor ID) -->
<!-- <tip:ExternalId></tip:ExternalId> -->

<!-- Indicates whether to send the payee an invite to register in the Supplier Hub (only sent if the payee has never received an invitation) -->
<!-- <tip:SendSupplierPortalInvite></tip:SendSupplierPortalInvite> -->
</tip:item>
</tip:UpdateOrCreatePayeeInfo>
</x:Body>
</x:Envelope>'

Python SDK 

https://github.com/pratikkhatwani-tipalti/Tipalti-python-sdk