Node Object Details
Node Schema
Key | Type | Required | Description |
| String | N.A. Included in API response. | Primary Key of the node object. |
| String | Depends. Only required if you are trying to verify micro-deposit or close a node. | The current allowed permissions of the node object. Go to Possible Allowed Values to learn more. |
| String | Depends. Only required if you are trying to close a node. | The reason for the current allowed value. Go to Possible Allowed Status Codes to learn more. |
| Boolean | Only required when trying to unindex a node. | If |
| String | N.A. Included in API response. | The Primary Key that denotes your client object in our system. |
| String | N.A. Included in API response. | Your common name in our system. |
| String | Only required when you are trying to register a loan rejection in our system. | This value stores the loan rejection reasons. Go to Possible Loan Rejection Reasons to learn more. |
| String | No | You can use this field to store the Primary Key of this object in your system. |
| Number | N.A. Included in API response. | Unix timestamp (in ms) value of when the timeline object was created. |
| String | N.A. Included in API response. | Human readable notes associated with the timeline object. |
| Object | Some values Yes. | Go to Info Schema to learn more. |
| Number | No | Charges the user a loan origination fee. Is added as part of the APR and requires a |
Possible Loan Rejection Reasons
Reason | Description | Set By |
| Income insufficient for amount of credit requested. | You |
| Cash flow information is insufficient. | You |
| Unable to verify income. | You |
| Length of account is too short with you. | You |
| Loan rejected because the amount in their checking account is lower than the amount of their first installment. | You |
| They have reached the maximum number of loans that can be offered at one time. This is defined in your spec sheet. Go to Intro to Spec Sheets to learn more. | Us |
| The amount requested is higher than what can be offered. This is defined in your spec sheet. Go to Intro to Spec Sheets to learn more. | Us |
| Wrong loan type being requested. This is defined in your spec sheet. Go to Intro to Spec Sheets to learn more. | Us |
| KYC is not finished on the user. Please finish KYC and try again. | Us |
| Loan rejected because the amount in your checkings account is lower than the amount of your first installment. | You |
| This loan is intended to help you pay down your debt, and we have determined your approved loan amount is insufficient to cover your debts at this point in time. | You |
| Your request for a loan was not able to be processed because we were unable to validate your identity with the details and credentials provided. | You |
Possible Allowed Values
Allowed | Description | Next Steps |
| Funds can be debited or credited from this node. | No action required. |
| Funds can only be sent to this node. No Debits allowed. | If this node is ACH-US, next step could be micro-deposit verification. If not, no action required. This is the final allowed permission. For example, in instances of a check, you can only send money to it, cannot debit from a check node. |
| Funds can only be debited from this node. No Credits allowed. | This is a common allowed value for Interchange nodes in instances where push to card has not been enabled my the issuer of the card. If the user wishes to push to card, ask the user to link another card. |
| Currently the node is not active and is unable to transact. | Currently only used for One-time Credit Accounts. These nodes are set to |
| The node has been locked. | If this is set by you, please ensure that a proper allowed status code has been supplied with it. Go to Possible Allowed Status Codes to learn more. Please ensure that the end user has been notified of this change. |
| Loan request was rejected. | Currently used for credit accounts, this code denotes that the loan request was rejected. This can be done by you when calling |
Possible Allowed Status Codes
Allowed Status Code | Description | Next Steps |
| User requested the allowed status change. | No action required. |
| Issuer of the node requested status change. Mostly used when an ACH or Interchange account needs to be locked for suspicious activity or invalid details. | Please ensure that the end user has been notified of this outcome. |
| Since the user account was being closed, the node was closed as well. | Please ensure that the end user has been notified of this outcome. |
| Since the user account was bing locked, the node was locked as well. | Please ensure that the end user has been notified of this outcome. |
| Allowed status change reason unknown. | No next steps recommend here since legacy tag. |
Info Schema
The node resource is used to create or link various types of liquidity accounts to the user. The purpose of this is to allow you to easily interface and build with deposit, credit or payment. For that reason, various types of nodes have various types of information avaliable inside the info
object.
Info Schema of Deposit Object
Key | Type | Required | Description |
| String | Yes | Common name you wish to assign to the node. Eg. "Default Checking Account". |
| Number | N.A. Included in API response | Balance held in the deposit node. |
| String | N.A. Included in API response | Currency of the deposit node. |
| Integer | N.A. Included in API response | If the deposit node has withdrawal restrictions, this value will denote how many more withdrawals are allowed. This value resets every month. |
| String | Yes | ID of the base document who is the primary owner of this node. |
| String | N.A. Included in API response | Code of the bank where this account resides. Since we have multiple partner banks, this code can vary based on the bank partner where this account was opened. |
| String | N.A. Included in API response | Type of agreement attached on the node. Go to Possible Agreement Types to learn more. |
| String | N.A. Included in API response | The PDF URL of the appropriate agreement. Each agreement contains the IP, Timestamp and Device Fingerprint of the user at the time of node creation. |
Info Schema of IC-DEPOSIT-US and IB-DEPOSIT-US
Key | Type | Required | Description |
---|---|---|---|
| Number | N.A. Included in API response | Daily interest accrual of interest (accumulator). Will zero out on the following month after interest rate payout to the user. |
Info Schema of Cash Management Account Object
Key | Type | Required | |
| String | N.A. Included in API response | Type of agreement attached on the node. Go to Possible Agreement Types to learn more. |
| String | N.A. Included in API response | The PDF URL of the appropriate agreement. Each agreement contains the IP, Timestamp and Device Fingerprint of the user at the time of node creation. |
| String | N.A. Included in API response | Code of the bank where all the processing for this account will happen. Since we have multiple partner banks, this code can vary. |
| String | N.A. Included in API response | ID of the base document who is the primary owner of this node. |
| String | N.A. Included in API response | Code of the bank where this account resides. Since we have multiple partner banks, this code can vary based on the bank partner where this account was opened. |
| String | Yes | Custody values include: |
| String | Yes | Risk values include: |
| Object | N.A. Included in API response | Object containing the balances in the CMA account. The key is the accounts currency and the value is the amount of funds per currency. Eg. for USD, the key-value pair would be |
Info Schema of Revolving Credit Object
Key | Type | Required | Description |
| String | Yes | Common name you wish to assign to the node. Eg. "Default Credit Account". |
| Number | N.A. Included in API response | Current Balance owed by the user on this credit node. |
| String | N.A. Included in API response | Currency of the credit node. |
| Number | Yes | Max credit extended to the user. |
| String | Yes | Currency of the credit node. |
| Number | Yes | Current APR rate in %. |
| Number | Yes | Max interest owed by the user in appropriate currency. |
| Number | N.A. Included in API response | Interest accrued so far. |
| Number | No | Charges the user a loan origination fee. Is added as part of the APR and requires a |
| String | N.A. Included in API response | Type of agreement attached on the node. Go to Possible Agreement Types to learn more. |
| String | N.A. Included in API response | The PDF URL of the appropriate agreement. Each agreement contains the IP, Timestamp and Device Fingerprint of the user at the time of node creation. |
| String | Yes | ID of the base document who is the primary owner of this node. |
| String | Yes. | Payment schedule associated with the credit node. Currently only |
| String | N.A. Included in API response | Code of the bank where all the processing for this account will happen. Since we have multiple partner banks, this code can vary. |
| String | No | If the resolving loan is intended to be a secured loan. Reserve Node ID can be used to supply the ID of the collateral/reserve account associated with the secured loan. |
| Integer | No | If the only is partially secured, supplying this value will require only upto the supplied value split in the |
Info Schema of Open Credit Object
Key | Type | Required | Description |
| String | Yes | Common name you wish to assign to the node. Eg. "Default Credit Account". |
| Number | N.A. Included in API response. | Current Balance owed by the user on this credit node. |
| String | N.A. Included in API response. | Currency of the credit node. |
| Number | Yes | Current APR rate in %. |
| Number | Yes | Max interest owed by the user in appropriate currency. |
| Number | Yes | Interest accrued so far. |
| String | N.A. Included in API response. | Type of agreement attached on the node. Go to Possible Agreement Types to learn more. |
| String | N.A. Included in API response. | The PDF URL of the appropriate agreement. Each agreement contains the IP, Timestamp and Device Fingerprint of the user at the time of node creation. |
| String | Yes | ID of the base document who is the primary owner of this node. |
| String | Yes | Payment schedule associated with the credit node. Currently only |
| String | N.A. Included in API response. | Code of the bank where all the processing for this account will happen. Since we have multiple partner banks, this code can vary. |
| String | Yes | ID of the collateral/reserve account associated with the open loan. |
Info Schema of One-Time Credit Object
Key | Type | Required | Description |
| String | Yes | Common name you wish to assign to the node. Eg. "Default Credit Account". |
| String | N.A. Included in API response. | Current Balance owed by the user on this credit node. |
| String | N.A. Included in API response. | Currency of the credit node. |
| Number | Yes | Max credit extended to the user. |
| String | Yes | Currency of the credit node. |
| Number | Yes | Current APR rate in %. |
| Number | Yes | Max interest owed by the user in appropriate currency. |
| Number | N.A. Included in API response. | Interest accrued so far. |
| String | N.A. Included in API response. | Type of agreement attached on the node. Go to Possible Agreement Types to learn more. |
| String | N.A. Included in API response. | The PDF URL of the appropriate agreement. Each agreement contains the IP, Timestamp and Device Fingerprint of the user at the time of node creation. |
| Boolean | No | If |
| String | No | Node ID where the repayment would come from when |
| String | Yes | Node ID where the loan should be disbursed. |
| String | Yes | ID of the base document who is the primary owner of this node. |
| String | Yes | Payment schedule associated with the credit node. Currently only |
| Number | Yes | Unix timestamp (in ms) value of when the next payment is due. When creating the loan, you need to supply an int value of how many days from today the next payment should happen. NOTE: |
| Integer | Yes | Number of installments to break the repayment into. |
| Number | N.A. Included in API response. | Amount due for the installment. |
| Number | N.A. Included in API response. | Unix timestamp (in ms) value of when the installment payment is due. |
| String | N.A. Included in API response. | Code of the bank where all the processing for this account will happen. Since we have multiple partner banks, this code can vary. |
| String | No | ID of the collateral/reserve account associated with the open loan. |
| Integer | No | If the only is partially secured, supplying this value will require only upto the supplied value split in the |
Info Schema of ACH Object
Key | Type | Required | Description |
| String | Yes | Common name you wish to assign to the node. Eg. "BofA Checking Account". |
| String | Yes | Account number of the bank account. |
| String | Yes | Routing number of the bank account. |
| Array of Strings | N.A. Included in API response. | Returns possible speeds at which payments can be sent to this account.
Possible values are In all cases, when |
| String | N.A. Included in API response. | If bank account is liked with our account aggregation feature, here you can see if email listed on the bank account is a match with the email on the base document. Possible values: |
| String | N.A. Included in API response. | If bank account is liked with our account aggregation feature, here you can see if email listed on the bank account is a match with the phone on the base document. Possible values: |
| String | N.A. Included in API response. | If bank account is liked with our account aggregation feature, here you can see if email listed on the bank account is a match with the name on the base document. Possible values: |
| String | Yes if not through our account aggregation feature. | Type of ACH account. Possible values: |
| String | Yes if link not happening through our account aggregation feature. | Class of ACH account. Possible Values: |
| String | N.A. Included in API response. | Name of bank. |
| String | N.A. Included in API response. | Full name of the bank. In most cased |
| String | N.A. Included in API response. | Logo of the bank. |
| String | N.A. Included in API response. | Non-normalized address of the bank. |
| String | Yes if link happening through our account aggregation feature. | Bank code used by us to denote this bank. |
| String | N.A. Included in API response. | Horizontal orientation friendly logo of the bank. |
| String | N.A. Included in API response. | URL of the banks's website. |
| String | N.A. Included in API response. | Address city of the bank's primary location. |
| String | N.A. Included in API response. | ISO Alpha-2 formatted Address country code of the bank's primary location. |
| String | N.A. Included in API response. | Address zip/postal code of the bank's primary location. |
| String | N.A. Included in API response. | Address street of the bank's primary location. |
| String | N.A. Included in API response. | Address subdivision (state) of the bank's primary location. |
Info Schema of Interchange Object
Key | Type | Required | Description |
| String | Yes | Common name you wish to assign to the node. Eg. "BofA Debit Card". |
| String | Yes | ID of the base document who is the primary owner of this node. |
| String | N.A. Included in API response. | Hash of the card details. This value can help you identify if the same card is being linked again and again throughout your platform. |
| String | Yes. Not in response. | Encrypted card number. Go to Encryption Keys for Interchange. |
| String | Yes. Not in response. | Encrypted expiration date in YYYYMM format. Go to Encryption Keys for Interchange. |
| Boolean | N.A. Included in API response. | If the card is a non-US based card. |
| String | N.A. Included in API response. | Card's primary network. Possible values: |
| String | N.A. Included in API response. | Type of card. Possible values: |
Encryption Keys for Interchange
Please use PKCS1_v1_5
padding to encrypt your data.
Info Schema of RPPS Object
Key | Type | Required | Description |
| String | Yes | Common name you wish to assign to the node. Eg. "Comcast Account". |
| String | Yes | Encrypted account number. Go to Encryption Keys for RPPS. |
| String | Yes | ID of the biller. |
Encryption Keys for RPPS
Please use PKCS1_v1_5
padding to encrypt your data.
Info Schema of Check Object
Key | Type | Required | Description |
| String | Yes | Common name you wish to assign to the node. Eg. "Rent Check". |
| String | Yes | Name of the individual or business who will be receiving the check |
| String | Yes | Address street of the payee. |
| String | Yes | Address city of the payee. |
| String | Yes | Address subdivision (state) of the payee. |
| String | Yes | ISO Alpha-2 formatted Address country code of the payee. |
| String | Yes | Address zip/postal code of the payee. |
Info Schema of FedWire (WIRE-US) Object
Key | Type | Required | Description |
| String | Yes | Common name you wish to assign to the node. Eg. "Chase Checking Account". |
| String | Yes | Account number of the bank account. |
| String | Yes | Routing number of the bank account. |
| String | N.A. Included in API response. | Name of bank. |
| String | N.A. Included in API response. | Full name of the bank. In most cased |
| String | N.A. Included in API response. | Logo of the bank. |
| String | N.A. Included in API response. | Non-normalized address of the bank. |
| String | N.A. Included in API response. | Bank code used by us to denote this bank. |
| String | N.A. Included in API response. | Horizontal orientation friendly logo of the bank. |
| String | N.A. Included in API response. | URL of the banks's website. |
| String | N.A. Included in API response. | Address city of the bank's primary location. |
| String | N.A. Included in API response. | ISO Alpha-2 formatted Address country code of the bank's primary location. |
| String | N.A. Included in API response. | Address zip/postal code of the bank's primary location. |
| String | N.A. Included in API response. | Address street of the bank's primary location. |
| String | N.A. Included in API response. | Address subdivision (state) of the bank's primary location. |
| String | No | Routing number of the correspondent bank. |
| String | No | Name of the correspondent bank. |
| String | No | Address of the correspondent bank. |
Info Schema of SWIFT Wire (WIRE-INT) Object
Key | Type | Required | Description |
| String | Yes | Common name you wish to assign to the node. Eg. "HSBC Checking Account". |
| String | Yes | Account number of the bank account. NOTE: some countries require the account number to be in IBAN format. Please contact Synapse for a full list of countries that require IBAN account numbers. |
| String | Yes | Routing number of the bank account in SWIFT format. |
| String | N.A. Included in API response. | Name of bank. |
| String | N.A. Included in API response. | Full name of the bank. In most cased |
| String | N.A. Included in API response. | Logo of the bank. |
| String | N.A. Included in API response. | Non-normalized address of the bank. |
| String | N.A. Included in API response. | Bank code used by us to denote this bank. |
| String | N.A. Included in API response. | Horizontal orientation friendly logo of the bank. |
| String | N.A. Included in API response. | URL of the banks's website. |
| String | N.A. Included in API response. | Address city of the bank's primary location. |
| String | N.A. Included in API response. | ISO Alpha-2 formatted Address country code of the bank's primary location. |
| String | N.A. Included in API response. | Address zip/postal code of the bank's primary location. |
| String | N.A. Included in API response. | Address street of the bank's primary location. |
| String | Included in API response. | Address subdivision (state / province) of the bank's primary location. Required for banks in Canada (CA). |
| String | No | Routing number of the correspondent bank. |
| String | No | Name of the correspondent bank. |
| String | No | Address of the correspondent bank. |
| String | No | State branch of the bank. Only needed for banks in |
| String | No | Branch code of the bank. Only needed for banks in |
| String | No | Branch name of the bank. Only needed for banks in |
| INT (18) | No | CLABE number of the bank. Only needed for banks in |
| String | No | Routing number of the bank. Only needed for banks in |
| String | No | Tax or Government ID number of the recipient. Required for some countries. |
Possible Agreement Types
Type | Description |
| Agreement associated with node creation. This is the agreement that was presented to the user before the node was created. Please ensure that the end user has access to a copy of this agreement. |
| Only used in case of Credit Accounts, this is an aversion action notice. Go to Possible Loan Rejection Reasons to learn more. Please ensure that the end user has been notified of this outcome. |
| Only used in case of Credit Accounts in instances when a credit account is terminated. Please ensure that the end user has been notified of this outcome. |
Last updated