Token
Post Token
Create Token
1min
POST
Request
Body Parameters
share_secret
String
required
Test mode secret keys and live mode secret keys are available in your PayDocker account under Integration menu.
Don't share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
token_event
String
required
Used to identify the action connected to the token and the allowed action for this request would be "create".
source_id
String
required
Your PayDocker Account ID assigned upon account creation (e.g. PDR1). It is case sensitive.
destination_id
String
required
Property ID (e.g. ID 001) generated in your platform. It represents the token recipient.
destination_currency
String
required
Currency ID ISO 4217 standard format associated within the token value.
Supported currency and ISO code are available in API Reference --> Standard Codes --> Currency Code
founding_balance
String
required
Partner balance ID uniquely associated with the currency of the token and where the token amount will be unloaded from (e.g. PD74INR1385809982156467).
load_amount
String
required
The sum added by the partner to the token, which the recipient can then collect.
The amount value supports up to twelve digits (e.g. a value of 9,999,999,999.99) divided by decimal.
available_date
String
required
The date on which the token becomes active and ready for the recipient to collect.
The format is DD-MM-YYYY, e.g. 25-12-2023
Selectable date range is 1 day before token creation day to up to 365 days in the future.
expiry_date
String
required
The date on which the token becomes invalid, after which it cannot be used or collected by the recipient.
The format is DD-MM-YYYY, e.g. 25-12-2023
Selectable date range is same or greater than available date, essentially until the last day of the month one year after the chosen available date.
E.g. Available Date - 18 Oct 2023, Expiry Date - 31 Oct 2024.
check_in
String
required
The format is DD-MM-YYYY, e.g. 25-12-2023
Selectable date range up to 2 years before token creation day to up to 2 years in the future.
check_out
String
required
The format is YYYY-MM-DD, e.g. 2023-12-21
Selectable date range is same or greater than check-in date, up to 90 days in the future.
room_count
Number
required
Accepted value from 1 to 999
blockchain_processing
Boolean
required
true or false (only one option is applicable). It is case-sensitive.
customer_name
String
required
Used to identify the customer name associated within the booking .
Maximum 80 characters allowed.
booking_reference
String
required
Used to identify the Booking ID.
Maximum 200 characters allowed.
email_token
Boolean
required
true or false (only one option is applicable). It is case-sensitive.
email_settings
Object
required


