• Payment API

Installment

The /Installment endpoint allows you to retrieve detailed information about an existing Installment, the FinDock equivalent of a one-time payment intent. Payment records in FinDock represent actual cash flow, so a single installment can have one or more related payments made with the same or different processors and payment methods.

One-time payment intents created through the Payment API become installments. These and all other installments installments created through other channels can be queried through the /Installment endpoint.

The response includes a list of all Payment records (cash movements) related to the queried installment.

Installment object schema

Idstring

The Salesforce record Id of the installment.

Example
"a083X00001aUMCnQAO"
GUIDstring

The Salesforce GUID of the installment.

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

The Salesforce URL of the installment.

Example
"/services/data/36.0/sobjects/a083X00001aUMCnQAO"
Typestring

The Salesforce object type.

Example
"cpm__Installment__c"
Statusstring

The status of the installment. For more information, see installment status and counters.

Enum
  • Cancelled
  • Collected
  • Failed
  • New
  • Outstanding
  • Paid
  • Pending
  • Partially paid
  • Pending Processing
  • Pending recollection
  • Refunded
  • Rejected
  • Reversed
Example
"Collected"
Amountnumber

The amount collected or disbursed.

Example
10.0
AmountOpennumber

The amount still to be collected, initial amount minus any already paid amounts.

Example
0.0
Targetstring

The name of the target, a bank account or PSP merchant account, specified for the installment.

Example
"PRIMARY-BANK-ACCOUNT"
RecordTypeNamestring

The RecordType of the installment, e.g. Receivable for incoming payment and Payable for outgoing payments.

Example
"Receivable"
PayUrlstring

URL that can be used to pay this installment. This can be a PayLinks or Tikkie URL.

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

The slug for the PayLink URL if multiple PayLinks pages are configured in the org.

Example
"pageAbcSlug"
PaymentProcessorstring

The name of the payment processor.

Example
"PaymentHub-SEPA"
PaymentMethodstring

The name of the payment method, e.g. Direct Debit, CreditCard or Ideal.

Example
"Direct Debit"
PaymentIntentIdstring

The Payment Intent Id. Can also be found on the Inbound Report record in Salesforce.

Example
"pi_1hubybk7nh45rvbt6"
Paymentsobject (Payment)

A cash movement related to an installment in Salesforce.

get

Retrieve installment details

This endpoint returns detailed information, including status and related Payment records, of an Installment record in Salesforce.

IDstring

required

The record Id or GUID of the installment to query.

Example
"a083X00001aUMCnQAO"

Responses

Response examples

API was called successfully.

{
  "Id": "a083X00001aUMCnQAO",
  "GUID": "sdfasdf-asfads-242134-adsfadf-23423",
  "Url": "/services/data/36.0/sobjects/a083X00001aUMCnQAO",
  "Type": "cpm__Installment__c",
  "Status": "Collected",
  "Amount": 10.0,
  "AmountOpen": 0.0,
  "Target": "PRIMARY-BANK-ACCOUNT",
  "RecordTypeName": "Receivable",
  "PayUrl": "https://link.dev.findock.com/pay/3xxxxmuai2/8897b4da-e48a-7ff3-90dd-ecb65094802c",
  "PayLinkPage": "pageAbcSlug",
  "PaymentProcessor": "PaymentHub-SEPA",
  "PaymentMethod": "Direct Debit",
  "PaymentIntentId": "pi_1hubybk7nh45rvbt6",
  "Payments": {
    "Id": "a0R3X00000V20tbUAB",
    "Url": "/services/data/v62.0/sobjects/cpm__Payment__c/a0R3X00000V20tbUAB",
    "Type": "cpm__Payment__c",
    "Target": "PRIMARY-BANK-ACCOUNT",
    "PaymentProcessor": "PaymentHub-SEPA",
    "PaymentMethod": "Direct Debit",
    "CollectionDate": "2020-12-10",
    "Amount": 10.0
  }
}

Was this page helpful?