Unload 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 "unload".
source_id
required
String
Your PayDocker Account ID assigned upon account creation (e.g. PDR1). It is case sensitive.
unload_amount
required
String
The sum subtracted by the partner from the token, subjected to the maximum balance amount in the token. 

The amount value supports up to twelwe digits (e.g. a value of 9,999,999,999.99) divided by decimal.
token_id
required
String
The unique identifier associated with the token that the user is requesting unloading for. (e.g. 2908926013012565)
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
﻿
﻿
Updated 20 Jan 2024
Did this page help you?
Load Token
Schedule Load Token