Create a claim schedule

curl --request POST \
  --url https://api.paxos.com/v2/rewards/claim-schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payout_group_id": "<string>",
  "hour": 123,
  "minute": 123,
  "days_of_week": [
    123
  ],
  "days_of_month": [
    123
  ]
}
'

import requests

url = "https://api.paxos.com/v2/rewards/claim-schedules"

payload = {
    "payout_group_id": "<string>",
    "hour": 123,
    "minute": 123,
    "days_of_week": [123],
    "days_of_month": [123]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    payout_group_id: '<string>',
    hour: 123,
    minute: 123,
    days_of_week: [123],
    days_of_month: [123]
  })
};

fetch('https://api.paxos.com/v2/rewards/claim-schedules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paxos.com/v2/rewards/claim-schedules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payout_group_id' => '<string>',
    'hour' => 123,
    'minute' => 123,
    'days_of_week' => [
        123
    ],
    'days_of_month' => [
        123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paxos.com/v2/rewards/claim-schedules"

	payload := strings.NewReader("{\n  \"payout_group_id\": \"<string>\",\n  \"hour\": 123,\n  \"minute\": 123,\n  \"days_of_week\": [\n    123\n  ],\n  \"days_of_month\": [\n    123\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.paxos.com/v2/rewards/claim-schedules")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payout_group_id\": \"<string>\",\n  \"hour\": 123,\n  \"minute\": 123,\n  \"days_of_week\": [\n    123\n  ],\n  \"days_of_month\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paxos.com/v2/rewards/claim-schedules")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payout_group_id\": \"<string>\",\n  \"hour\": 123,\n  \"minute\": 123,\n  \"days_of_week\": [\n    123\n  ],\n  \"days_of_month\": [\n    123\n  ]\n}"

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

{
  "claim_schedule": {
    "id": "<string>",
    "payout_group_id": "<string>",
    "schedule_type": "DAILY",
    "next_run_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "days_of_week": [
      123
    ],
    "days_of_month": [
      123
    ],
    "hour": 123,
    "minute": 123
  }
}

POST

rewards

claim-schedules

Create a claim schedule

curl --request POST \
  --url https://api.paxos.com/v2/rewards/claim-schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payout_group_id": "<string>",
  "hour": 123,
  "minute": 123,
  "days_of_week": [
    123
  ],
  "days_of_month": [
    123
  ]
}
'

import requests

url = "https://api.paxos.com/v2/rewards/claim-schedules"

payload = {
    "payout_group_id": "<string>",
    "hour": 123,
    "minute": 123,
    "days_of_week": [123],
    "days_of_month": [123]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    payout_group_id: '<string>',
    hour: 123,
    minute: 123,
    days_of_week: [123],
    days_of_month: [123]
  })
};

fetch('https://api.paxos.com/v2/rewards/claim-schedules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paxos.com/v2/rewards/claim-schedules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payout_group_id' => '<string>',
    'hour' => 123,
    'minute' => 123,
    'days_of_week' => [
        123
    ],
    'days_of_month' => [
        123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paxos.com/v2/rewards/claim-schedules"

	payload := strings.NewReader("{\n  \"payout_group_id\": \"<string>\",\n  \"hour\": 123,\n  \"minute\": 123,\n  \"days_of_week\": [\n    123\n  ],\n  \"days_of_month\": [\n    123\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.paxos.com/v2/rewards/claim-schedules")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payout_group_id\": \"<string>\",\n  \"hour\": 123,\n  \"minute\": 123,\n  \"days_of_week\": [\n    123\n  ],\n  \"days_of_month\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paxos.com/v2/rewards/claim-schedules")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payout_group_id\": \"<string>\",\n  \"hour\": 123,\n  \"minute\": 123,\n  \"days_of_week\": [\n    123\n  ],\n  \"days_of_month\": [\n    123\n  ]\n}"

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

{
  "claim_schedule": {
    "id": "<string>",
    "payout_group_id": "<string>",
    "schedule_type": "DAILY",
    "next_run_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "days_of_week": [
      123
    ],
    "days_of_month": [
      123
    ],
    "hour": 123,
    "minute": 123
  }
}

OAuth Scope

rewards:write_claims_schedule

Authorizations

Authorization

string

header

required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

Production: https://oauth.paxos.com/oauth2/token
Sandbox: https://oauth.sandbox.paxos.com/oauth2/token

Learn more in the API credentials guide →

FlowClient Credentials

Token URL: https://oauth.paxos.com/oauth2/token

Scopes1

rewards:write_claims_schedule

Body

application/json

payout_group_id

string

required

schedule_type

enum<string>

required

Available options:

DAILY,

MONTHLY,

WEEKLY

hour

integer<int32>

required

minute

integer<int32>

required

days_of_week

integer<int32>[]

days_of_month

integer<int32>[]

Response

200 - application/json

A successful response.

claim_schedule

object

Show child attributes

API Documentation

Deposits and Withdrawals

Address Verification

Identity

Profiles

Sandbox

Orchestrations / Conversions

Taxes

Trading

Rewards Engine

Events

API Credentials

User Audit Logs

Websockets

Webhooks

Problems

Create a claim schedule

Authorizations

Body

Response