• Payment API

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.

Recurring object schema

Urlstring

The Salesforce URL of the recurring payment.

Example
"/services/data/v62.0/sobjects/cpm__Recurring_Payment__c/a0V3X00000RKBZmUAP"
Typestring

The type of recurring payment object used in Salesforce. This can be the FinDock object cpm__Recurring_Payment__c or an object from a source package like Recurring Donation.

Example
"cpm__Recurring_Payment__c"
SetupUrlstring

The URL to a payment setup page where the payer can update how the recurring payment will be paid.

Example
"https://link.dev.findock.com/pay/3xxxxmuai2/8897b4da-e48a-7ff3-90dd-ecb65094802c"
PayLinkPagestring

The slug for the payment setup page when multiple PayLinks pages are configured in the org.

Example
"pageAbcSlug"
Idstring

The unique ID of the recurring payment in Salesforce.

Example
"a0V3X00000S7BuCUAV"
GUIDstring

The Salesforce GUID of the recurring payment.

Example
"sdfasdf-asfads-242134-adsfadf-23423"
Amountnumber

The amount collected or disbursed.

Example
10.0
CurrencyISOCodestring

Can be used in Salesforce orgs with multi-currency available. A valid ISO 4217 currency code. A list of currency codes can be found here

Example
"EUR"
Frequencystring

The frequency with which installments are collected. e.g. 'Weekly', 'Monthly'. NOTE: The formatting of the frequency options depends on the source connector your provide in the request. Please adjust your values accordingly.

Example
"Monthly"
RecordTypeNamestring

The Salesforce RecordType of the recurring payment.

Example
"Subscription"
StartDatestring

The first date the recurring payment is collected. Format is yyyy-mm-dd.

Format
date
Example
"2025-01-01"
EndDatestring

The last date the recurring payment is collected. Format is yyyy-mm-dd.

Format
date
Example
"2025-12-01"
Descriptionstring

The text from the description on the recurring payment.

Example
"Monthly subscription payment"
SourceConnectorstring

The source of the recurring payment data.

Example
"PaymentHub"
SalesforceFieldsobject (SalesforceFields)

The SalesforceFields block is used to pass Salesforce fields and values that have been created on the object in Salesforce. To find out which Salesforce Fields have been configured, check the 'Object Manager' in the Salesforce Setup.

Example
{ "cpm__any_findock_or_package_field__c": "Lorem Ipsum Dolor sit amet", "any_custom_object_link__c": "7010Y000000dDSQ" }
get

Retrieve recurring payment details

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 record to query.

Example
"a083X00001aU MCnQAO"

Responses

Response examples

API was called successfully.

{
  "Url": "/services/data/v62.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",
  "Id": "a0V3X00000S7BuCUAV",
  "GUID": "sdfasdf-asfads-242134-adsfadf-23423",
  "Amount": 10.0,
  "CurrencyISOCode": "EUR",
  "Frequency": "Monthly",
  "RecordTypeName": "Subscription",
  "StartDate": "2025-01-01",
  "EndDate": "2025-12-01",
  "Description": "Monthly subscription payment",
  "SourceConnector": "PaymentHub",
  "SalesforceFields": {
    "cpm__any_findock_or_package_field__c": "Lorem Ipsum Dolor sit amet",
    "any_custom_object_link__c": "7010Y000000dDSQ"
  }
}

Was this page helpful?