Recurring

The /Recurring endpoint allows you to retrieve information about an existing recurring payments. These can be records for the FinDock Recurring Payment object or records for source-specific Salesforce objects such as Recurring Donation (NPSP) and Gift Commitment (Fundraising).

The response includes a full list of details about the recurring payment which can be used to confirm and update, for example, the payment method and processor for future installment collections.

get

Get recurring payment details

This endpoint returns detailed information of a recurring payment in Salesforce. The record is source-specific, so you need to ensure you are referencing the correct object record. The object may be the FinDock Recurring Payment or Salesforce objects like Recurring Donation or Gift Commitment.

IDstring

required

The record Id or GUID of the recurring payment record to query.

Example
"a083X00001aUMCnQAO"

Responses

Response examples

API was called successfully.

{
  "Url": "/services/data/v63.0/sobjects/cpm__Recurring_Payment__c/a0V3X00000RKBZmUAP",
  "Type": "cpm__Recurring_Payment__c",
  "SetupUrl": "https://link.dev.findock.com/pay/3xxxxmuai2/8897b4da-e48a-7ff3-90dd-ecb65094802c",
  "PayLinkPage": "pageAbcSlug",
  "PaymentProcessor": "PaymentHub-SEPA",
  "PaymentMethod": "DirectDebit",
  "Id": "a0V3X00000RKBZmUAP",
  "GUID": "sdfasdf-asfads-242134-adsfadf-23423",
  "Amount": 25.0,
  "CurrencyISOCode": "EUR",
  "Frequency": "Monthly",
  "RecordTypeName": "Subscription",
  "StartDate": "2025-01-01",
  "EndDate": "2025-12-01",
  "Description": "Monthly subscription payment",
  "SourceConnector": "PaymentHub"
}

Was this page helpful?