Source Connectors

Informational resource endpoint that returns the source connector used in a specific Salesforce org. There is always a default source, but an org can have more than one source connector enabled.

The source connector determines which payment-related objects FinDock needs to create and update in Salesforce when an action is initiated through the Payment API.

The Source Connector object

Namestring

The name of the source connector that will be used to register recurring payments and amounts receivable in installments. e.g. 'PaymentHub', 'FinDock-for-NPSP' or 'FinDock-for-Fundraising'.

Example
"PaymentHub"
PrettyNamestring

The pretty name of the source package.

Example
"PaymentHub"
IsDefaultboolean

Whether this is the default source connector. If no source connector is passed in the request, this source connector is used.

Example
"true"
get

Retrieve Source Connectors.

Return a list of Source Connectors configured in the Salesforce environment.

Responses

Response examples

API was called successfully.

{
  "SourceConnectors": [
    {
      "PrettyName": "PaymentHub",
      "Name": "PaymentHub",
      "IsDefault": "true"
    }
  ]
}

Was this page helpful?