• Payment API

Installment

The /Installment endpoint allows you to retrieve detailed information on an Installment, the FinDock data-in-Salesforce equivalent of a one-time payment.

All one-time payments created through the API become installments. However, installments are also be created through other channels. These non-API installments can be queried through this endpoint.

The response includes a list of all Payment records (cash movements) that have been performed in relation to the queried installment. An installment can be collected through several payments with different processors and payment methods.

The Installment object

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
  • New
  • Partially paid
  • Failed
  • Pending recollection
  • Pending
  • Refunded
  • Cancelled
  • Outstanding
  • Rejected
  • Reversed
  • Collected
  • Pending Processing
  • Paid
Example
"Collected"
Amountnumber

The amount to be collected.

Example
10.0
AmountOpennumber

The amount that is still to be collected: represents initial amount subtracted by amount paid.

Example
0.0
Targetstring

The name of the target that has been configured in Salesforce. A target can be a bank account or a merchant account with a PSP.

Example
"PRIMARY-BANK-ACCOUNT"
RecordTypeNamestring

The Salesforce 'Installment' RecordType. e.g. 'Receivable' for positive and 'Payable' for negative amounts in a standard FinDock implementation.

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"
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"
Paymentsarray
get

Retrieve OneTime/Installment details

Returns detailed information - including status and underlying individual payments - of an Installment record in Salesforce. Installment records can be created by passing a OneTime object to the PaymentIntent endpoint.

IDstring

required

The record Id or GUID of the Installment to retrieve.

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",
  "PaymentProcessor": "PaymentHub-SEPA",
  "PaymentMethod": "Direct Debit",
  "PaymentIntentId": "pi_1hubybk7nh45rvbt6",
  "Payments": [
    {
      "Id": "a0R3X00000V20tbUAB",
      "Url": "/services/data/v48.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?