Token
Post Token
Modify Token
1min
PATCH
Request
Body Parameters
share_secret
required
String
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
required
String
Used to identify the action connected to the token and the allowed action for this request would be "modify".
source_id
required
String
Your PayDocker Account ID assigned upon account creation (e.g. PDR1). It is case sensitive.
destination_id
required
String
Property ID (e.g. ID 001) generated in your platform. It represents the token recipient.
token_id
required
String
The unique identifier associated with the token that the user is requesting a modification for. (e.g. 2908926013012565)
token_status
required
String
active or freezed (only one is applicable). It is case-sensitive.
available_date
required
String
The date on which the token becomes active and ready for the recipient to collect.
The format is YYYY-MM-DD, e.g. 2023-12-25.
Selectable date range is 1 day before token creation day to up to 365 days in the future.
expiry_date
required
String
The date on which the token becomes invalid, after which it cannot be used or collected by the recipient.
The format is YYYY-MM-DD, e.g. 2023-12-25.
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
required
String
The format is YYYY-MM-DD, e.g. 2023-12-21
Selectable date range up to 2 years before token creation day to up to 2 years in the future.
check_out
required
String
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
required
Number
Accepted value from 1 to 999
customer_name
required
String
Used to identify the customer name associated within the booking .
Maximum 80 characters allowed.
booking_reference
required
String
Used to identify the Booking ID.
Maximum 200 characters allowed.
email_token
required
Boolean
true or false (only one option is applicable). It is case-sensitive.
email_settings
optional
Object
