Node
PATCH
https://api.synapsefi.com/v3.1/users/:user_id/nodes/:node_id
This endpoint allows you to create a node.
Path Parameters
Query Parameters
200 User Successfully Created. 400 Request Failing.
Copy {
"error_code" : "0" ,
"http_code" : "200" ,
"limit" : 20 ,
"node_count" : 1 ,
"nodes" : [
{
"_id" : "5fd7e43fe079bc3cc9c304fb" ,
"_links" : {
"self" : {
"href": "https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd7e43fe079bc3cc9c304fb"
}
} ,
"allowed" : "CREDIT-AND-DEBIT" ,
"allowed_status_code" : null ,
"client" : {
"id" : "589acd9ecb3cd400fa75ac06" ,
"name" : "SynapseFi"
} ,
"extra" : {
"note" : null ,
"other" : {} ,
"supp_id" : ""
} ,
"info" : {
"agreements" : [
{
"type" : "NODE_AGREEMENT" ,
"url": "https://cdn.synapsepay.com/uploads/2020/12/14/n9o0LrdMmBITYQRKXgWFUS76k24eDZ8EGz5yP0jfHtC1hqaxup.pdf"
}
] ,
"balance" : {
"amount" : 0.0 ,
"currency" : "USD"
} ,
"bank_code" : "EBT" ,
"document_id" : "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8" ,
"name_on_account" : " " ,
"nickname" : "My Deposit Account"
} ,
"is_active" : true ,
"timeline" : [
{
"date" : 1607984180124 ,
"note" : "Node created."
}
] ,
"type" : "DEPOSIT-US" ,
"user_id" : "5fd7acfd8677040053ad486d"
}
] ,
"page_count" : 1 ,
"success" : true
}
Copy {
"error" : {
"code" : "missing_client_credentials" ,
"en" : "Client credentials are missing from the request."
} ,
"error_code" : "200" ,
"http_code" : "400" ,
"success" : false
}
Go to Node Object Details to see all the required and optional body parameters allowed during node updates. Following are some examples of most common update calls:
Update Node Status
Go to Possible Allowed Values and Possible Allowed Status Codes to learn more.
HTTP cURL Python JS PHP GO
Copy PATCH /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd91504cb0fca4d508af942 HTTP / 1.1
Host : uat-api.synapsefi.com
X-SP-USER-IP : 255.127.79.76
X-SP-USER : oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type : application/json
{
"allowed" : "LOCKED" ,
"allowed_status_code" : "USER_REQUESTED"
}
Copy curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd91504cb0fca4d508af942' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
"allowed":"LOCKED",
"allowed_status_code":"USER_REQUESTED"
}'
Credit Account Specific Examples
Following are a few Credit specific update node examples:
Change Payment Node
HTTP cURL Python JS PHP GO
Copy PATCH /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd906e520b3aa0bc5caee71 HTTP / 1.1
Host : uat-api.synapsefi.com
X-SP-USER-IP : 255.127.79.76
X-SP-USER : oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type : application/json
{
"payment_node_id" : "5fd91504cb0fca4d508af942"
}
Copy curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd906e520b3aa0bc5caee71' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
"payment_node_id":"5fd91504cb0fca4d508af942"
}'
Change Next Payment Date
HTTP cURL Python JS PHP GO
Copy PATCH /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd906e520b3aa0bc5caee71 HTTP / 1.1
Host : uat-api.synapsefi.com
X-SP-USER-IP : 255.127.79.76
X-SP-USER : oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type : application/json
{
"next_payment" : 14
}
Copy curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd906e520b3aa0bc5caee71' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
"next_payment":14
}'
Toggle Autopay
HTTP cURL Python JS PHP Ruby GO
Copy PATCH /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd906e520b3aa0bc5caee71 HTTP / 1.1
Host : uat-api.synapsefi.com
X-SP-USER-IP : 255.127.79.76
X-SP-USER : oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type : application/json
{
"auto_pay" : false
}
Copy curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd906e520b3aa0bc5caee71' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
"auto_pay":false
}'
Terminate Revolving Loan
Please send the user their termination letter when terminating the loan. This can be found in the agreements
value of the response.
HTTP Python JavaScript PHP Ruby GO
Copy PATCH /v3.1/users/5bee5a51b68b62009b5ba59a/nodes/5bee5a89b95dfb00bfdc0a1b HTTP / 1.1
Host : https://uat-api.synapsefi.com
X-SP-USER-IP : 255.127.79.76
X-SP-USER : oauth_Td0nZBoqL6zghUyaAjsPuNYV8wQICH7OGbFRMf2m|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type : application/json
{
"allowed" : "INACTIVE"
"allowed_status_code" : "ACCOUNT_CLOSED"
}
Copy loan_id = "5bee11e7bab47500bc84a552"
body = {
"next_payment" : 100
}
user . update_node (loan_id, body)
Copy const loanNodeID = "5bee11e7bab47500bc84a552" ;
const body = {
"next_payment" : 100
};
user .updateNode (loanNodeID , body);
Copy $nodeid = '5bee11e7bab47500bc84a552' ;
$body = ( object )[
"next_payment" => 100
];
$user -> update_node ( $nodeid , $body ) ;
Copy loan_id = "5bee11e7bab47500bc84a552"
body = {
"next_payment" : 100
}
user . update_node(node_id: loan_id , payload: body)
Copy nodeID := "5bee11e7bab47500bc84a552"
body := `{
"next_payment":100
}`
data, err := user. UpdateNode (nodeID, body)
ACH Specific Examples
Following are a few ACH specific update node examples:
Verify Micro Deposits
Micro-deposits are automatically initiated when a bank account is linked with Account/Routing, assuming the user's KYC is complete Within 1-2 business days, the user will see two small transactions (less than $1 each) on their bank account statement. The user must return to your application and submit the two micro-deposit amounts in any order. If the amounts are correct, the node will receive CREDIT-AND-DEBIT
permissions.
HTTP cURL Python JS PHP GO
Copy PATCH /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd91504cb0fca4d508af942 HTTP / 1.1
Host : uat-api.synapsefi.com
X-SP-USER-IP : 255.127.79.76
X-SP-USER : oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type : application/json
{
"micro" : [ 0.1 , 0.1 ]
}
Copy curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd91504cb0fca4d508af942' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json'
--data-raw '{
"micro":[0.1,0.1]
}'
Resend Micro Deposits
Please note that we set a limit of 3 micro-deposit attempts per ACH node. Any attempts past this limit will return a max_microdeposits_sent
error.
HTTP cURL Python JS PHP GO
Copy PATCH /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd91504cb0fca4d508af942?resend_micro=YES HTTP / 1.1
Host : uat-api.synapsefi.com
X-SP-USER-IP : 255.127.79.76
X-SP-USER : oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type : application/json
{}
Copy curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd91504cb0fca4d508af942?resend_micro=YES' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{}'
Reauth Node
After Reauthorizing the ACH-US
transaction node's status to CREDIT
and micro-deposits will be sent automatically. You will then need re-verify micro-deposits to change the node's status to CREDIT-AND-DEBIT
.
HTTP cURL Python JS PHP GO
Copy PATCH /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd91504cb0fca4d508af942?reauth=YES HTTP / 1.1
Host : uat-api.synapsefi.com
X-SP-USER-IP : 255.127.79.76
X-SP-USER : oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type : application/json
{}
Copy curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd91504cb0fca4d508af942?reauth=YES' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{}'