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.

get/Installment/{ID}

Get installment details

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

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/63.0/sobjects/cpm__Installment__c/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": "DirectDebit",
  "PaymentIntentId": "pi_1hubybk7nh45rvbt6",
  "Payments": {
    "Id": "a0R3X00000V20tbUAB",
    "Url": "/services/data/v63.0/sobjects/cpm__Payment__c/a0R3X00000V20tbUAB",
    "Type": "cpm__Payment__c",
    "Target": "PRIMARY-BANK-ACCOUNT",
    "PaymentProcessor": "PaymentHub-SEPA",
    "PaymentMethod": "DirectDebit",
    "CollectionDate": "2025-02-03",
    "Amount": 25.0
  }
}

Was this page helpful?