Get the status of a recurring payment

Retrieve the current status and execution details of a recurring payment. Returns information about executed payments, remaining executions, next payment date, and overall status. This endpoint is useful for monitoring recurring payment progress and checking if payments are being executed as expected. Note: Customer information (PII) is not included in the response for security reasons.

GET /v2/payouts/recurring/{id}

Get the status of a recurring payment

cURL

curl --request GET \
  --url https://api.request.network/v2/payouts/recurring/{id}

import requests

url = "https://api.request.network/v2/payouts/recurring/{id}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.request.network/v2/payouts/recurring/{id}', 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.request.network/v2/payouts/recurring/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.request.network/v2/payouts/recurring/{id}"

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.request.network/v2/payouts/recurring/{id}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.request.network/v2/payouts/recurring/{id}")

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

request = Net::HTTP::Get.new(url)

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

200

active

{
  "processedPayments": 3,
  "totalPayments": 30,
  "lastPaymentDate": "2025-01-04T10:00:00.000Z",
  "nextPaymentDate": "2025-01-05T10:00:00.000Z",
  "status": "active",
  "requests": [
    {
      "paymentReference": "0xb3581f0b0f74cc61",
      "requestId": "01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb"
    }
  ],
  "payments": [
    {
      "id": "01JXYJKCAHGFTDR15F2D072ESG",
      "amount": "10",
      "timestamp": "2025-01-04T10:00:00.000Z",
      "txHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"
    }
  ]
}

Headers

x-api-key · string

API key for authentication (optional if using Client ID)

x-client-id · string

Client ID for frontend authentication (optional if using API key)

Origin · string

Origin header (required for Client ID auth, automatically set by browser)

Path Parameters

id · string · required

The ID of the recurring payment

Example:

"01JXYJKCAHGFTDR15F2D072ESG"

Response

200

application/json

Recurring payment status retrieved successfully