get https://api.talkdeskapp.com/fsi/contacts//payments
Associated with a contact
Scope
fsi-payments:read
Body Response - Schema
200 (the payments list)
| Parameter | Type | Description | Required |
|---|---|---|---|
| _embedded | object | "_embedded" subdivides into: 1 - "payments" (array[object]) - list of payments in an account. 1.1 - "id" (string) - identification for a single payment. Required. 1.2 - "description" (string) - brief description for a payment. Required. 1.3 - "total_amount_due" (object) - total loan amount due balance - amount due on monthly statement. Required. 1.4 - "currency" (string) - the currency where the payment is due. Required. 1.5 - "due_at" (string) - the date when the payment will be due. Required. 1.6 - "status" (string) - allowed values: "OPEN", "CLOSED", "UNDEFINED", "PENDING", "PAID", "PAST_DUE", "UPCOMING". Required. 1.7 - "account_id" (string) - bank account. Required. 1.8 - "minimum_payment_due" (string) - minimum payment amount. Required. 1.9 - "due_fees_amount" (string) - fees charged for a past due pending payment. 1.10 - "type" (string) - Allowed values: "PERSONAL_LOAN", "MORTGAGE_LOAN", "AUTO_LOAN", "OTHER_LOAN", "CREDITCARD_BALANCE , "HOME_EQUITY_LOAN", "BUSINESS_LOAN", "STUDENT_LOAN", "BUSINESS_CREDIT_CARD", "STUDENT_CREDIT_CARD", "PERSONAL_CREDIT_CARD", "CREDIT_CARD". 1.11 - "custom_type" (string) - payment type customized by bank client. 1.12 - "custom_status" (string) - payment status customized by bank client. | yes |
| total | integer | the total number of payments in collection | yes |
400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
API Availability
The FSI Integrations API has been in General Availability since January 2023.
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.