Sign In

Refund Status

Track a refund through to completion.

POST/v1/route/refund-status/

Returns the current state of a refund by its refund_id. Poll this until refund_completed_at is set, which signals a terminal state.

Authentication

This endpoint is authenticated with your API key plus a per-request SHA-256 hash. Send the key in X-API-Key and the hash in Hash:

Hash formula

Hash = SHA256(key|refund_id|salt), joined with the | character. Your salt is a server-side secret — see the Authentication guide.

Headers

HeaderTypeRequiredDescription
X-API-KeystringRequiredYour merchant API key.
HashstringRequiredSHA-256 auth hash (see Authentication).
Content-TypestringRequiredMust be application/json.

Request Parameters

ParameterTypeRequiredDescription
refund_idstringRequiredThe refund id returned by Refund Initiate.
Non-empty string.

Responses

A successful call returns HTTP 200 OK. Response fields:

FieldTypeDescription
successbooleantrue on success.
refund_idstringGrowthBnk refund id.
transaction_idstringOriginal payment id.
merchant_transaction_idstringYour reference for the original payment.
refund_amountstringRefund amount (two decimals).
refund_statusstringOne of INITIATED, PROCESSING, SUCCESS, FAILURE.
gateway_refund_idstring | nullGateway reference, once assigned.
refund_reasonstring | nullReason supplied at initiation.
refund_requested_atstringISO-8601 request timestamp.
refund_completed_atstring | nullSet only on a terminal state (SUCCESS / FAILURE).

Example responses

Success
200 OK
{
    "success": true,
    "refund_id": "RFD20260707180512345",
    "transaction_id": "TXN20260707172038123",
    "merchant_transaction_id": "ORDER-2026-0001",
    "refund_amount": "150.00",
    "refund_status": "PROCESSING",
    "gateway_refund_id": null,
    "refund_reason": "Customer requested cancellation",
    "refund_requested_at": "2026-07-07T18:05:12Z",
    "refund_completed_at": null
}
Not found
404 Not Found
{
    "success": false,
    "message": "Refund not found.",
    "data": null
}
Invalid hash
401 Unauthorized
{
    "detail": "Invalid authentication hash."
}

Status Codes

StatusMeaning
200 OKReturns the refund record.
401 UnauthorizedBad API key or hash mismatch.
404 Not FoundNo refund matches the id.

Error Codes

StatusMessageReason
404Refund not found.refund_id not found or not owned by you.
401Invalid authentication hash.Computed hash does not match.

Validation Rules

  • refund_id — required, non-empty after trimming.

Notes

  • The hash here excludes the amount: SHA256(key|refund_id|salt).
  • refund_completed_at becoming non-null is your signal that the refund reached a terminal state.

Best Practices

  • Poll with backoff until refund_completed_at is set, then stop.
Request · POST
# 1. Compute the auth hash: sha256(key|refund_id|salt)
API_KEY="YOUR_API_KEY"
API_SALT="YOUR_API_SALT"
HASH=$(printf '%s' "$API_KEY|RFD20260707180512345|$API_SALT" | openssl dgst -sha256 | awk '{print $2}')

# 2. Call the API
curl -X POST "https://api.growthbnk.com/v1/route/refund-status/" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $API_KEY" \
  -H "Hash: $HASH" \
  -d '{
    "refund_id": "RFD20260707180512345"
}'
import hashlib
import requests

API_KEY = "YOUR_API_KEY"
API_SALT = "YOUR_API_SALT"
BASE_URL = "https://api.growthbnk.com"

payload = {
    'refund_id': 'RFD20260707180512345'
}

# Auth hash: sha256(key|refund_id|salt)
signing = f"{API_KEY}|RFD20260707180512345|{API_SALT}"
auth_hash = hashlib.sha256(signing.encode("utf-8")).hexdigest()

response = requests.post(
    f"{BASE_URL}/v1/route/refund-status/",
    json=payload,
    headers={
        "Content-Type": "application/json",
        "X-API-Key": API_KEY,
        "Hash": auth_hash,
    },
    timeout=30,
)
response.raise_for_status()
print(response.json())
<?php
$apiKey  = 'YOUR_API_KEY';
$apiSalt = 'YOUR_API_SALT';
$baseUrl = 'https://api.growthbnk.com';

$payload = [
    'refund_id' => 'RFD20260707180512345'
];

// Auth hash: sha256(key|refund_id|salt)
$signing = "{$apiKey}|RFD20260707180512345|{$apiSalt}";
$authHash = hash('sha256', $signing);

$ch = curl_init("{$baseUrl}/v1/route/refund-status/");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_HTTPHEADER     => [
        'Content-Type: application/json',
        "X-API-Key: {$apiKey}",
        "Hash: {$authHash}",
    ],
    CURLOPT_POSTFIELDS => json_encode($payload),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
const crypto = require('crypto');

