Schedule Load 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 "schedule".
source_id
String
required
Your PayDocker Account ID assigned upon account creation (e.g. PDR1). It is case sensitive.
token_id
String
required
The unique identifier associated with the token that the user is requesting a modification for. (e.g. 2908926013012565)
schedule_date
String
required
The date on which the predetermined amount will appear on the token.

The format is DD-MM-YYYY, e.g. 25-12-2023

Selectable date range is from the day after the token creation day, to the day before the expiry date.

E.g. Token creation day - 18 Oct 2023, Token Expiry Date - 29 Nov 2023. Therefore, schedule date can be set between 19 Oct 2023 to 28 Nov 2023.
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 twelwe digits (e.g. a value of 9,999,999,999.99) divided by decimal.
check_in
String
required
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
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
String
required
Accepted value from 1 to 999
﻿
﻿
Updated 09 Dec 2024
Did this page help you?
Unload Token
Delete Token