v1
latestOpenAPI 3.0.02026-07-22290108.6 KBPay
V2/Payouts
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}
Path parameters
idstring required
Example:01JXYJKCAHGFTDR15F2D072ESG
The ID of the recurring payment
Headers
x-api-keystring
API key for authentication (optional if using Client ID)
x-client-idstring
Client ID for frontend authentication (optional if using API key)
Originstring
Origin header (required for Client ID auth, automatically set by browser)
Response
Recurring payment status retrieved successfully