Check Transaction Status and Account Balance

After initiating a payout, you’ll want to confirm whether the transfer reached the beneficiary and monitor your available funds. This page covers two endpoints: one to query the status of a specific payout transaction, and another to retrieve your current merchant account balance.

Quick ReferencePayout Status: POST /merchant/payout/status Required: transaction_id or merchant_ref_id Returns: status, utr, amount, modeAccount Balance: GET /merchant/payout/balance Required: x-api-key header only Returns: available_balance, locked_balanceNote: Status endpoint is rate-limited. Use webhooks for real-time updates.

API 1: Check Payout Transaction Status

Query the outcome of a payout you previously initiated. Supply either the transaction_id returned by FastFlowPe or your own merchant_ref_id — you only need one.

Endpoint

POST https://api.fastflowpe.com/merchant/payout/status

Request Headers

Header	Value
`x-api-key`	Your API key
`Content-Type`	`application/json`

Request Body Parameters

string

The transaction_id returned in the Initiate Payout response. Use this or merchant_ref_id — you don’t need both.

string

Your own reference ID that you supplied when initiating the payout. Use this or transaction_id — you don’t need both.

This endpoint is protected by an active rate limiter. Do not poll it in a tight loop or at high frequency — excessive requests will be throttled. For production systems, rely on webhooks to receive status updates automatically and use this endpoint only for on-demand lookups.

curl --location 'https://api.fastflowpe.com/merchant/payout/status' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <your-x-api-key>' \
--data '{"transaction_id": "your-transaction-id"}'

import requests

url = "https://api.fastflowpe.com/merchant/payout/status"
headers = {"x-api-key": "<your-x-api-key>", "Content-Type": "application/json"}
payload = {"transaction_id": "your-transaction-id"}

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

const response = await fetch("https://api.fastflowpe.com/merchant/payout/status", {
  method: "POST",
  headers: {
    "x-api-key": "<your-x-api-key>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ transaction_id: "your-transaction-id" }),
});
console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.fastflowpe.com/merchant/payout/status"))
    .header("x-api-key", "<your-x-api-key>")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString("{\"transaction_id\": \"your-transaction-id\"}"))
    .build();

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

package main

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

