Skip to main content
GET
/
v2
/
payouts
/
recurring
/
{id}
Get the status of a recurring payment
curl --request GET \
  --url https://api.stage.request.network/v2/payouts/recurring/{id}
{
  "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

Recurring payment status retrieved successfully

The response is of type any.

⌘I