FinDock Payment API (v2)

API reference specification. Last updated on 2026-06-22.

Objects, record types and fields

Salesforce objects (sObjects) are stored as records in the Salesforce database. These records are persistent representations of data. Some API resources accept, or even require, sObjects. The Payer block, for example, requires sObjects such as Contact and Account. The API allows you to define these objects in payloads. FinDock sObjects like Inbound Report can be included as well, but they require you to specify the object fields as Salesforce fields.

Record types let Salesforce administrators offer specific business processes, picklist values, and page layouts to different users. Organizations can, for example, differentiate between Account object records by assigning them an Organization or Household record type. This facilitates the application of different types of page layouts or possible field values based on what record type an Account is.

Fields are defined at the object level in Salesforce. Next to the out-of-the-box fields from Salesforce, custom fields can be added to objects. Use the Object Manager in Salesforce Setup to see available fields. Implementations of Salesforce can use different fields for a value like email.

Custom fields for standard Salesforce objects like Contact and Account are passed with "__c" at the end of the field name. In the example below, you see the standard fields FirstName and LastName and a custom field TwitterHandle for the Contact object.

Custom fields for custom FinDock objects like Installment and Recurring Payment can also be passed in a SalesforceFields object. SalesforceFields passed in the OneTime object are copied to the Installment record in Salesforce and SalesforceFields passed in the Recurring object are copied to the Recurring object in Salesforce. To which Recurring object the values are stored depends on the FinDock configuration.

Working with payer details

Salesforce provides two objects to define the Payer:

• Account: usually an organization
• Contact: an individual

Added to that simple split is Person Account, which stores information about individual people by combining certain Account and Contact fields into a single record. It is not its own object, but can be stored as an Account with a specific record type (see below).

Some features of Salesforce - like Fundraising used in NonProfit Cloud (NPC) - require Person Account. The payer details are a Person Account record rather than a Contact. Make sure to always check with your Salesforce admin whether they are enabled and used.

To send Person Account details to the Payment API, use an Account object with a RecordTypeName (API name) of the type Person Account. By default the API name is PersonAccount, but there can be customized or the org (Salesforce environment may have multiple Person Account record types. Always consult your Salesforce admin regarding record types.

Whether an Account or Contact record, you always need to take into consideration how the payer is deduplicated. Every organization has configured deduplication rules that define the information the payment intent message needs to include for deduplication, bearing in mind that the more data points you have, the more effective deduplication is.

For Person Accounts the following exceptions for (custom) field notations apply:

• Standard Account fields can be passed as regular fields: "BillingStreet":"Any Street".
• Custom Account fields can be passed with the regular __c suffix: "Custom_Street__c":"Any Street".
• Standard Contact fields need to be prefixed with Person, with the exception of FirstName, LastName, Salutation which are passed as regular fields: "PersonEmail" : "test@findock.com".
• Custom Contact fields need to be suffixed with __pc: "Custom_email__pc":"test@findock.com"

For the FinDock for Fundraising source connector used with NonProfit Cloud (NPC), for example, the following exception applies: Since the "Recurring" object (Gift Commitment) is split in two objects (Gift Commitment & Gift Commitment Schedule), a prefix GiftCommitment is required to set SalesforceFields on this object. Fields without prefix are assumed to be set on the Gift Commitment Schedule object. Example: GiftCommitment.GiftVehicle.

You can check which Source Connectors are available by performing a GET operation on the Source Connector endpoint.

Authentication

Authentication is accomplished through an Oauth2.0 authorization flow. Each Salesforce environment requires its own token. A refresh token can be used to acquire a new access token if the current token has expired. Read more on how to authenticate to Salesforce in the Salesforce developer guide. Both client_id and client_secret can be acquired from the Salesforce 'Setup' from a 'Connected App'.

• The Authorization token can be passed as a Bearer token in the request Header.
• To Acquire a new Authorization token with the returned Refresh token, please make sure to pass the right grant_type, client_id, client_secret and refresh_token as specified in the Salesforce documentation referenced above. To get up and running quickly, use the (unofficial-but-provided-by) Salesforce Postman Collection, as explained in this blog and look for the 'auth' folder.

Error and response codes

IF the API is not called successfully, you receive a HTTP Status Code 4xx or 500. A 422 code is returned when the message was well-formed, but could not be processed because of, for instance, wrong data. In the response you find additional information on how to prevent or handle the error through an array of Errors with an error_code and error_message, like in the following example.

Below are some of the possible error codes:

Webhook events and notifications

To receive updates on payments created with the /PaymentIntent endpoint:

• pass an endpoint URL in the WebhookURL parameter in the request body.
• add your URL to the Remote Site Setting of the Salesforce org.

FinDock sends you notifications for the following events around your API call:

No specific events are sent for recurring payments other than the paymentIntent which contains the Salesforce Id of the recurring record.

For more information about processing online payments, please Processing online payments.

For paymentIntent you receive notifications with the following body. Each event contains a type and a data object with further details. Check out the PaymentIntent object schema for definitions.

For installment you receive a notification with the following body.