Credits

Purchase additional credits

Triggers an immediate credit top-up for the authenticated user

POST /api/v3/credits/topup Try It

cURL

curl -X POST "https://api.handwritingocr.com/v3/credits/topup" \
     -H "Authorization: Bearer your-api-token" \
     -H "Accept: application/json" \
     -F "amount=500"

import requests

url = "https://api.handwritingocr.com/v3/credits/topup"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"amount\"\r\n\r\n500\r\n-----011000010111000001101001--\r\n"
headers = {
    "Authorization": "Bearer your-api-token",
    "content-type": "multipart/form-data"
}

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

print(response.text)

const form = new FormData();
form.append("amount", "500");

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer your-api-token',
    'content-type': 'multipart/form-data'
  }
};

options.body = form;

fetch('https://api.handwritingocr.com/v3/credits/topup', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.handwritingocr.com/v3/credits/topup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer your-api-token'
request["content-type"] = 'multipart/form-data'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"amount\"\r\n\r\n500\r\n-----011000010111000001101001--\r\n"

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.handwritingocr.com/v3/credits/topup",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"amount\"\r\n\r\n500\r\n-----011000010111000001101001--\r\n",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer your-api-token",
    "content-type: multipart/form-data"
  ],
]);

$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/ioutil"
)

func main() {

	url := "https://api.handwritingocr.com/v3/credits/topup"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"amount\"\r\n\r\n500\r\n-----011000010111000001101001--\r\n")

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

	req.Header.Add("Authorization", "Bearer your-api-token")
	req.Header.Add("content-type", "multipart/form-data")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}

200 application/json

{
  "success": true,
  "credits_purchased": 500,
  "new_balance": 1250,
  "amount_charged": "$4.99"
}

Triggers an immediate credit top-up for the authenticated user using their saved payment method. Works independently of auto-topup settings. Rate-limited to one successful purchase per 5-minute window.

Headers

Authorization string required header

Bearer your-api-token
Accept string required header

application/json
Content-Type string required header

multipart/form-data

Body parameters

amount integer required body

Number of credits to purchase. Must be a multiple of 100.

Response codes

HTTP status

200

Purchase succeeded. Returns the number of credits added, the user's updated balance, and the formatted charge amount.
402

The payment requires 3DS or bank authentication before it can complete. Follow authentication_url to verify, then retry.
403

Invalid API token, or the user does not have an active subscription. A subscription is required to purchase credits.
422

Validation error. amount_not_multiple_of_100, amount_below_minimum, no_payment_method, or payment_failed (with decline_code).
429

A successful purchase was already made within the last 5 minutes. Check retry_after (ISO 8601) for when the next purchase is permitted.

Purchase additional credits

cURL

curl -X POST "https://api.handwritingocr.com/v3/credits/topup" \
     -H "Authorization: Bearer your-api-token" \
     -H "Accept: application/json" \
     -F "amount=500"

import requests

url = "https://api.handwritingocr.com/v3/credits/topup"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"amount\"\r\n\r\n500\r\n-----011000010111000001101001--\r\n"
headers = {
    "Authorization": "Bearer your-api-token",
    "content-type": "multipart/form-data"
}

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

print(response.text)

const form = new FormData();
form.append("amount", "500");

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer your-api-token',
    'content-type': 'multipart/form-data'
  }
};

options.body = form;

fetch('https://api.handwritingocr.com/v3/credits/topup', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.handwritingocr.com/v3/credits/topup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer your-api-token'
request["content-type"] = 'multipart/form-data'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"amount\"\r\n\r\n500\r\n-----011000010111000001101001--\r\n"

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.handwritingocr.com/v3/credits/topup",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"amount\"\r\n\r\n500\r\n-----011000010111000001101001--\r\n",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer your-api-token",
    "content-type: multipart/form-data"
  ],
]);

$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/ioutil"
)

func main() {

	url := "https://api.handwritingocr.com/v3/credits/topup"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"amount\"\r\n\r\n500\r\n-----011000010111000001101001--\r\n")

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

	req.Header.Add("Authorization", "Bearer your-api-token")
	req.Header.Add("content-type", "multipart/form-data")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}

200 application/json

{
  "success": true,
  "credits_purchased": 500,
  "new_balance": 1250,
  "amount_charged": "$4.99"
}