Recurring status

GET /v1/payments/recurring/status/{terminal_friendly_id} Returns the full state of a recurring series - its schedule configuration, payment instrument, payer details, completed transaction history, and upcoming scheduled payments.

curl --request GET \
  --url 'https://api.smartretry.com/v1/payments/recurring/status/ABC123?recurring_id=RC9F4A2B' \
  --header 'x-api-key: YOUR_API_KEY'

import requests

response = requests.get(
    "https://api.smartretry.com/v1/payments/recurring/status/ABC123",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={"recurring_id": "RC9F4A2B"}
)

print(response.json())

const response = await fetch(
  "https://api.smartretry.com/v1/payments/recurring/status/ABC123?recurring_id=RC9F4A2B",
  {
    method: "GET",
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data);

Path parameters

terminal_friendly_id

string

required

Your 6-character terminal identifier.

Query parameters

recurring_id

string

required

The 8-character identifier of the recurring series to look up.

Response

recurring_id

string

Unique identifier of the recurring series (8 characters).

order_id

string

Order identifier associated with the series (8 characters).

status

string

Top-level series status. One of active, paused, cancelled, or completed.

recurring

object

Detailed schedule configuration for the series.

Show properties

status

string

Series status. One of active, paused, cancelled, or completed.

managed_by

string

Who controls billing. One of merchant, our_platform, or payment_provider.

first_payment_date

string

Date of the first scheduled payment (YYYY-MM-DD).

recurring_date_type

string

Billing frequency. One of daily, weekly, monthly, or yearly.

time_interval

integer

Interval multiplier applied to recurring_date_type.

number_of_payments

integer

Total number of payments configured for this series. Absent if the agreement is open-ended.

cancellation_date

string

Date on which the agreement automatically ends (YYYY-MM-DD).

completed_payments

integer

Number of payments that have been successfully processed. Minimum: 0.

remaining_payments

integer

Number of payments remaining before the series completes. Minimum: 0.

payment_instrument

object

Stored payment instrument associated with this series.

Show properties

token

string

88-character stored payment token for this instrument.

payment_method

string

Payment method type (e.g., cards, digital_wallets).

card_cardholder_name

string

Name on the card.

card_card_last_four_digit

string

Last four digits of the card number.

card_bin

string

Bank identification number (first six digits of the card).

expiration_date

string

Card expiry date in ISO 8601 format.

card_profile

object

Enriched card metadata.

Show properties

fingerprint

string

Unique fingerprint for this card across your account.

issuer.name

string

Name of the card-issuing bank.

brand.name

string

Card network brand (e.g., Visa, Mastercard).

category

string

Card category (e.g., consumer, corporate, prepaid).

payer

object

Identity information for the payer on this series.

future_transactions

array

List of upcoming scheduled payments in this series. Each entry describes a planned charge that has not yet been processed.

completed_transactions

array

List of transactions that have already been processed as part of this series, in chronological order.

Example response

{
  "recurring_id": "RC9F4A2B",
  "order_id": "OR7B9E1D",
  "status": "active",
  "recurring": {
    "status": "active",
    "managed_by": "our_platform",
    "first_payment_date": "2026-04-01",
    "recurring_date_type": "monthly",
    "time_interval": 1,
    "number_of_payments": 12,
    "cancellation_date": null,
    "completed_payments": 1,
    "remaining_payments": 11
  },
  "payment_instrument": {
    "token": "tok_88chartoken...",
    "payment_method": "cards",
    "card_cardholder_name": "Jane Smith",
    "card_card_last_four_digit": "1111",
    "card_bin": "411111",
    "expiration_date": "2028-12-31T00:00:00Z",
    "card_profile": {
      "fingerprint": "fp_abc123...",
      "issuer.name": "Chase",
      "brand.name": "Visa",
      "category": "consumer"
    }
  },
  "payer": {
    "first_name": "Jane",
    "last_name": "Smith",
    "email_username": "jane.smith",
    "email_domain": "example.com"
  },
  "future_transactions": [
    {
      "future_transaction_id": "FT3D8E1C",
      "scheduled_date": "2026-05-01",
      "amount": 19.99,
      "currency": "USD",
      "status": "pending"
    }
  ],
  "completed_transactions": [
    {
      "transaction_id": "TX8A3F2C",
      "order_id": "OR7B9E1D",
      "amount": 19.99,
      "currency": "USD",
      "accepted": true
    }
  ]
}

Overview

Payments

Recurring

Future Transactions

Path parameters

Query parameters

Response

​Path parameters

​Query parameters

​Response

Path parameters

Query parameters

Response