cURL

curl --request POST \
  --url https://api.openformat.tech/v1/reward/credit \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "chain": "arbitrum-sepolia",
  "action_id": "dragon_slayed",
  "receiver": "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266",
  "app_id": "0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a",
  "token_address": "0xd1f09c70f6f2838a3ab6209c1465af68594667ec",
  "amount": 123,
  "mint": false
}
'

import requests

url = "https://api.openformat.tech/v1/reward/credit"

payload = {
    "chain": "arbitrum-sepolia",
    "action_id": "dragon_slayed",
    "receiver": "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266",
    "app_id": "0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a",
    "token_address": "0xd1f09c70f6f2838a3ab6209c1465af68594667ec",
    "amount": 123,
    "mint": False
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    chain: 'arbitrum-sepolia',
    action_id: 'dragon_slayed',
    receiver: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    app_id: '0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a',
    token_address: '0xd1f09c70f6f2838a3ab6209c1465af68594667ec',
    amount: 123,
    mint: false
  })
};

fetch('https://api.openformat.tech/v1/reward/credit', 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.openformat.tech/v1/reward/credit",
  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([
    'chain' => 'arbitrum-sepolia',
    'action_id' => 'dragon_slayed',
    'receiver' => '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    'app_id' => '0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a',
    'token_address' => '0xd1f09c70f6f2838a3ab6209c1465af68594667ec',
    'amount' => 123,
    'mint' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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.openformat.tech/v1/reward/credit"

	payload := strings.NewReader("{\n  \"chain\": \"arbitrum-sepolia\",\n  \"action_id\": \"dragon_slayed\",\n  \"receiver\": \"0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266\",\n  \"app_id\": \"0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a\",\n  \"token_address\": \"0xd1f09c70f6f2838a3ab6209c1465af68594667ec\",\n  \"amount\": 123,\n  \"mint\": false\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	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.openformat.tech/v1/reward/credit")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"chain\": \"arbitrum-sepolia\",\n  \"action_id\": \"dragon_slayed\",\n  \"receiver\": \"0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266\",\n  \"app_id\": \"0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a\",\n  \"token_address\": \"0xd1f09c70f6f2838a3ab6209c1465af68594667ec\",\n  \"amount\": 123,\n  \"mint\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.openformat.tech/v1/reward/credit")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"chain\": \"arbitrum-sepolia\",\n  \"action_id\": \"dragon_slayed\",\n  \"receiver\": \"0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266\",\n  \"app_id\": \"0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a\",\n  \"token_address\": \"0xd1f09c70f6f2838a3ab6209c1465af68594667ec\",\n  \"amount\": 123,\n  \"mint\": false\n}"

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

{
  "success": true,
  "unsignedTransaction": {
    "to": "0x3f0431f04c76623481d5a27056174d550cff5e55",
    "data": "0x609512c90000000000000000000000008102a11ecb4f81da915e1d21b2e525d0a67e83b3012dc3a010c7d01b50e0d17dc79e0b646865725f6a756d7000000000000000000000000000000000000000000000414354494f4e0000000000000000000000000000000000000000000000",
    "maxPriorityFeePerGas": "1020840008",
    "maxFeePerGas": "1035102698",
    "gas": "99572",
    "gasLimit": "99572",
    "nonce": 36,
    "chainId": 31337,
    "type": 2
  }
}

{
  "success": false,
  "error": {
    "code": "validation_error",
    "message": "Some parameters are invalid",
    "issues": [
      {
        "code": "too_small",
        "message": "Number must be greater than 0",
        "parameter": "amount",
        "path": "amount"
      }
    ]
  }
}

{
  "success": false,
  "error": {
    "code": "token_not_found",
    "message": "Credit token not found"
  }
}

{
  "success": false,
  "error": {
    "code": "transaction_error",
    "message": "There was an error in the blockchain transaction",
    "transaction_error": {
      "reason": "Error: ERC20Base__InsufficientAllowance() ",
      "message": "The contract function \"transferERC20\" reverted with the following signature:\n0x01c2999e. Error: ERC20Base__InsufficientAllowance() ",
      "detailsMessage": "Error: ERC20Base__InsufficientAllowance() Contract Call:   address:   0x3f0431f04c76623481d5a27056174d550cff5e55\n  function:  transferERC20(address _token, address _to, uint256 _amount, bytes32 _id, bytes32 _activityType, string _uri)\n  args:                   (0x8102a11ecb4f81da915e1d21b2e525d0a67e83b3, 0x70997970c51812dc3a010c7d01b50e0d17dc79c8, 1000000000000000000, 0x6f746865725f6a756d7000000000000000000000000000000000000000000000, 0x414354494f4e0000000000000000000000000000000000000000000000000000, )\n  sender:    0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266",
      "contract_address": "0x3f0431f04c76623481d5a27056174d550cff5e55",
      "chain_id": 31337,
      "function_name": "transferERC20"
    }
  }
}

Rewards

Transfer ERC-20

Transfer ERC-20 tokens to users in your application. This endpoint (previously known as “Credit”) enables you to reward users with ERC-20 tokens for their actions or achievements. The endpoint returns an unsigned transaction that needs to be signed using your application’s private key (stored securely in server environment variables). After signing, you can broadcast the transaction using either:

Execute Transaction endpoint for immediate submission
Execute Transaction and Wait endpoint if you need to wait for transaction confirmation

Important Notes:

Default Behavior: By default, this endpoint transfers existing ERC-20 tokens from the transaction sender’s account to the receiver’s account through the Application contract specified in the app_id parameter.
Required Setup: Before using this endpoint, you must create an allowance for the Application contract to transfer the required amount of tokens. This can be done using the approve endpoint.
Minting Option: If you want to mint new tokens instead of transferring existing ones, set the optional parameter mint to true.

POST

reward

credit

cURL

curl --request POST \
  --url https://api.openformat.tech/v1/reward/credit \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "chain": "arbitrum-sepolia",
  "action_id": "dragon_slayed",
  "receiver": "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266",
  "app_id": "0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a",
  "token_address": "0xd1f09c70f6f2838a3ab6209c1465af68594667ec",
  "amount": 123,
  "mint": false
}
'

import requests

url = "https://api.openformat.tech/v1/reward/credit"

payload = {
    "chain": "arbitrum-sepolia",
    "action_id": "dragon_slayed",
    "receiver": "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266",
    "app_id": "0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a",
    "token_address": "0xd1f09c70f6f2838a3ab6209c1465af68594667ec",
    "amount": 123,
    "mint": False
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    chain: 'arbitrum-sepolia',
    action_id: 'dragon_slayed',
    receiver: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    app_id: '0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a',
    token_address: '0xd1f09c70f6f2838a3ab6209c1465af68594667ec',
    amount: 123,
    mint: false
  })
};