func main() {
    payload := []byte(`{"transaction_id": "your-transaction-id"}`)
    req, _ := http.NewRequest("POST", "https://api.fastflowpe.com/merchant/payout/status", bytes.NewBuffer(payload))
    req.Header.Set("x-api-key", "<your-x-api-key>")
    req.Header.Set("Content-Type", "application/json")
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

<?php
$ch = curl_init("https://api.fastflowpe.com/merchant/payout/status");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(["transaction_id" => "your-transaction-id"]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <your-x-api-key>",
    "Content-Type: application/json",
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

require 'net/http'
require 'uri'
require 'json'

uri = URI('https://api.fastflowpe.com/merchant/payout/status')
request = Net::HTTP::Post.new(uri)
request['x-api-key'] = '<your-x-api-key>'
request['Content-Type'] = 'application/json'
request.body = { transaction_id: 'your-transaction-id' }.to_json

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body

{
    "status": "success",
    "status_code": 200,
    "message": "Transaction status retrieved successfully",
    "data": {
        "status": "SUCCESS"
    }
}

Response

string

Top-level API call result — success or error.

integer

HTTP status code (e.g., 200).

string

Human-readable description of the result.

object

The payout status payload.

Show data fields

string

Current state of the payout transaction. Common values:

SUCCESS — funds have been successfully credited to the beneficiary.
FAILED — the transfer was not completed; check webhook details for the reason.
PENDING — the transfer is still in progress.

API 2: Check Merchant Balance

Retrieve the current available balance in your merchant virtual account before initiating payouts or for reconciliation purposes.

Endpoint

GET https://api.fastflowpe.com/merchant/payout/api/merchant/balance

Request Headers

Header	Value
`x-api-key`	Your API key

Query Parameters

string

required

Your Virtual Account ID. The balance returned is specific to this virtual account.

curl --location 'https://api.fastflowpe.com/merchant/payout/api/merchant/balance?va_id=SVA-123456' \
--header 'x-api-key: <your-x-api-key>'

import requests

url = "https://api.fastflowpe.com/merchant/payout/api/merchant/balance"
response = requests.get(url, params={"va_id": "SVA-123456"}, headers={"x-api-key": "<your-x-api-key>"})
print(response.json())

const response = await fetch("https://api.fastflowpe.com/merchant/payout/api/merchant/balance?va_id=SVA-123456", {
  headers: { "x-api-key": "<your-x-api-key>" },
});
console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.fastflowpe.com/merchant/payout/api/merchant/balance?va_id=SVA-123456"))
    .header("x-api-key", "<your-x-api-key>")
    .GET()
    .build();

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

package main

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

func main() {
    req, _ := http.NewRequest("GET", "https://api.fastflowpe.com/merchant/payout/api/merchant/balance?va_id=SVA-123456", nil)
    req.Header.Set("x-api-key", "<your-x-api-key>")
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

<?php
$ch = curl_init("https://api.fastflowpe.com/merchant/payout/api/merchant/balance?va_id=SVA-123456");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-api-key: <your-x-api-key>"]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

require 'net/http'
require 'uri'

uri = URI('https://api.fastflowpe.com/merchant/payout/api/merchant/balance?va_id=SVA-123456')
request = Net::HTTP::Get.new(uri)
request['x-api-key'] = '<your-x-api-key>'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body

{
    "status": "success",
    "status_code": 200,
    "message": "Balance fetched successfully",
    "data": {
        "merchant_id": "<Your merchant id>",
        "balance": 500.0
    }
}

Response

string

Top-level API call result — success or error.

integer

HTTP status code (e.g., 200).

string

Human-readable description of the result.

object

The balance payload for your merchant account.

Show data fields

string

Your FastFlowPe merchant identifier.

float

The current available balance in INR associated with the specified va_id.

Webhook Alternative

For production systems, configure a webhook callback URL instead of polling the status endpoint. FastFlowPe sends a POST request to your callback URL the moment a payout status changes, giving you real-time updates without any rate-limit concerns. See Callback Configuration to set up your endpoint.

FastFlowPe delivers the following payload to your webhook URL on every payout status change:

Webhook Payload

{
    "transaction": {
        "id": "5314e23a-4931-400f-b499-c4347ad0c7f3",
        "amount": "500.00",
        "payment_type": "IMPS",
        "utr": "92834823745",
        "status": "SUCCESS",
        "beneficiary_details": {
            "beneficiary_ifsc": "ICIC0009999",
            "beneficiary_name": "John Doe",
            "beneficiary_email": "johndoe@example.com",
            "beneficiary_mobile": "9999999999",
            "beneficiary_acc_number": "109909023553"
        },
        "merchant_ref_id": "TXN_REF_001"
    }
}

⌘I

curl --location 'https://api.fastflowpe.com/merchant/payout/status' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <your-x-api-key>' \
--data '{"transaction_id": "your-transaction-id"}'

import requests

url = "https://api.fastflowpe.com/merchant/payout/status"
headers = {"x-api-key": "<your-x-api-key>", "Content-Type": "application/json"}
payload = {"transaction_id": "your-transaction-id"}

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

const response = await fetch("https://api.fastflowpe.com/merchant/payout/status", {
  method: "POST",
  headers: {
    "x-api-key": "<your-x-api-key>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ transaction_id: "your-transaction-id" }),
});
console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.fastflowpe.com/merchant/payout/status"))
    .header("x-api-key", "<your-x-api-key>")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString("{\"transaction_id\": \"your-transaction-id\"}"))
    .build();

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

package main

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

func main() {
    payload := []byte(`{"transaction_id": "your-transaction-id"}`)
    req, _ := http.NewRequest("POST", "https://api.fastflowpe.com/merchant/payout/status", bytes.NewBuffer(payload))
    req.Header.Set("x-api-key", "<your-x-api-key>")
    req.Header.Set("Content-Type", "application/json")
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

<?php
$ch = curl_init("https://api.fastflowpe.com/merchant/payout/status");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(["transaction_id" => "your-transaction-id"]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: <your-x-api-key>",
    "Content-Type: application/json",
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

require 'net/http'
require 'uri'
require 'json'

uri = URI('https://api.fastflowpe.com/merchant/payout/status')
request = Net::HTTP::Post.new(uri)
request['x-api-key'] = '<your-x-api-key>'
request['Content-Type'] = 'application/json'
request.body = { transaction_id: 'your-transaction-id' }.to_json

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body

{
    "status": "success",
    "status_code": 200,
    "message": "Transaction status retrieved successfully",
    "data": {
        "status": "SUCCESS"
    }
}

Get Started

Collections

Payment Links

Fund Transfer

Refunds

Callbacks

Check Transaction Status and Account Balance

API 1: Check Payout Transaction Status

Endpoint

Request Headers

Request Body Parameters

Response

API 2: Check Merchant Balance

Endpoint

Request Headers

Query Parameters

Response

Webhook Alternative

​API 1: Check Payout Transaction Status

​Endpoint

​Request Headers

​Request Body Parameters

​Response

​API 2: Check Merchant Balance

​Endpoint

​Request Headers

​Query Parameters

​Response

​Webhook Alternative

API 1: Check Payout Transaction Status

Endpoint

Request Headers

Request Body Parameters

Response

API 2: Check Merchant Balance

Endpoint

Request Headers

Query Parameters

Response

Webhook Alternative