Documentation Index Fetch the complete documentation index at: https://www.smartretry.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
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'
Path parameters Your 6-character terminal identifier.
Query parameters The 8-character identifier of the recurring series to look up.
Response Unique identifier of the recurring series (8 characters).
Order identifier associated with the series (8 characters).
Top-level series status. One of active, paused, cancelled, or completed.
Detailed schedule configuration for the series. Series status. One of active, paused, cancelled, or completed.
Who controls billing. One of merchant, our_platform, or payment_provider.
Date of the first scheduled payment (YYYY-MM-DD).
Billing frequency. One of daily, weekly, monthly, or yearly.
Interval multiplier applied to recurring_date_type.
Total number of payments configured for this series. Absent if the agreement is open-ended.
Date on which the agreement automatically ends (YYYY-MM-DD).
Number of payments that have been successfully processed. Minimum: 0.
Number of payments remaining before the series completes. Minimum: 0.
Stored payment instrument associated with this series. 88-character stored payment token for this instrument.
Payment method type (e.g., cards, digital_wallets).
card_card_last_four_digit
Last four digits of the card number.
Bank identification number (first six digits of the card).
Card expiry date in ISO 8601 format.
Enriched card metadata. Unique fingerprint for this card across your account.
Name of the card-issuing bank.
Card network brand (e.g., Visa, Mastercard).
Card category (e.g., consumer, corporate, prepaid).
Identity information for the payer on this series.
List of upcoming scheduled payments in this series. Each entry describes a planned charge that has not yet been processed.
List of transactions that have already been processed as part of this series, in chronological order.
{ "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 } ] }
