URL: https://dashboard.paydocker.com/purchases-token
A Token is a temporary digital contract, identified by a unique ID, between authorized Users and PayDocker. It is meant for procuring travel accommodations and/or services and is issued by Buyers on PayDocker.
In this article, we will bring you through the process of generating, loading and sending a token. This diagram should show the steps, and what you should do after sending a Token:
Create a Token
You will be able to create tokens through 3 ways:
Manually create a token
To create a Token, head to Purchases (1) then Tokens (2)
From there you will then click + Create Token.
A form to fill in the details of your booking will appear as follows. Please fill in all the details in order to successfully create a token
To note:
- You will need to ensure that there is enough balance in your account in order for the token to be generated. This amount will take into consideration PayDocker's fees as well
- All PayDocker fees will be transparently shown on the relevant transaction for your consideration
- If you choose to send the token now, the token will be sent once it is loaded. For send later, the token will be sent on its expiry date.
Through an automation
This automation function for payments will help you reduce the manual work needed to generate and load tokens.
In order for this automation to work, there must be enough balance for the specific currency in your account. Should there be insufficient, you can convert balances from other currencies in your account.
1. Click Settings, then Automation and finally Payments
If manual token generation has been disabled, you will not be able to manually generate any tokens from your account.
Through an API
The API, if set up correctly, would be able to capture these details in the process of creating a token:
- Destination of the token
- Currency of exchange
- Load amount
- Available and expiry date
- Name, type and reference ID of the token
- Recipient email
Read more here: API & Webhooks Integration
Load Funds into the Token
Once the tokens have been generated, you will be required to load funds into the token and then send it out.
You can only load a token if:
- Token has not expired
- There are sufficient balances in your account
What happens during the loading process
During the loading process, PayDocker software will confirm the following details:
- Check if Authentication is required
- If you have set up Two-step authentication on your profile, we will request for an authentication code either through your email or an authenticator app
- Check if there is sufficient balance for that currency within the account to cover both the amount required and fees charged
- If you need to increase your balance, please refer to this article: Top-up your Balances
- You may also choose to convert balances of other currencies: Converting Balances
If the loading process is successful, you will be given a Transaction ID that would represent this unique token and token value you have just loaded on. Your balance will reflect a negative amount, coming from the loaded value.
If the loading process is unsuccessful, please refer to the error and re-submit the token loading request.
You will be able to create tokens through 3 ways:
Loading tokens manually
1. Go into the token that you wish to load and click load token
2. Then, fill up the details in this pop-up, namely the amount to be loaded. Do take note of our Fees as well for this particular transaction as well as it would impact the total value of the token (Value of the Token should also take into account the PayDocker fees.)
Once you have completed this step, click Load to start the loading process.
Schedule your loading
In the event that you would like to schedule your token load process, the load conditions found in the normal loading process applies to scheduled loading too.
1. Click Schedule
You will then see the schedule load pop-up. Click Schedule to confirm your settings.
The pre-determine schedule loads time will take place at 00:00 GMT +8:00 on the date that you have selected. Scheduled loading will go through the same loading process before the loading is confirmed
Loading tokens through an automation
To set up token loading automation, configure it here:
If you choose to configure token load schedule, loading will happen according to the due date of the token and the amount will be according to the rates of the booking. If the booking has 2 rates with different due dates, there will be 2 load schedule.
If you choose Don't configure token load schedule, loading will happen immediately.
For tokens who fail to generate, they will be left in drafts. We would suggest to check those tokens and enable manual token generations as mentioned in the previous section.
Loading tokens through an API
During the initial API push, the load amount information would have been captured. There is a maximum load amount of max 12 value and the first value cannot be 0.
Errors occurring at this stage will be labelled as "415 Invalid Load Amount"
Tokens will be loaded immediately once it can be successfully generated.
Modifying your tokens
You can modify your tokens (Unload, edit and freeze, delete tokens) either
Manually modifying your tokens
Unloading Funds from your Token
To unload funds, follow these steps:
1. Go into the token that you wish to unload and click unload token
This will take you into a pop-up where you can choose the amount to unload
You can only unload a token if:
- Token has not expired
- Your unload amount is less than or equal to the token balance
What happens during the unloading process
During the loading process, the system will confirm the following details:
- Check if Authentication is required
- If you have set up Two-step authentication on your profile, we will request for an authentication code either through your email or an authenticator app
If the unloading process is successful, you will be given a Transaction ID that would represent this unique token and token value after you have unloaded. Your balance will reflect a positive amount, coming from the unloaded value.
If the unloading process is unsuccessful, please refer to the error and re-submit the token loading request.
Edit and freeze tokens
After generating tokens, you can still have the choice to edit the name, available and expiry dates of the token.
1. Click edit token
Then, fill up the pop-up with the amended details and click save
You can also choose to freeze the token by clicking freeze
You can also unfreeze this token at a later date if required.
Deleting tokens
The process of deleting tokens that have already been generated and loaded would go as follow:
- You will be required to authorise this transaction, if you have two-factor authentication set up
- Your token would need to have 0 value before deleting
- To unload the value, refer to this section: Unloading Funds from your Token
To delete, you can find the button within the token view
Once you have successfully frozen or deleted your tokens, the status will change respectively.
Modifying your tokens through the API
When modifying your token through the API, the process is very similar to creating a token through an API with 1 extra step: The API will verify if the token is "Active".
Send Tokens
During the generation of your tokens, you will be able to configure the token to be send now or send later.
If you would like to send your tokens immediately, you should click send now. However, if you would like to generate and load your token first then send it later, click send later.
- To send your tokens later, you will need to return to the token view and click Send token
Once the tokens have been successfully sent, an email will be delivered to the receiving party automatically.
If you have created your token through the API, then token will be sent immediately once it can be successfully generated.
Export data of all your tokens
In the situation where you need to export data of all the tokens you have sent, you can do so through the dashboard. You can either choose to do this manually, or configure an automation to extract data to be sent into your email.
How to use the export function
Click on Export, located at the top of the page.
Next, select the token-related information you need to extract. Information will be exported into an excel file.
How to configure the automation
1. Click Settings (1), then Automation (2) and finally Data Export (3)