Tipalti Help Center home page
  • Get started
    • Onboarding tools
    • Video tutorials
    • Live training
  • User guides
    • Tipalti Hub Home
      • Log in to the Tipalti Hub
      • Manage finances from Home
    • Tipalti AI Assistant
      • Ask the assistant
      • Common prompts
    • Administration
      • Administrative operations
      • Admin settings
      • Custom fields
      • Team management
      • User roles
      • User permissions
      • Email domain setup
      • Email notifications
      • Manage communications
      • Edit and customize templates
    • Multiple entities
      • Multiple entities
      • Switch entities with multi-instance setup
    • Funding
      • Funds overview
      • Manage virtual accounts
      • Fund Tipalti accounts
      • Transfer funds between accounts
      • Multi-FX
    • Payees
      • Search payee information
      • Manage payee status and settings
      • iFrame/ Supplier Hub
      • Manage Supplier Hub payees
      • Manage actions as a payee
      • Add and review payee documents
      • Verification of payee
    • Taxation
      • US tax forms
      • Tax form expiration
      • Tax withholding
      • Certificate of No US Activities
      • Additional documents
      • Non-US tax collection
      • Tax form statuses
    • Procurement
      • New Procurement
      • Original Procurement
    • PO matching
      • New PO matching
      • Original PO matching
    • Bills
    • Tipalti Expenses
      • Get started
      • Create and submit expenses
      • Manage and approve expenses
      • Build expense approval workflows
      • Reimburse expenses
      • Connect your corporate cards
    • Tipalti Cards
      • Tipalti Cards
      • Fund your card
      • Manage cards
      • Monitor card transactions
      • Process transactions
      • ERP sync
      • Credit card statement report
    • Payments
      • Submit payments
      • Manage payments
      • Schedule payments
      • Understanding payment statuses
      • Payment methods coverage: US and ROW
      • Payment methods coverage: UK and EU
      • Payment methods coverage: Canada
      • Payment error codes
      • Managing unsuccessful payments
    • Reports
      • AI-powered reports
      • Payment reports
      • Bill reports
      • Payee reports
      • Tax reports
      • User reports
    • Security practices
      • Email security
      • Business continuity practices
      • Two-factor authentication
      • Detect
  • Integrations
    • 3rd Party Apps
      • Partner Platforms
      • SSO
    • ERPs
      • Sage Intacct
      • NetSuite 2.0
      • Microsoft Business Central
      • QuickBooks
      • Xero
      • Tipalti Connect
      • Acumatica
      • SAP B1
    • File Integration
      • Configure auto-sync settings
      • Import files
      • Export files
  • FAQs
    • General FAQs
    • User guide FAQs
      • Payee FAQs
      • Bill FAQs
      • Card FAQs
      • PO Matching FAQs
      • Payment FAQs
      • Detect FAQs
      • Taxation FAQs
      • Administration FAQs
      • Expenses FAQs
    • ERP FAQs
  • Release notes
  • Dev docs
Sign in
  • Get started  
    • Onboarding tools  
    • Video tutorials  
    • Live training  
  • User guide  
    • Log in to the Tipalti Hub
    • Administration  
      • Administrative operations
      • User roles
    • Multiple entities
    • Funding  
      • View funds required
      • Fund Tipalti accounts
      • Multi-FX  
        • Currency cutoffs and validations
    • Payees  
      • Search payee information
      • Manage payee status and settings
      • iFrame/ Supplier Hub
      • Manage Supplier Hub payees
      • Documents review
    • Taxation  
      • US tax forms
      • Tax form expiration
      • Tax withholding  
        • Withholding rates
        • Income types
        • Tax form and entity types
      • Certificate of No US Activities
      • Additional documents
      • Non-US tax collection
      • Tax form statuses
    • Procurement  
      • System overview
      • Create and track purchase requests
      • Approve purchase requests
      • Mark goods and services as received
      • Vendor registration
      • Send PO PDF
      • Back office  
        • Set reminders
        • Run parallel PR/ vendor approval
        • Emails
        • PO PDF customization
        • Upload budget
        • Customize Procurement forms
        • Contract repository
      • Workflow integrations
    • PO Matching  
      • Matching process
      • Handle matching exceptions
      • Bill routing
      • Matching policies
      • Bill coding
      • Bill approval for PO-backed bills  
        • Approvable bills
        • Non-approvable bills
        • PO updates
      • Prepayments (NetSuite 2.0)
      • Track and match a dropship invoice  
        • Set payees up as dropship vendors
        • Upload and match a dropship invoice
    • Bills  
      • Bill flows
      • Usability
      • Add invoices
      • Manage bills
      • Add comments and files to bills
      • Bill approvers
      • Invoice processing approvals
      • Email Security
      • Tax collection in Bills
      • Bill statuses
    • Tipalti Expenses  
      • Get started
      • Create and submit expenses
      • Manage and approve expenses
      • Reimburse expenses
      • Connect your corporate cards
    • Tipalti Cards  
      • Funds flow
      • Manage cards
      • Card transactions overview
      • Process transactions
      • ERP sync
      • Credit card statement report
    • Submitting payments
    • Payment information  
      • Payment statuses defined
      • Payment methods coverage: US and ROW
      • Payment methods coverage: UK and EU
      • Payment methods coverage: Canada
      • Payment error codes
    • Reports  
      • Smart report builder
      • Payment reports
      • Bill reports
      • Payee reports
      • Tax reports
      • User reports
    • Security practices  
      • Email security
      • Business continuity practices
      • Two-factor authentication
    • Detect
  • Integrations  
    • 3rd Party Apps  
      • Partner Platforms
      • SSO
    • ERPs  
      • Sage Intacct
      • NetSuite 2.0
      • Microsoft Business Central
      • QuickBooks
      • Xero
      • Tipalti Connect
      • Acumatica
      • SAP B1
    • File Integration  
      • Configure auto-sync settings
      • Import files
      • Export files
  • FAQs  
    • General FAQs
    • User guide FAQs  
      • Bill FAQs
      • Card FAQs
      • PO Matching FAQs
      • Payment FAQs
      • Detect FAQs
      • Taxation FAQs
      • Administration FAQs
      • Expenses FAQs
    • ERP FAQs
  • Release notes
  • Dev docs
  1. Tipalti
  2. FAQs
  3. Support FAQs
  4. Developer Kit
  5. Customize and Integrate iFrame
Follow

Articles in this section

  • Developer Documentation
  • Authentication: Using Encryption Key
  • Payee Onboarding via iFrame
  • Test Payee Onboarding in Sandbox
  • Payee Onboarding via API
  • Test Payment Processing in Sandbox
  • Test Bills Upload in Sandbox

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

 

Was this article helpful?

We’d love the opportunity to improve. Submit your feedback.

We’re glad you enjoyed the article!

Have more questions? Submit a request
Return to top
Privacy Policy | Terms of Use | Payer/Sender Rights | Customer Assistance Policy
LinkedIn Instagram Facebook Twitter YouTube
Contact support