Integrating PayDocker into your business is an important step to ensure seamless connectivity and maximum efficiency. To do so, you can invite your partners onto our platform, and even your invoice and booking payments, through a CSV file.
In this article, we will cover how to download, fill up, and upload the CSV file for all types of import templates:
- Importing users
- Demand or Supply Partner Import Template
- Property Import Template
- Object import template (Invoice-related payments)
- Token import template (For VCC-related payments)
- Upload your template
You may also choose to import your bookings as well, which we will be detailing in this article: Integrate your existing bookings
We will use importing a Property as an example. Unless otherwise stated in the article, the process will be the same for importing demand or supply partner, token, and object.
Retrieving CSV Template
1. Click Import (1), then select Property (2) in the left panel.
2. On the Property page, select CSV Imports (1), then click Download CSV template (2).
Understanding import templates
Let's break down the template to understand the information that you would need to input for all types of files:
💡 Be sure to delete all sample information from our template after downloading it.
Demand or Supply Partner Import Template
| Heading | Explanation | Requirements/Answers to use |
| Partner ID | A unique identifier that you must assign to the Partner for this upload, serving as the unique ID for tracking purposes. |
|
| Partner Name | Name of the Partner that will be onboarded. It will be officially recognized as the Partner's name on PayDocker. |
|
| Partner Email | Email address of the Partner. |
|
| Country ID | Country where the Partner is located at. |
|
| Currency ID | Currency that the Partner will be transacting in. |
|
| Category | The group of transactions to which this smart contract is applied. |
Category could either be:
|
| Branch ID | Branch ID of the specific branch engaging in the transaction with the Partner. |
|
| Model ID | Model ID of the payment model applicable to this Partner. |
|
| Payment Terms ID | Term ID of the payment terms applicable to this Partner. |
|
| Dispute Terms ID | Term ID of the dispute terms applicable to this Partner. |
|
| Tax ID | Tax ID of the dispute terms applicable to this Partner. |
|
An example of Branch / Model / Terms / Tax ID:
Property Import Template
The property's platform operates somewhat differently from yours. Each property owner has a single master account, enabling them to log in and manage each of their properties separately, as long as the property is registered on PayDocker.
Below is a breakdown of each major section, along with guidance on how to complete the template effectively:
Structure
As noted earlier, each property owner has one master account, which allows them to log in and manage their properties individually. Hence, it's crucial to inform us which account serves as the master and which represents the individual properties.
| Heading | Explanation | Requirements/Answers to use |
| Master | Indicates whether this account serves as the Master Account overseeing all properties. |
Main Account: Yes Properties under this Main Account: No |
| Master ID | Identifies the Master Account to which the property belongs. |
Main Account: NA Properties under this Main Account: |
Master Account
Then, we will need the Master account details. You can import multiple partners in a single upload, as long as the number of rows is within 1000 or the file size is less than 3MB, enabling several master accounts to be imported simultaneously. Remember that the account ID you assign will function as their invitation redemption code.
| Heading | Explanation | Requirements/Answers to use |
| Account ID | A unique identifier that you must assign to the Main Account for this upload, serving as both the unique ID for tracking purposes and the Redemption Code. |
Main Account: PropD / Prop123 / NameofHotel001 etc. If rejected, please try another ID. Properties under this Main Account: NA |
| Account Name | Specifies the Master Account to which the property is associated. |
Main Account: PD Property Test Team D Properties under this Main Account: NA |
| Account Email | Email address of the Master Account. Redemption email will be sent to this account. |
Main Account: PDPropD@paydocker.com Properties under this Main Account: NA |
Individual Properties
Now that the master account details are set, you can add the details of each property for registration on PayDocker.
| Heading | Explanation | Requirements/Answers to use |
| Property ID | A unique identifier that you must assign to the properties for this upload, serving as the unique ID for tracking purposes. |
Main Account: NA Properties under this Main Account: PDPropD1 / NameofHotel001 etc. |
| Property Name | Name of the Property that will be onboarded. It will be officially recognized as the property’s name on PayDocker. |
Main Account: NA Properties under this Main Account: PD Test Property D1 |
| Property Email | Email address of the property. Property email must differ from the Main Account's and should not be repeated among different properties. |
Main Account: NA Properties under this Main Account: PropD1@paydocker.com / PropD2@paydocker.com |
| Country ID | Country where the property is located at. |
Main Account: NA Properties under this Main Account: ISO 2 digit country codes e.g. AU |
| Currency ID | Currency that the property will be transacting in. |
Main Account: NA Properties under this Main Account: ISO 3 digit currency code e.g. AUD |
Smart Contract Details
To streamline the onboarding process for your property partners, Smart Contracts can be established with each property at this stage. This section encompasses the preparations made in step 1. Simply make a note of the IDs of each function and input them into the template.
| Heading | Explanation | Requirements/Answers to use | ID Location |
| Category | The group of transactions to which this smart contract is applied. |
Main Account: Property: Booking |
- |
| Branch ID | Branch ID of the specific branch engaging in the transaction with the property. |
Main Account: NA Property: BRx.x Input 1 ID for each property. |
Settings → Branches → Branch ID |
| Model ID | Model ID of the payment model applicable to this property. |
Main Account: NA Property: MDx.x Input 1 ID for each property. |
Settings → Models → Model ID |
| Payment Terms ID | Term ID of the payment terms applicable to this property. |
Main Account: NA Property: TMx.x Input 1 ID for each property. |
Settings → Terms → Term ID |
| Dispute Terms ID | Term ID of the dispute terms applicable to this property. |
Main Account: NA Property: TMx.x Input 1 ID for each property. |
Setting → Terms → Term ID |
| Tax IDs | Tax ID of the dispute terms applicable to this property. |
Main Account: NA Property: TXx.x Optional, input up to 5 IDs for each property. Otherwise, leave blank. |
Settings → Taxes → Tax ID |
Object Import Template
Please use this template for your invoice payments
| Heading | Conditions |
| Buyer ID |
ID of the buyer, max 150 characters
|
| Buyer Name | Buyer's name, max 150 characters |
| Currency | 3 letter currency code |
| Object Value |
|
| Due Date |
|
|
Invoice reference Internal reference |
Only up to 75 characters |
|
Send Now |
Only "Yes" or "No" can be accepted |
Token Import Template
To ensure that this function is available to you, please ensure that your token generation automation has either been switched off, or you have enabled manual token generation on the configuration.
Here is an example of the upload template for token imports.
| Heading | Conditions |
| Seller ID |
Max 150 characters (For example, Seller001) |
| Booking Reference | Max 80 characters |
| Customer Name | Max 80 characters |
| Rooms |
Max quantity of rooms booked 999 rooms |
| Check-in / Check-out |
|
|
Currency |
3 letter currency code |
|
Token value |
|
|
Available date |
When the token is made available, in dd/mm/yyyy format |
|
Expiry date |
|
|
Send Now |
Only "Yes" or "No" can be accepted |
Upload your Import templates
After you have prepared your templates, you can return to the same page to upload your template
1. Click CSV Imports, then Import CSV
2. Your imports will fall into 1 of these 3 categories:
- Completed - Your imports have been successfully completed
- Importing - Our system received your import file, and it is still processing
- Needs attention - There is an issue with your import file
It can be frustrating to encounter difficulties in importing CSV files, particularly when uploading multiple Partners simultaneously. That's why our PayDocker system is designed to help you quickly identify any issues with your CSV file, enabling prompt adjustments. Here's how it works.
Identifying Upload Status Alert
After completing the upload process, our system may alert you if there are any issues that require attention, indicated by the Needs Attention sign.
Issue Identification Procedure
1. To identify the issues, click into the row.
2. The dropdown will indicate the number of rows that require changes (1). Then, proceed to click Download Report (2), an error report will be downloaded in xlsx format.
3. The error report consists of two sheets.
-
Sheet 1: Highlights the errors with red borders, pinpointing their exact locations.
-
Sheet 2 provides detailed information about the errors, including descriptions and which rows and fields are affected.
Error Resolution
Now that you've identified the errors, make the necessary updates to your CSV file according to the error report. You can refer back to Understanding import templates to guide your edits.
1. Once you've saved the file in CSV format, return to the CSV imports page (1), click Import updated CSV (2)
2. In the popup window, select Browse to upload the updated file. Please make sure the edited file is saved with a different name, or the system will not be able to recognize the file as an edited upload.
3. After selecting the file and ensuring it meets all the criteria (1) outlined in the popup, click on Import CSV (2).
4. Once all the errors have been successfully edited, the Completed sign will be displayed.
Verify the details of each entry
For importing users
Once you have imported your CSV files successfully, new entries will appear under Imported with the status To Validate
It is crucial that you ensure all information and details are correct before validating. Once validated, the invite will be sent, and this action is not reversible.
To check the details, click the three dots (1) next to their row and select Details (2). The details will appear in a slide-out.
In the slide-out, hover over the info icon (1) next to the specific properties, and the smart contract details (2) will appear.
If you notice any discrepancies that you would like to correct, tick the checkbox next to the row (1) and select Delete (2) to remove them from this page. Then, re-upload a new CSV for that partner again.
To invite your partners
If you are uploading import templates to invite new users to our platform, validating your import entry will automatically send an invite to the contact email.
- For mass partner invitations, tick the checkbox on the header row (1) and click Validate (2).
- If you prefer to invite specific property partners, you can just select the checkbox next to the specific ID (1) and click Validate (2).
After successfully sending the invitation, you will notice the following changes:
- The validation checkbox (1) will disappear, and you will no longer be able to delete the property partner from this page.
- The status will change from To Validate to Unclaimed (2).
- When you click on the three dots (3) at the end of the row for the specific property partner, you will see Invited (4) displayed in the dropdown menu.
On your partners' end, they will need to redeem their accounts and verify their emails through an invitation email that has been sent to their inbox:
Following the steps on our platform, they will be required to complete the following:
- Redeem their accounts using a unique redemption code (This is the Partner ID that you filled in for them on the import template)
- Verify their emails
- Set a new password
Once they have done so, you will see the changes on your Import dashboard and receive an email regarding the invitation's acceptance/rejection.
| Status | Meaning |
| Unclaimed | Your partner has not yet redeemed their account. |
| Claimed | Your partner has successfully redeemed their accounts, and their accounts will be automatically connected to yours. |
| Rejected |
Your partner has rejected the invitation. |
For importing objects
Once you have successfully uploaded the file, the data will be reflected on the Imported page. You will have to validate the entries, which is very similar to the process for importing users.
During the validation process, our system will validate all the key information uploaded. If any information is invalid, the status will display Failed. Here are some possible reasons:
- Buyer ID is not valid (You will need to establish a partnership with the buyer first)
- Currency is not active in either the buyer or seller account
- The due date is more than 1 year before or after the file upload date
If your entries have failed, you can choose to re-upload those entries again with the details adjusted.
Successfully validated objects will then be generated and sent to your buyer.
For importing tokens
Once you have successfully uploaded the file, the data will be reflected on the Imported page. You will have to validate the entries, very similar to the process for importing objects.
During the validation process, our system will validate all the key information uploaded. If any information is invalid, the status will display Failed. Here are some possible reasons:
- Seller ID is not valid (You will need to establish a partnership with the buyer first)
- Currency is not active in either buyer or seller account
- Token available and expiry date is no longer valid
If your entries have failed, you can choose to re-upload those entries again with the details adjusted.
Successfully validated objects will then be generated and sent to your seller.