fetch('https://api.openformat.tech/v1/reward/credit', 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.openformat.tech/v1/reward/credit",
  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([
    'chain' => 'arbitrum-sepolia',
    'action_id' => 'dragon_slayed',
    'receiver' => '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    'app_id' => '0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a',
    'token_address' => '0xd1f09c70f6f2838a3ab6209c1465af68594667ec',
    'amount' => 123,
    'mint' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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.openformat.tech/v1/reward/credit"

	payload := strings.NewReader("{\n  \"chain\": \"arbitrum-sepolia\",\n  \"action_id\": \"dragon_slayed\",\n  \"receiver\": \"0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266\",\n  \"app_id\": \"0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a\",\n  \"token_address\": \"0xd1f09c70f6f2838a3ab6209c1465af68594667ec\",\n  \"amount\": 123,\n  \"mint\": false\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	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.openformat.tech/v1/reward/credit")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"chain\": \"arbitrum-sepolia\",\n  \"action_id\": \"dragon_slayed\",\n  \"receiver\": \"0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266\",\n  \"app_id\": \"0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a\",\n  \"token_address\": \"0xd1f09c70f6f2838a3ab6209c1465af68594667ec\",\n  \"amount\": 123,\n  \"mint\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.openformat.tech/v1/reward/credit")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"chain\": \"arbitrum-sepolia\",\n  \"action_id\": \"dragon_slayed\",\n  \"receiver\": \"0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266\",\n  \"app_id\": \"0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a\",\n  \"token_address\": \"0xd1f09c70f6f2838a3ab6209c1465af68594667ec\",\n  \"amount\": 123,\n  \"mint\": false\n}"

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

{
  "success": true,
  "unsignedTransaction": {
    "to": "0x3f0431f04c76623481d5a27056174d550cff5e55",
    "data": "0x609512c90000000000000000000000008102a11ecb4f81da915e1d21b2e525d0a67e83b3012dc3a010c7d01b50e0d17dc79e0b646865725f6a756d7000000000000000000000000000000000000000000000414354494f4e0000000000000000000000000000000000000000000000",
    "maxPriorityFeePerGas": "1020840008",
    "maxFeePerGas": "1035102698",
    "gas": "99572",
    "gasLimit": "99572",
    "nonce": 36,
    "chainId": 31337,
    "type": 2
  }
}

{
  "success": false,
  "error": {
    "code": "validation_error",
    "message": "Some parameters are invalid",
    "issues": [
      {
        "code": "too_small",
        "message": "Number must be greater than 0",
        "parameter": "amount",
        "path": "amount"
      }
    ]
  }
}

{
  "success": false,
  "error": {
    "code": "token_not_found",
    "message": "Credit token not found"
  }
}

{
  "success": false,
  "error": {
    "code": "transaction_error",
    "message": "There was an error in the blockchain transaction",
    "transaction_error": {
      "reason": "Error: ERC20Base__InsufficientAllowance() ",
      "message": "The contract function \"transferERC20\" reverted with the following signature:\n0x01c2999e. Error: ERC20Base__InsufficientAllowance() ",
      "detailsMessage": "Error: ERC20Base__InsufficientAllowance() Contract Call:   address:   0x3f0431f04c76623481d5a27056174d550cff5e55\n  function:  transferERC20(address _token, address _to, uint256 _amount, bytes32 _id, bytes32 _activityType, string _uri)\n  args:                   (0x8102a11ecb4f81da915e1d21b2e525d0a67e83b3, 0x70997970c51812dc3a010c7d01b50e0d17dc79c8, 1000000000000000000, 0x6f746865725f6a756d7000000000000000000000000000000000000000000000, 0x414354494f4e0000000000000000000000000000000000000000000000000000, )\n  sender:    0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266",
      "contract_address": "0x3f0431f04c76623481d5a27056174d550cff5e55",
      "chain_id": 31337,
      "function_name": "transferERC20"
    }
  }
}

{
  "success": true,
  "unsignedTransaction": {
    "to": "0x3f0431f04c76623481d5a27056174d550cff5e55",
    "data": "0x609512c90000000000000000000000008102a11ecb4f81da915e1d21b2e525d0a67e83b3012dc3a010c7d01b50e0d17dc79e0b646865725f6a756d7000000000000000000000000000000000000000000000414354494f4e0000000000000000000000000000000000000000000000",
    "maxPriorityFeePerGas": "1020840008",
    "maxFeePerGas": "1035102698",
    "gas": "99572",
    "gasLimit": "99572",
    "nonce": 36,
    "chainId": 31337,
    "type": 2
  }
}

{
  "success": false,
  "error": {
    "code": "validation_error",
    "message": "Some parameters are invalid",
    "issues": [
      {
        "code": "too_small",
        "message": "Number must be greater than 0",
        "parameter": "amount",
        "path": "amount"
      }
    ]
  }
}

{
  "success": false,
  "error": {
    "code": "token_not_found",
    "message": "Credit token not found"
  }
}

{
  "success": false,
  "error": {
    "code": "transaction_error",
    "message": "There was an error in the blockchain transaction",
    "transaction_error": {
      "reason": "Error: ERC20Base__InsufficientAllowance() ",
      "message": "The contract function \"transferERC20\" reverted with the following signature:\n0x01c2999e. Error: ERC20Base__InsufficientAllowance() ",
      "detailsMessage": "Error: ERC20Base__InsufficientAllowance() Contract Call:   address:   0x3f0431f04c76623481d5a27056174d550cff5e55\n  function:  transferERC20(address _token, address _to, uint256 _amount, bytes32 _id, bytes32 _activityType, string _uri)\n  args:                   (0x8102a11ecb4f81da915e1d21b2e525d0a67e83b3, 0x70997970c51812dc3a010c7d01b50e0d17dc79c8, 1000000000000000000, 0x6f746865725f6a756d7000000000000000000000000000000000000000000000, 0x414354494f4e0000000000000000000000000000000000000000000000000000, )\n  sender:    0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266",
      "contract_address": "0x3f0431f04c76623481d5a27056174d550cff5e55",
      "chain_id": 31337,
      "function_name": "transferERC20"
    }
  }
}

Authorizations

X-API-KEY

string

header

required

Body

application/json

chain

string

required

Blockchain network to use

Required string length: 1 - 255

Example:

"arbitrum-sepolia"

action_id

string

required

Action Id

Required string length: 1 - 32

Example:

"dragon_slayed"

receiver

string

required

Ethereum addres of the receiver

Pattern: ^(0x)?[0-9a-fA-F]{40}$

Example:

"0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266"

app_id

string

required

Ethereum address of the application

Pattern: ^(0x)?[0-9a-fA-F]{40}$

Example:

"0x9716fb655f2a72b1fc1b4db02b8ad20b6747442a"

token_address

string

required

Ethereum address of the Credit token

Pattern: ^(0x)?[0-9a-fA-F]{40}$

Example:

"0xd1f09c70f6f2838a3ab6209c1465af68594667ec"

amount

number

required

Amount of tokens to reward

Required range: x > 0

Example:

123

mint

boolean

default:false

Whether to mint the Credit tokens instead of doing a transfer

Example:

false

Response

Rewards Credit token

success

enum<boolean>

required

Success response

Available options:

true

Example:

true

unsignedTransaction

any | null

Unsigned transaction object for the user to sign

Mint Point/ERC-20 Reward Badge

API Key

Rewards

Credit

Transactions

Profile

Leaderboard

Webhook

Webhook Secret

Transfer ERC-20

Authorizations

Body

Response