Loaded

1 min

Loaded

POST

Your endpoint here

Body Parameters

share_publicstringrequired
Description
Public keys are accessible in your PayDocker account under integration menu.
read_eventstringrequired
Description
A condition to allow execution of the action that is connected to the token. The condition would be "token.loaded_created"
source_idstringrequired
Description
Your PayDocker Account ID assigned upon account creation (e.g. PDR1). It is case sensitive.
destination_idstringrequired
Description
Property ID (e.g. ID 001) generated in your platform. It represents the token recipient.
token_idstringrequired
Description
The unique identifier associated with the token that the user is requesting a modification for. (e.g. 2908926013012565)
transaction_idstringrequired
Description
A unique identifier comprising of 20 digits generated by PayDocker upon a successful modification of token.
load_amountstringrequired
Description
The sum added by the partner to the token, which the recipient can then collect. The amount value supports up to twelve digits (e.g. a value of 9,999,999,999.99) divided by decimal.
fee_amountstringrequired
Description
The amount that is incurred to operate the token.
token_balancestringrequired
Description
The sum that is available in the token.

json

{
      "share_public": "string",
      "read_event": "string",
      "source_id": "string",
      "destination_id": "string",
      "token_id": "string",
      "transaction_id": "string",
      "load_amount": "string",
      "fee_amount": "string",
      "token_balance": "string"
}

curl

curl --location --request POST '' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{"share_public":"string","read_event":"string","source_id":"string","destination_id":"string","token_id":"string","transaction_id":"string","load_amount":"string","fee_amount":"string","token_balance":"string"}'

nodejs

var request = require('request');
var options = {
   'method': 'POST',
   'url': '',
   'headers': {
      'Accept': 'application/json',
      'Content-Type': 'application/json'
   },
   body: JSON.stringify({
      "share_public": "string",
      "read_event": "string",
      "source_id": "string",
      "destination_id": "string",
      "token_id": "string",
      "transaction_id": "string",
      "load_amount": "string",
      "fee_amount": "string",
      "token_balance": "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_public": "string",
   "read_event": "string",
   "source_id": "string",
   "destination_id": "string",
   "token_id": "string",
   "transaction_id": "string",
   "load_amount": "string",
   "fee_amount": "string",
   "token_balance": "string"
});

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

fetch("", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests
import json

url = ""

payload = json.dumps({
   "share_public": "string",
   "read_event": "string",
   "source_id": "string",
   "destination_id": "string",
   "token_id": "string",
   "transaction_id": "string",
   "load_amount": "string",
   "fee_amount": "string",
   "token_balance": "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("")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
   "share_public": "string",
   "read_event": "string",
   "source_id": "string",
   "destination_id": "string",
   "token_id": "string",
   "transaction_id": "string",
   "load_amount": "string",
   "fee_amount": "string",
   "token_balance": "string"
})

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

200

{
   "success": true,
   "message": "Success",
}

413

{
  "success": "false",
  "errors": {
    "code": "413",
    "message": "Destination ID Unknown"
  }
}

428

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

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"
  }
}