const API_KEY = 'YOUR_API_KEY';
const API_SALT = 'YOUR_API_SALT';
const BASE_URL = 'https://api.growthbnk.com';

const payload = {
    'refund_id': 'RFD20260707180512345'
};

// Auth hash: sha256(key|refund_id|salt)
const signing = `${API_KEY}|RFD20260707180512345|${API_SALT}`;
const authHash = crypto.createHash('sha256').update(signing).digest('hex');

const response = await fetch(`${BASE_URL}/v1/route/refund-status/`, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-Key': API_KEY,
    'Hash': authHash,
  },
  body: JSON.stringify(payload),
});
console.log(await response.json());
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;

public class GrowthBnkExample {
    public static void main(String[] args) throws Exception {
        String apiKey = "YOUR_API_KEY";
        String apiSalt = "YOUR_API_SALT";
        String baseUrl = "https://api.growthbnk.com";

        String payload = """
{
    "refund_id": "RFD20260707180512345"
}
""";

        // Auth hash: sha256(key|refund_id|salt)
        String signing = apiKey + "|RFD20260707180512345|" + apiSalt;
        String authHash = sha256Hex(signing);

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(baseUrl + "/v1/route/refund-status/"))
            .header("Content-Type", "application/json")
            .header("X-API-Key", apiKey)
            .header("Hash", authHash)
            .method("POST", HttpRequest.BodyPublishers.ofString(payload))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }

    private static String sha256Hex(String input) throws Exception {
        byte[] digest = MessageDigest.getInstance("SHA-256")
            .digest(input.getBytes(StandardCharsets.UTF_8));
        StringBuilder sb = new StringBuilder();
        for (byte b : digest) sb.append(String.format("%02x", b));
        return sb.toString();
    }
}
using System;
using System.Net.Http;
using System.Security.Cryptography;
using System.Text;
using System.Threading.Tasks;

class GrowthBnkExample
{
    static async Task Main()
    {
        var apiKey = "YOUR_API_KEY";
        var apiSalt = "YOUR_API_SALT";
        var baseUrl = "https://api.growthbnk.com";

        var payload = """
{
    "refund_id": "RFD20260707180512345"
}
""";

        // Auth hash: sha256(key|refund_id|salt)
        var signing = $"{apiKey}|RFD20260707180512345|{apiSalt}";
        var authHash = Convert.ToHexString(
            SHA256.HashData(Encoding.UTF8.GetBytes(signing))).ToLowerInvariant();

        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("X-API-Key", apiKey);
        client.DefaultRequestHeaders.Add("Hash", authHash);

        var content = new StringContent(payload, Encoding.UTF8, "application/json");
        var response = await client.PostAsync($"{baseUrl}/v1/route/refund-status/", content);
        Console.WriteLine(await response.Content.ReadAsStringAsync());
    }
}
package main

import (
	"bytes"
	"crypto/sha256"
	"encoding/hex"
	"fmt"
	"io"
	"net/http"
)

func main() {
	apiKey := "YOUR_API_KEY"
	apiSalt := "YOUR_API_SALT"
	baseURL := "https://api.growthbnk.com"

	payload := []byte(`{
    "refund_id": "RFD20260707180512345"
}`)

	// Auth hash: sha256(key|refund_id|salt)
	signing := apiKey + "|RFD20260707180512345|" + apiSalt
	sum := sha256.Sum256([]byte(signing))
	authHash := hex.EncodeToString(sum[:])

	req, _ := http.NewRequest("POST", baseURL+"/v1/route/refund-status/", bytes.NewReader(payload))
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("X-API-Key", apiKey)
	req.Header.Set("Hash", authHash)

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}
require 'digest'
require 'json'
require 'net/http'
require 'uri'

api_key = 'YOUR_API_KEY'
api_salt = 'YOUR_API_SALT'
base_url = 'https://api.growthbnk.com'

payload = {
    'refund_id' => 'RFD20260707180512345'
}

# Auth hash: sha256(key|refund_id|salt)
signing = "#{api_key}|RFD20260707180512345|#{api_salt}"
auth_hash = Digest::SHA256.hexdigest(signing)

uri = URI("#{base_url}/v1/route/refund-status/")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri, {
  'Content-Type' => 'application/json',
  'X-API-Key' => api_key,
  'Hash' => auth_hash
})
request.body = payload.to_json

response = http.request(request)
puts response.body
Request body
{
    "refund_id": "RFD20260707180512345"
}
Response
200 OK
{
    "success": true,
    "refund_id": "RFD20260707180512345",
    "transaction_id": "TXN20260707172038123",
    "merchant_transaction_id": "ORDER-2026-0001",
    "refund_amount": "150.00",
    "refund_status": "PROCESSING",
    "gateway_refund_id": null,
    "refund_reason": "Customer requested cancellation",
    "refund_requested_at": "2026-07-07T18:05:12Z",
    "refund_completed_at": null
}