Account Link
An account link object represents the relationship between two accounts.
These two accounts must belong to the same customer.
The behavior of the relationship is dictated by the linkTypeCode
and related settings.
A given account can be the source or target for exactly 1 link of each unique linkTypeCode
.
accountLink Object
Represents a relationship between two accounts in CorePro.
details
Property | Data Type (length) |
Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
customerId |
integer | The customerId property from the customer object. |
|||||||||
sourceAccountId |
integer | The accountId property from the account object representing the source of the link. |
|||||||||
targetAccountId |
integer | The accountId property from the account object representing the target of the link. |
|||||||||
linkTypeCode |
string (20) |
The type of link sourceAccountId has to targetAccountId .
Possible values include:
|
|||||||||
linkOptionTypeCode |
string (20) |
The type of option associated with the link
When
When
|
|||||||||
isDebitAutoTransferEnabled |
boolean |
This flag allows toggling the behavior (on/off) as described by the linkTypeCode and linkOptionTypeCode upon a debit occurring against the source account.Defaults to false if not specified.
|
|||||||||
debitSetting |
decimal |
The setting to apply based on the rules driven linkTypeCode and linkOptionTypeCode values.
|
|||||||||
isCreditAutoTransferEnabled |
boolean |
This flag allows toggling the behavior (on/off) as described by the linkTypeCode and linkOptionTypeCode upon a credit occurring against the source account.Defaults to false if not specified.
|
|||||||||
creditSetting |
decimal |
The setting to apply based on the rules driven linkTypeCode and linkOptionTypeCode values.
|
Applicable Routes
All routes pertaining to accountLink
objects hang off the account
object. Specifically: