If you are just starting to work with the API, please see:

• How the Payment API works
• Getting started with the Payment API
• How to use the Payment API

Since our API is created for Salesforce implementations, there are some Salesforce-specific things to take into account. Alongside the primitive datatypes such as String, the Payment API uses several datatypes that might be unknown to you if you are not familiar with Salesforce or the Force.com platform. The data types that are only applied in Salesforce contexts are Salesforce Objects (sObjects) and Record Types and fields.

sObjects

sObjects are objects that can be stored in the (Sales)Force.com platform database. They are representations of data that persists in the Salesforce database. Some API resources accept, or even require, sObjects. The Payer object, for example, requires sObjects such as Contact and Account. The API allows you to define these objects in requests, as shown below, where both a Contact and an Account sObject are defined. FinDock objects like PaymentProfile can be used in the same way, but require you to specify the fields as salesforce fields.

Example body of a request for creating a Contact and an Account sObject:

{
  "SuccessURL":"http://success.com",
  "FailureURL":"http://failure.com",
  "Payer":{
    "Contact":{
      "SalesforceFields":{
        "FirstName":"Eric",
        "LastName":"Johnson",
        "Email":"eric@johnson.com",
        "MailingStreet":"Rocket Rd",
        "MailingCity":"Hawthorne0",
        "MailingPostalCode":"CA 90250",
        "MobilePhone":"98989898"
      }
    },
    "Account":{
      "RecordTypeName: "Business",
      "SalesforceFields":{
        "Name":"Johnson Family",
        "Website":"www.spacex.com",
        "BillingStreet":"Rocket Rd",
        "BillingCity":"Hawthorne",
        "BillingPostalCode":"CA 90250"
      }
    }
  }
}

Record Types

Record types let Salesforce administrators offer different business processes, picklist values, and page layouts to different users. Organizations can, for example, differentiate between Account objects in Salesforce by assigning them either to the Record Type of Organization or Household. This facilitates the application of different types of page layouts or possible field values based on what Record Type an Account is. Your Salesforce Administrator can tell you more about the Record Types used in the Salesforce org.

Please note: when the Person Accounts feature is enabled in the environment Record Types are especially important. More information on Person Accounts can be found below.

Accounts, Contacts, Person Accounts

Salesforce provides two objects to indicate a Payer:

• Account: usually an organisation
• Contact: an individual

A Person Account 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 above). Some features of Salesforce - for instance Fundraising as used in a.o. NonProfit Cloud (NPC) - require an Account to be available. This means that when you have an individual payer you need to send a Person Account instead of a Contact. These features will only work with a Contact object when an Account object is also sent.

Make sure to always check with your Salesforce admin whether they are enabled and / or used!

To send Person Accounts to the FinDock API use an Account object with a RecordTypeName (API name) of a Record Type that is of the type Person Account. By default this is PersonAccount but there is a high chance this was customised or an environment has multiple Person Account Record Types, so always consult your Salesforce admin.

{
  "Account":{
    "RecordTypeName: "<a-person-account-record-type>",
    "SalesforceFields":{
      "Name":"Johnson Family",
      "Website":"www.spacex.com",
      "BillingStreet":"Rocket Rd",
      "BillingCity":"Hawthorne",
      "BillingPostalCode":"CA 90250"
    }
  }
}

Salesforce Fields

Next to the out-of-the-box Salesforce data model, Salesforce allows administrators to add custom fields to objects in Salesforce. All fields can be seen in the Salesforce Object Manager of the Salesforce org setup. Also, different implementations of Salesforce can use different fields for a value like email. The API allows you to send Salesforce fields, and their corresponding values, as attributes in requests to the API.

Custom fields for standard Salesforce objects like Contact and Account are passed with "__c" at the end. For illustration, we have added the standard fields FirstName and LastName and the custom field TwitterHandle to the Salesforce Contact object.

TwitterHandle | TwitterHandle__c | Text(50)

{
  "Payer":{
    "Contact":{
      "SalesforceFields":{
        "FirstName":"Eric",
        "LastName":"Johnson",
        "TwitterHandle__c": "@EricJohnsonSalesforce"
      }
    }          
  }
}

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. What Recurring object the values are stored to depends on whether you use a Source Connector.

{
  "OneTime":{
    "Amount": 10.0,
    "SalesforceFields": {
      "Sales_Invoice__c": "a506E0000009TfL"
    }
  }
}

Exceptions

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

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

The fields and their correct notations can be found in the Salesforce Setup > Object Manager for Account.

Example:

{
  "Account":{
    "RecordTypeName: "PersonAccount",
    "SalesforceFields":{
      "FirstName":"John",
      "LastName":"Johnson",
      "PersonEmail":"test@test.com",
      "Website":"www.spacex.com",
      "BillingStreet":"Rocket Rd",
      "Custom_account_field__c":"Rocket Rd",
      "Custom_contact_field__pc":"Don't forget the P"
    }
  }
}

For the FinDock for Fundraising Source Connector used in a.o. NonProfit Cloud (NPC), 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 in the environment by performing a GET operation on the Source Connector endpoint.

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.

When the API was not called successfully, you will receive a HTTP Status Code 4xx or 500. Specifically 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 will find additional information on how to prevent or handle the error through an array of Errors with an error_code and error_message.

Example of a successful request (to the SourceConnector Provisioning API):

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

Example of an error that is returned whenever an incorrect request is sent:

{
  "Errors": [
    {
      "error_message": "Amount can't be 0 or negative",
      "error_code": "020"
    }
  ]
}

Full list of possible response codes:

For more information on errors and response codes and debugging the API, please read our Troubleshooting the Payment API article.

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 environment.

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

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

For more information about the processing of online payments, please visit our Processing online payments article.

Webhook content

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

{
  "type": "paymentIntent.processed",
  "data": {
    "Status": "Matched",
    "Recurring": {
      "Url": "/services/data/v48.0/sobjects/cpm__Recurring_Payment__c/a0V3X00000S7b5YUAR",
      "Type": "cpm__Recurring_Payment__c",
      "Id": "a0V3X00000S7b5YUAR"
    },
    "Payer": {
      "Contact": {
        "Url": "/services/data/v48.0/sobjects/Contact/0033X00003H9uZPQAZ",
        "Type": "Contact",
        "Id": "0033X00003H9uZPQAZ",
        "Name": "Eric Johnson"
      },
      "Account": {
        "Url": "/services/data/v48.0/sobjects/Account/0013X00002bZPGIQA4",
        "Type": "Account",
        "Id": "0013X00002bZPGIQA4",
        "Name": "Johnson Family"
      }
    },
    "OneTime": {
      "Url": "/services/data/v48.0/sobjects/cpm__Installment__c/a083X00001mFTBAQA4",
      "Type": "cpm__Installment__c",
      "Id": "a083X00001mFTBAQA4",
      "Status": "Pending"
    },
    "Id": "pi_6cazikr7625yqt9mf"
  }
}

For installment you will receive a notification with the following body.

{
  "type": "installment",
  "data": {
    "Url": "/services/data/v48.0/sobjects/cpm__Installment__c/a083X00001kJynLQAS",
    "Type": "cpm__Installment__c",
    "Id": "a083X00001kJynLQAS",
    "Target": "Adyen1",
    "Status": "Collected",
    "RecordTypeName": "Receivable",
    "PayUrl": "https://link.dev.findock.com/pay/3xxxxmuai2/8897b4da-e48a-7ff3-90dd-ecb65094802c",
    "Payments": [
      {
        "Url": "/services/data/v48.0/sobjects/cpm__Payment__c/a0R3X00000V1sutUAB",
        "Type": "cpm__Payment__c",
        "Id": "a0R3X00000V1sutUAB",
        "PaymentProcessor": "PaymentHub-Adyen",
        "PaymentMethod": "CreditCard",
        "CollectionDate": "2020-11-26",
        "Amount": 15
      }
    ],
    "PaymentProcessor": "PaymentHub-Adyen",
    "PaymentMethod": "CreditCard",
    "PaymentIntentId": "pi_5jthokq7z8som0w6o",
    "AmountOpen": 0,
    "Amount": 15
  }
}

The /PaymentIntent endpoint allows for Payments to be initiated through a configured Salesforce environment and updates Salesforce data accordingly. The PaymentIntent API requires a Payment Method, Payment Processor and Source Connector to perform a successful request. The available Payment Method, Processors and Source Connectors for a specific Salesforce environment can be queried through their specific endpoints. Some Payment Methods enable or require further Package Actions. Be sure to include these in the request. It is also possible to perform Payments on existing Installments.

The /Installment endpoint allows you to retrieve detailed information on an Installment. Installments are the FinDock data-in-Salesforce equivalent of a One-time payment. All One-time payments created through the API become Installments, however Installments can also be created through other channels. These non-API Installments can also be queried through this endpoint. The response includes a list of all Payments (cash movements) that have been performed in relation to this Installment. An Installment can be collected through several payments with different processors and payment methods.

Informational resource that returns a list of all available and active payment methods, and the active processors that have those payment methods enabled. Payment Methods range from Direct Debit, to Credit Card and various Online payments through Payment Service Providers (PSPs).

Informational resource that returns the source connector used in a specific Salesforce environment. A source connector represents an application in Salesforce that will be used to ultimately store the transaction that is being initiated through the Payment API.

Informational resource that returns the package actions possible and/or required for a certain Salesforce environment. Package actions are additional actions that can be performed for a specific FinDock Extension, like a payment extension or source connector. Package Actions can be used to perform additional actions in Salesforce through FinDock while making a Payment Request, like creating a record.

If a Payment Methods or Source Connector has a Package Action, these can be found in the specific Extension or Source Connector documentation. The FinDock Gift Aid extension is an example of such a package.