Create a reward address

Creates a new reward address for reward attribution

POST /rewards/addresses

Create a reward address

cURL

curl --request POST \
  --url https://api.paxos.com/v2/rewards/addresses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": {
    "customer_id": "<string>",
    "address": "<string>",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "effective_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "payout_group_id": "<string>",
    "balance": "<string>",
    "asset_type": "<string>"
  }
}
'

import requests

url = "https://api.paxos.com/v2/rewards/addresses"

payload = { "address": {
        "customer_id": "<string>",
        "address": "<string>",
        "name": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "effective_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "payout_group_id": "<string>",
        "balance": "<string>",
        "asset_type": "<string>"
    } }
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({
    address: {
      customer_id: '<string>',
      address: '<string>',
      name: '<string>',
      created_at: '2023-11-07T05:31:56Z',
      effective_at: '2023-11-07T05:31:56Z',
      id: '<string>',
      payout_group_id: '<string>',
      balance: '<string>',
      asset_type: '<string>'
    }
  })
};

fetch('https://api.paxos.com/v2/rewards/addresses', 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/addresses",
  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([
    'address' => [
        'customer_id' => '<string>',
        'address' => '<string>',
        'name' => '<string>',
        'created_at' => '2023-11-07T05:31:56Z',
        'effective_at' => '2023-11-07T05:31:56Z',
        'id' => '<string>',
        'payout_group_id' => '<string>',
        'balance' => '<string>',
        'asset_type' => '<string>'
    ]
  ]),
  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/addresses"

	payload := strings.NewReader("{\n  \"address\": {\n    \"customer_id\": \"<string>\",\n    \"address\": \"<string>\",\n    \"name\": \"<string>\",\n    \"created_at\": \"2023-11-07T05:31:56Z\",\n    \"effective_at\": \"2023-11-07T05:31:56Z\",\n    \"id\": \"<string>\",\n    \"payout_group_id\": \"<string>\",\n    \"balance\": \"<string>\",\n    \"asset_type\": \"<string>\"\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/addresses")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": {\n    \"customer_id\": \"<string>\",\n    \"address\": \"<string>\",\n    \"name\": \"<string>\",\n    \"created_at\": \"2023-11-07T05:31:56Z\",\n    \"effective_at\": \"2023-11-07T05:31:56Z\",\n    \"id\": \"<string>\",\n    \"payout_group_id\": \"<string>\",\n    \"balance\": \"<string>\",\n    \"asset_type\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paxos.com/v2/rewards/addresses")

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  \"address\": {\n    \"customer_id\": \"<string>\",\n    \"address\": \"<string>\",\n    \"name\": \"<string>\",\n    \"created_at\": \"2023-11-07T05:31:56Z\",\n    \"effective_at\": \"2023-11-07T05:31:56Z\",\n    \"id\": \"<string>\",\n    \"payout_group_id\": \"<string>\",\n    \"balance\": \"<string>\",\n    \"asset_type\": \"<string>\"\n  }\n}"

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

200

{
  "address": {
    "customer_id": "<string>",
    "address": "<string>",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "effective_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "payout_group_id": "<string>",
    "balance": "<string>",
    "status": "<string>",
    "asset_type": "<string>",
    "verification_proof_id": "<string>",
    "verification_status": "<string>",
    "verification_method": "<string>",
    "verification_expires_at": "2023-11-07T05:31:56Z"
  }
}

OAuth Scope

rewards:write_monitoring_address

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 →

Body

application/json

address · All data associated with an attribution address · object

Show child attributes

Response

200 - application/json

A successful response.

address · All data associated with an attribution address · object

Show child attributes