Token
Read Token
Available Date
1min
POST
Request
Body Parameters
share_public
String
required
Public keys are accessible in your PayDocker account under integration menu.
read_event
String
required
A condition to allow execution of the action that is connected to the token. The condition would be "token.available_updated".
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.
token_id
Integer
required
The unique identifier associated with the token that the user is requesting a modification for. (e.g. 2908926013012565)
available_date
String
optional
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
optional
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.
tokes_status
String
optional
active, disputed, freezed or deleted (only one is applicable). It is case-sensitive.

