Update Node
patch
https://api.synapsefi.com
/v3.1/users/:user_id/nodes/:node_id
Node
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

HTTP
cURL
Python
JS
PHP
GO
1
PATCH /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd91504cb0fca4d508af942 HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
7
{
8
"allowed":"LOCKED",
9
"allowed_status_code":"USER_REQUESTED"
10
}
Copied!
1
curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd91504cb0fca4d508af942' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
"allowed":"LOCKED",
7
"allowed_status_code":"USER_REQUESTED"
8
}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!

Credit Account Specific Examples

Following are a few Credit specific update node examples:

Change Payment Node

HTTP
cURL
Python
JS
PHP
GO
1
PATCH /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd906e520b3aa0bc5caee71 HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
7
{
8
"payment_node_id":"5fd91504cb0fca4d508af942"
9
}
Copied!
1
curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd906e520b3aa0bc5caee71' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
"payment_node_id":"5fd91504cb0fca4d508af942"
7
}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!

Change Next Payment Date

HTTP
cURL
Python
JS
PHP
GO
1
PATCH /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd906e520b3aa0bc5caee71 HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
7
{
8
"next_payment":14
9
}
Copied!
1
curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd906e520b3aa0bc5caee71' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
"next_payment":14
7
}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!

Toggle Autopay

HTTP
cURL
Python
JS
PHP
Ruby
GO
1
PATCH /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd906e520b3aa0bc5caee71 HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
7
{
8
"auto_pay":false
9
}
Copied!
1
curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd906e520b3aa0bc5caee71' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
"auto_pay":false
7
}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
Copied!
1
//
Copied!

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
1
PATCH /v3.1/users/5bee5a51b68b62009b5ba59a/nodes/5bee5a89b95dfb00bfdc0a1b HTTP/1.1
2
Host: https://uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_Td0nZBoqL6zghUyaAjsPuNYV8wQICH7OGbFRMf2m|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
7
{
8
"allowed":"INACTIVE"
9
"allowed_status_code": "ACCOUNT_CLOSED"
10
}
Copied!
1
loan_id = "5bee11e7bab47500bc84a552"
2
body = {
3
"next_payment":100
4
}
5
6
user.update_node(loan_id, body)
Copied!
1
const loanNodeID = "5bee11e7bab47500bc84a552";
2
const body = {
3
"next_payment":100
4
};
5
6
user.updateNode(loanNodeID, body);
Copied!
1
$nodeid = '5bee11e7bab47500bc84a552';
2
$body = (object)[
3
"next_payment" => 100
4
];
5
$user->update_node($nodeid, $body);
Copied!
1
loan_id = "5bee11e7bab47500bc84a552"
2
body = {
3
"next_payment":100
4
}
5
6
user.update_node(node_id: loan_id, payload: body)
Copied!
1
nodeID := "5bee11e7bab47500bc84a552"
2
body := `{
3
"next_payment":100
4
}`
5
6
data, err := user.UpdateNode(nodeID, body)
Copied!

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
1
PATCH /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd91504cb0fca4d508af942 HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
7
{
8
"micro":[0.1,0.1]
9
}
Copied!
1
curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd91504cb0fca4d508af942' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json'
5
--data-raw '{
6
"micro":[0.1,0.1]
7
}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!

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
1
PATCH /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd91504cb0fca4d508af942?resend_micro=YES HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
7
{}
Copied!
1
curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd91504cb0fca4d508af942?resend_micro=YES' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!

Reauth Node

After Reauthorizing the ACH-US transaction node's status to CREDITand 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
1
PATCH /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd91504cb0fca4d508af942?reauth=YES HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
7
{}
Copied!
1
curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd91504cb0fca4d508af942?reauth=YES' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_isTNxF03CIy0btQDHzlhG82Owm4uonfVUjE9SpPe|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
Last modified 1mo ago