Schedule Load Token

1 min

Schedule Load

POST

https://secure.paydocker.com/{version}/token/{partnerid}/{randomkey}/schedule

Body Parameters

share_secretstringrequired
Description
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_eventstringrequired
Description
Used to identify the action connected to the token and the allowed action for this request would be "schedule".
source_idstringrequired
Description
Your PayDocker Account ID assigned upon account creation (e.g. PDR1). It is case sensitive.
token_idstringrequired
Description
The unique identifier associated with the token that the user is requesting a modification for. (e.g. 2908926013012565)
schedule_datestringrequired
Description
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_amountstringrequired
Description
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_instringrequired
Description
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_outstringrequired
Description
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_countstringrequired
Description
Accepted value from 1 to 999

json

{
    "share_secret":"string",
    "token_event": "schedule",
    "source_id": "string",
    "token_id": "string",
    "schedule_date": "string",
    "load_amount": "string",
    "check_in": "string",
    "check_out": "string",
    "room_count": "number"
}

curl

curl --location -g --request POST 'https://secure.paydocker.com/{version}/token/{partnerid}/{randomkey}/schedule' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{"share_secret":"string","token_event":"string","source_id":"string","token_id":"string","schedule_date":"string","load_amount":"string"}'

nodejs

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://secure.paydocker.com/{version}/token/{partnerid}/{randomkey}/schedule',
   'headers': {
      'Accept': 'application/json',
      'Content-Type': 'application/json'
   },
   body: JSON.stringify({
      "share_secret": "string",
      "token_event": "string",
      "source_id": "string",
      "token_id": "string",
      "schedule_date": "string",
      "load_amount": "string"
   })

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
   "share_secret": "string",
   "token_event": "string",
   "source_id": "string",
   "token_id": "string",
   "schedule_date": "string",
   "load_amount": "string"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://secure.paydocker.com/{version}/token/{partnerid}/{randomkey}/schedule", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests
import json

url = "https://secure.paydocker.com/{version}/token/{partnerid}/{randomkey}/schedule"

payload = json.dumps({
   "share_secret": "string",
   "token_event": "string",
   "source_id": "string",
   "token_id": "string",
   "schedule_date": "string",
   "load_amount": "string"
})
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://secure.paydocker.com/{version}/token/{partnerid}/{randomkey}/schedule")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
   "share_secret": "string",
   "token_event": "string",
   "source_id": "string",
   "token_id": "string",
   "schedule_date": "string",
   "load_amount": "string"
})

response = https.request(request)
puts response.read_body

200

{
   "success": true,
   "message": "Load Schedule Success",
   "token_id": "34322345677898765",
   "transaction_id": "34322345677898765"
}

405

{
  "success": "false",
  "errors": {
    "code": "405",
    "message": "Method Not Allowed"
  }
}

428

{
  "success": "false",
  "errors": {
    "code": "428",
    "message": "Token ID doesn't match"
  }
}

429

{
  "success": "false",
  "errors": {
    "code": "429",
    "message": "Token ID already deleted"
  }
}

403

{
  "success": "false",
  "errors": {
    "code": "403",
    "message": "IP Not Allowed"
  }
}

406

{
  "success": "false",
  "errors": {
    "code": "406",
    "message": "Enpoint Bad Format"
  }
}

408

{
  "success": "false",
  "errors": {
    "code": "408",
    "message": "Endpoint Suspended"
  }
}

409

{
  "success": "false",
  "errors": {
    "code": "409",
    "message": "Event Not Allowed"
  }
}

410

{
  "success": "false",
  "errors": {
    "code": "410",
    "message": "Invalid Secret Key"
  }
}

415

{
  "success": "false",
  "errors": {
    "code": "415",
    "message": "Invalid Load Amount"
  }
}

500

{
  "success": "false",
  "errors": {
    "code": "500",
    "message": "Internal Server Error"
  }
}

502

{
  "success": "false",
  "errors": {
    "code": "502",
    "message": "Bad Gateway"
  }
}

503

{
  "success": "false",
  "errors": {
    "code": "503",
    "message": "Service Unavailable"
  }
}

504

{
  "success": "false",
  "errors": {
    "code": "504",
    "message": "Gateway Timeout"
  }
}