Create Node

Status Changelog Dashboard Create a Ticket
Search…
Create Node
post
https://api.synapsefi.com
/v3.1/users/:user_id/nodes
Node
Go to Node Object Details to see all the required and optional body parameters allowed during node creation. Following are a few examples of various nodes and how to create them:
Create Deposit Account
We require that you first generate a preview of the node agreement, display it to the user to get their consent and then create the account. To generate a preview, add "preview_only":true to the payload.
HTTP
cURL
Python
JS
PHP
GO
1
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_WFecuSPqxGgU027IRAjtOf35vrNCpQZE1DYohX9y|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
​
7
{
8
  "type": "DEPOSIT-US",
9
  "info": {
10
    "nickname":"My Deposit Account",
11
    "document_id":"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
12
  }
13
}
Copied!
1
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_WFecuSPqxGgU027IRAjtOf35vrNCpQZE1DYohX9y|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json'
5
--data-raw '{
6
  "type": "DEPOSIT-US",
7
  "info": {
8
    "nickname":"My Deposit Account",
9
    "document_id":"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
10
  }
11
}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
Create Cash Management Account 
We require that you first generate a preview of the node agreement, display it to the user to get their consent and then create the account. To generate a preview, add "preview_only":true to the payload.
HTTP
cURL
Python
JS
PHP
GO
1
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_WFecuSPqxGgU027IRAjtOf35vrNCpQZE1DYohX9y|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
​
7
{
8
  "type": "CMA",
9
  "info": {
10
    "nickname":"My Cash Management Account",
11
    "document_id":"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
12
    "custody" : "FDIC",
13
    "risk" : "MODERATE"
14
  }
15
}
Copied!
1
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_WFecuSPqxGgU027IRAjtOf35vrNCpQZE1DYohX9y|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json'
5
--data-raw '{
6
  "type": "DEPOSIT-US",
7
  "info": {
8
    "nickname":"My Deposit Account",
9
    "document_id":"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
10
    "custody" : "FDIC",
11
    "risk" : "MODERATE"
12
  }
13
}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
Create Credit Account
There are four types of credit accounts -- Repay, One-Time, Open and Revolving. Following are examples of opening all four:
Create Repay Account
We require that you first generate a preview of the node agreement, display it to the user to get their consent and then create the account. To generate a preview, add "preview_only":true to the payload.
HTTP
cURL
Python
JS
PHP
GO
1
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
​
7
{
8
    "type": "REPAY-US",
9
    "info": {
10
        "loan_type": "ONE-TIME",
11
        "nickname": "My Loan",
12
        "credit_limit": {
13
            "amount": 5.2,
14
            "currency": "USD"
15
        },
16
        "interest": {
17
            "apr": 10,
18
            "cap": 5
19
        },
20
        "payment_node_id": "5fd7e2b0039b95223d5f4fd3",
21
        "disbursement_node_id": "5fd7e2b0039b95223d5f4fd3",
22
        "auto_pay": true,
23
        "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
24
        "schedule": "MONTHLY",
25
        "next_payment": 30,
26
        "num_payments": 1,
27
        "reserve_node_id": "5fd901bb20b3aa0bc7caee85"
28
    },
29
    "extra": {
30
        "supp_id": "xx123c"
31
    }
32
}
Copied!
1
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_WFecuSPqxGgU027IRAjtOf35vrNCpQZE1DYohX9y|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
    "type": "REPAY-US",
7
    "info": {
8
        "loan_type": "ONE-TIME",
9
        "nickname": "My Loan",
10
        "credit_limit": {
11
            "amount": 5.2,
12
            "currency": "USD"
13
        },
14
        "interest": {
15
            "apr": 10,
16
            "cap": 5
17
        },
18
        "payment_node_id": "5fd7e2b0039b95223d5f4fd3",
19
        "disbursement_node_id": "5fd7e2b0039b95223d5f4fd3",
20
        "auto_pay": true,
21
        "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
22
        "schedule": "MONTHLY",
23
        "next_payment": 30,
24
        "num_payments": 1,
25
        "reserve_node_id": "5fd901bb20b3aa0bc7caee85"
26
    },
27
    "extra": {
28
        "supp_id": "xx123c"
29
    }
30
}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
Create One-Time Credit Account
We require that you first generate a preview of the node agreement, display it to the user to get their consent and then create the account. To generate a preview, add "preview_only":true to the payload.
HTTP
cURL
Python
JS
PHP
GO
1
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
Cookie: __cfduid=de9ca185b34253012e30046d93e73cef91605826497
7
Content-Length: 730
8
​
9
{
10
    "type": "LOAN-US",
11
    "info": {
12
        "loan_type": "ONE-TIME",
13
        "nickname": "My Loan",
14
        "credit_limit": {
15
            "amount": 5.2,
16
            "currency": "USD"
17
        },
18
        "interest": {
19
            "apr": 10,
20
            "cap": 5
21
        },
22
        "payment_node_id": "5fd7e2b0039b95223d5f4fd3",
23
        "disbursement_node_id": "5fd7e2b0039b95223d5f4fd3",
24
        "auto_pay": true,
25
        "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
26
        "schedule": "MONTHLY",
27
        "next_payment": 30,
28
        "num_payments": 10,
29
        "reserve_node_id": "5fd901bb20b3aa0bc7caee85"
30
    },
31
    "extra": {
32
        "supp_id": "xx123c"
33
    }
34
}
Copied!
1
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_WFecuSPqxGgU027IRAjtOf35vrNCpQZE1DYohX9y|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
    "type": "LOAN-US",
7
    "info": {
8
        "loan_type": "ONE-TIME",
9
        "nickname": "My Loan",
10
        "credit_limit": {
11
            "amount": 5.2,
12
            "currency": "USD"
13
        },
14
        "interest": {
15
            "apr": 10,
16
            "cap": 5
17
        },
18
        "payment_node_id": "5fd7e2b0039b95223d5f4fd3",
19
        "disbursement_node_id": "5fd7e2b0039b95223d5f4fd3",
20
        "auto_pay": true,
21
        "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
22
        "schedule": "MONTHLY",
23
        "next_payment": 30,
24
        "num_payments": 10,
25
        "reserve_node_id": "5fd901bb20b3aa0bc7caee85"
26
    },
27
    "extra": {
28
        "supp_id": "xx123c"
29
    }
30
}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
Create Open Credit Account
We require that you first generate a preview of the node agreement, display it to the user to get their consent and then create the account. To generate a preview, add "preview_only":true to the payload.
HTTP
cURL
Python
JS
PHP
GO
1
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
​
7
{
8
    "type": "LOAN-US",
9
    "info": {
10
        "loan_type": "OPEN",
11
        "nickname": "My Loan",
12
        "interest": {
13
            "apr": 10,
14
            "cap": 5
15
        },
16
        "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
17
        "reserve_node_id": "5fd901bb20b3aa0bc7caee85",
18
        "schedule":"MONTHLY"
19
    },
20
    "extra": {
21
        "supp_id": "xx123c"
22
    }
23
}
Copied!
1
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
    "type": "LOAN-US",
7
    "info": {
8
        "loan_type": "OPEN",
9
        "nickname": "My Loan",
10
        "interest": {
11
            "apr": 10,
12
            "cap": 5
13
        },
14
        "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
15
        "reserve_node_id": "5fd901bb20b3aa0bc7caee85",
16
        "schedule":"MONTHLY"
17
    },
18
    "extra": {
19
        "supp_id": "xx123c"
20
    }
21
}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
Create Revolving Credit Account
We require that you first generate a preview of the node agreement, display it to the user to get their consent and then create the account. To generate a preview, add "preview_only":true to the payload.
HTTP
cURL
Python
JS
PHP
GO
1
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
​
7
{
8
    "type": "LOAN-US",
9
    "info": {
10
        "loan_type": "REVOLVING",
11
        "nickname": "My Loan",
12
        "credit_limit": {
13
            "amount": 50.2,
14
            "currency": "USD"
15
        },
16
        "interest": {
17
            "apr": 10,
18
            "cap": 5
19
        },
20
        "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
21
        "schedule": "MONTHLY",
22
        "reserve_node_id": "5fd901bb20b3aa0bc7caee85"
23
    },
24
    "extra": {
25
        "supp_id": "xx123c"
26
    }
27
}
Copied!
1
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json' \
5
--header 'Cookie: __cfduid=de9ca185b34253012e30046d93e73cef91605826497' \
6
--data-raw '{
7
    "type": "LOAN-US",
8
    "info": {
9
        "loan_type": "REVOLVING",
10
        "nickname": "My Loan",
11
        "credit_limit": {
12
            "amount": 50.2,
13
            "currency": "USD"
14
        },
15
        "interest": {
16
            "apr": 10,
17
            "cap": 5
18
        },
19
        "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
20
        "schedule": "MONTHLY",
21
        "reserve_node_id": "5fd901bb20b3aa0bc7caee85"
22
    },
23
    "extra": {
24
        "supp_id": "xx123c"
25
    }
26
}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
Booking an Adverse Action
In some instances, you will need to book Adverse Actions in our system. Here is an example of how to do that:
HTTP
cURL
Python
JS
PHP
GO
1
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
​
7
{
8
    "type": "LOAN-US",
9
    "info": {
10
        "loan_type": "REVOLVING",
11
        "nickname": "My Loan",
12
        "credit_limit": {
13
            "amount": 500.2,
14
            "currency": "USD"
15
        },
16
        "interest": {
17
            "apr": 10,
18
            "cap": 5
19
        },
20
        "payment_node_id": "5fd7e2b0039b95223d5f4fd3",
21
        "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
22
        "schedule": "MONTHLY",
23
        "next_payment": 30,
24
        "num_payments": 10,
25
        "reserve_node_id": "5fd901bb20b3aa0bc7caee85"
26
    },
27
    "extra": {
28
        "supp_id": "xx123c",
29
        "note": "ACCOUNT|TOOSHORT"
30
    },
31
    "allowed": "REJECTED"
32
}
Copied!
1
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json' \
5
--header 'Cookie: __cfduid=de9ca185b34253012e30046d93e73cef91605826497' \
6
--data-raw '{
7
    "type": "LOAN-US",
8
    "info": {
9
        "loan_type": "REVOLVING",
10
        "nickname": "My Loan",
11
        "credit_limit": {
12
            "amount": 500.2,
13
            "currency": "USD"
14
        },
15
        "interest": {
16
            "apr": 10,
17
            "cap": 5
18
        },
19
        "payment_node_id": "5fd7e2b0039b95223d5f4fd3",
20
        "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
21
        "schedule": "MONTHLY",
22
        "next_payment": 30,
23
        "num_payments": 10,
24
        "reserve_node_id": "5fd901bb20b3aa0bc7caee85"
25
    },
26
    "extra": {
27
        "supp_id": "xx123c",
28
        "note": "ACCOUNT|TOOSHORT"
29
    },
30
    "allowed": "REJECTED"
31
}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
Create Crypto Account
We require that you first generate a preview of the node agreement, display it to the user to get their consent and then create the account. To generate a preview, add "preview_only":true to the payload.
HTTP
cURL
Python
JS
PHP
GO
1
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
​
7
{
8
    "type": "CRYPTO-US",
9
    "info": {
10
        "nickname": "My CRYPTO 2",
11
        "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
12
    }
13
}
Copied!
1
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
    "preview_only": true,
7
    "type": "CRYPTO-US",
8
    "info": {
9
        "nickname": "My CRYPTO 2",
10
        "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
11
    }
12
}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
Create ACH Account
There are three ways to link an ACH account with us:
Method #1: Link via Account/Routing Number
May require micro-deposit verification if indicated in your spec sheet.
HTTP
cURL
1
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
​
7
{
8
  "type": "ACH-US",
9
  "info": {
10
    "nickname": "Fake Account",
11
    "account_num": "12322134",
12
    "routing_num": "051000017",
13
    "type": "PERSONAL",
14
    "class": "CHECKING"
15
  }
16
}
Copied!
1
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
  "type": "ACH-US",
7
  "info": {
8
    "nickname": "Fake Account",
9
    "account_num": "12322134",
10
    "routing_num": "051000017",
11
    "type": "PERSONAL",
12
    "class": "CHECKING"
13
  }
14
}'
Copied!
Method #2: Link via Account Aggregation (using Synapse's Chatbot)
To link an ACH account using the customer's bank login credentials, use our Chatbot.

Method #3: Link via Account Aggregation (with a 3rd Party Vendor)
To link an ACH account using a 3rd party vendor, supply data from the 3rd party vendor in the following format. Please note that you will require 3 months minimum of the user's transaction data in order to skip micro-deposits. Please designate negative values with "debit" : true/false (boolean).
HTTP
cURL
1
POST /v3.1/users/61281718f8db933279d02c3a/nodes HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_1rmOEzWCiwXG09Z7tefxY3AhKRQTaqDUMBpJPIV4|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
Content-Length: 1831
7
​
8
{
9
  "type": "ACH-US",
10
  "info": {
11
    "nickname": "Fake Account",
12
    "account_num": "1232225674134",
13
    "routing_num": "051000017",
14
    "type": "PERSONAL",
15
    "class": "CHECKING"
16
  },
17
  "extra": {
18
    "supp_id": "pJPM4LMBNQFrOwp0jqEyTwyxJQrQbgU6kq37k",
19
    "other": {
20
      "info": {
21
        "phone_numbers": [
22
          "1112223456",
23
          "1234567891"
24
        ],
25
        "addresses": [
26
          {
27
            "street": "1 Hobbit Way",
28
            "city": "The Shire",
29
            "state": "CA",
30
            "zipcode": "94108"
31
          }
32
        ],
33
        "names": [
34
          "Frodo Baggins",
35
          "Samwise Gamgee"
36
        ],
37
        "emails": [
38
          "[email protected]"
39
        ]
40
      },
41
      "transactions": [
42
        {
43
          "current_balance": 2275.58,
44
          "description": "Apple Store",
45
          "amount": 2307.15,
46
          "date": 1403506800,
47
          "pending": false,
48
          "debit": true
49
        },
50
        {
51
          "current_balance": 2275.58,
52
          "description": "Golden Crepes",
53
          "amount": 12.74,
54
          "date": 1399878000,
55
          "pending": false,
56
          "debit": true
57
        },
58
        {
59
          "current_balance": 2275.58,
60
          "description": "Banana Republic",
61
          "amount": 118.23,
62
          "date": 1398495600,
63
          "pending": false,
64
          "debit": true
65
        },
66
        {
67
          "current_balance": 2275.58,
68
          "description": "Octane Coffee Bar and Lounge",
69
          "amount": 5.32,
70
          "date": 1397718000,
71
          "pending": false,
72
          "debit": true
73
        },
74
        {
75
          "current_balance": 2275.58,
76
          "description": "Papa Johns Pizza",
77
          "amount": 28.57,
78
          "date": 1397199600,
79
          "pending": false,
80
          "debit": true
81
        }
82
      ]
83
    }
84
  }
85
}
Copied!
1
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/61281718f8db933279d02c3a/nodes' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_1rmOEzWCiwXG09Z7tefxY3AhKRQTaqDUMBpJPIV4|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
  "type": "ACH-US",
7
  "info": {
8
    "nickname": "Fake Account",
9
    "account_num": "1232225674134",
10
    "routing_num": "051000017",
11
    "type": "PERSONAL",
12
    "class": "CHECKING"
13
  },
14
  "extra": {
15
    "supp_id": "pJPM4LMBNQFrOwp0jqEyTwyxJQrQbgU6kq37k",
16
    "other": {
17
      "info": {
18
        "phone_numbers": [
19
          "1112223456",
20
          "1234567891"
21
        ],
22
        "addresses": [
23
          {
24
            "street": "1 Hobbit Way",
25
            "city": "The Shire",
26
            "state": "CA",
27
            "zipcode": "94108"
28
          }
29
        ],
30
        "names": [
31
          "Frodo Baggins",
32
          "Samwise Gamgee"
33
        ],
34
        "emails": [
35
          "[email protected]"
36
        ]
37
      },
38
      "transactions": [
39
        {
40
          "current_balance": 2275.58,
41
          "description": "Apple Store",
42
          "amount": 2307.15,
43
          "date": 1403506800,
44
          "pending": false,
45
          "debit": true
46
        },
47
        {
48
          "current_balance": 2275.58,
49
          "description": "Golden Crepes",
50
          "amount": 12.74,
51
          "date": 1399878000,
52
          "pending": false,
53
          "debit": true
54
        },
55
        {
56
          "current_balance": 2275.58,
57
          "description": "Banana Republic",
58
          "amount": 118.23,
59
          "date": 1398495600,
60
          "pending": false,
61
          "debit": true
62
        },
63
        {
64
          "current_balance": 2275.58,
65
          "description": "Octane Coffee Bar and Lounge",
66
          "amount": 5.32,
67
          "date": 1397718000,
68
          "pending": false,
69
          "debit": true
70
        },
71
        {
72
          "current_balance": 2275.58,
73
          "description": "Papa Johns Pizza",
74
          "amount": 28.57,
75
          "date": 1397199600,
76
          "pending": false,
77
          "debit": true
78
        }
79
      ]
80
    }
81
  }
82
}'
Copied!
Create Interchange Account
In the following example the card number and expiration date are encrypted. Go to Encryption Keys for Interchange to learn more.
HTTP
cURL
Python
JS
PHP
GO
1
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
​
7
{
8
  "type": "INTERCHANGE-US",
9
  "info": {
10
    "nickname": "My BofA Card",
11
    "card_number": "UvW1n0FaSDjS/4h/u79hf7QF1pG6VuRMlSvoro5SDEt28YMkPaUJIVSBvIPSilFKYRX+jUw+nE0X7QxR/ZWAiLnkJHPo1R1KlolVBCvWefandgyBqc+8nmUw2gDqNV5XoOmUbraHIhhp3YxpBtlqljIcQvLyY6lnZij/UknLwU+QWltLkb4ppvOA1njwWHJWl795VoCsVHCab9gcU6dALH4xwIvezY9JXImQOsNQusT6OeagjDhjbTy/jfuu5aVOB+WqheW2r7TLR3Z0SAZsCm5vL0NjgP0Bi8dY9aZDsydEcqTQSn8+hLmdwnIoIw58xWHoIPFa3NfhCMPiPWyXzw==",
12
    "exp_date": "btnU+/L6NxZyd5dyl4BXK6raVMAp4ATGxST9KYN6KSOvY5IyfeKXfbwK5qCGk5071Tt0jst1yJShQNbSi4I+gUABmSTEZoBit13CT8C1uiRyT4sj8RhkMnyw/88eHIS5BKUXWib3wsfCxYac1Uq7lSdhReU1DHh8CoknDJt0GCFO1duxS0qLgrvB6WqkTgLQfYsRAZUDUO8O7sTUgGyoWdbu4CHoK1w+NJOQi3hWF5D90X60vaZaOxyEo4OljBZ6oAPiMf+L9IG58ADjsRm81TTwfhfzMObNRed+MEiDVzn7keR+0vniRzp1BPHO2aTxKKauhmZsRaWViIDah/tIbw==",
13
    "document_id": "6753aae40deb54eadee3d8272e6e1777337d34d52f71655c774a894fe3f6a1e0"
14
  }
15
}
Copied!
1
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
  "type": "INTERCHANGE-US",
7
  "info": {
8
    "nickname": "My BofA Card",
9
    "card_number": "Zoo8g2vBUjt7TwmEpRW8f6eQT3AOEEYePw2LkoxD+mO9lOT5OemHlGwgamgLGUbrmWu3DPwnEr2IqDy5YMFVgvQWP3w9nLOFzFFSW43auDgsVAqZScoRf8nI+6/B9KvOEV4XI8JeyXT+O+y3p3RtbiXGmYQNJ56Hy3hs2E5O+yn+3fpLfJQpVvNc38V+aE21VEsJuXFFNtS/8r4jJ6Dx/etTEaE/rtcEUEbwLLHFHjPiOWaHWZPuhXFLtyYrR9zG8FWSJVFwNTG/mEpv2O7We1iCB+9WoEKqdHyGwjjBcVgkUlU5huJIXv9xj53RGNvmHkDFTqgrlHpKkb0E/Ot0Zg==",
10
    "exp_date": "ctA4Zj1CP0WCiMefPYsyewVbIHNilfwA09X9NSCyWxft4WGwFZmZkhsBJh51QL751/iFkUHbd09ZpDYjS86PqyNPZ5LkBueGHDIghLwWyzH1l99RiIs8urOW9c4g3L1USD+kzzRAqG1DBkW47FAX6AhPSi3YgQd94ery1H+asaqDrP79ayzoJ+nRXeEqe83FIgNUk/J5+EcAz3JYnoBmp1sfz7a4zHkvk0eKCxQWLETdqvONyCZyXdC/4CkaCxJ/87VsN3i4+ToULtSluRv8xr1NpRhzipKiEKTYW1nvNDAaJQezTVP/+GxmTmQfnfpVNDpJbXjNrOTej1HgMFpg4w==",
11
    "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
12
  }
13
}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
Create Wire Account
HTTP
cURL
Python
JS
PHP
GO
1
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
​
7
{
8
  "type": "WIRE-US",
9
  "info":{
10
      "nickname": "Some Account",
11
      "account_num": "1235674342",
12
      "routing_num": "026009593"
13
    }
14
}
Copied!
1
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
  "type": "WIRE-US",
7
  "info":{
8
      "nickname": "Some Account",
9
      "account_num": "1235674342",
10
      "routing_num": "026009593"
11
    }
12
}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
Create SWIFT Account
HTTP
cURL
Python
JS
PHP
GO
1
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
​
7
{
8
    "type": "WIRE-INT",
9
    "info": {
10
        "nickname": "Some Account",
11
        "account_num": "1235674342",
12
        "swift": "CCBPFRPPXXX"
13
    }
14
}
Copied!
1
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
    "type": "WIRE-INT",
7
    "info": {
8
        "nickname": "Some Account",
9
        "account_num": "1235674342",
10
        "swift": "CCBPFRPPXXX"
11
    }
12
}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
Create RPPS Account
In the following example the account number is encrypted. Go to Encryption Keys for RPPS to learn more.
Also go to View Billers to learn how to get biller_id.
HTTP
cURL
Python
JS
PHP
GO
1
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
​
7
{
8
    "type": "RPPS-US",
9
    "info": {
10
        "nickname": "Fake Account",
11
        "account_num": "ihvwKkb0RrsRSqlOJo3xXCTX7hADg2eA+dN3nSVoFsulhypfDlFLoVrdM0I4T/7rX0ZPj7IdlHDUmkGFm/PwQ9Of/FDzg74h/hdIpS48KNAJR31ZZaGecTpL8AOYDM0oCWS2bnowOG+2pPNP7aa63d4DK5I+uzK9y95eIvWrcnM6GM9dYUFm2pIvW1WrXr2qVr+WpjRUSbfLAky0cNzvg3CQsjusLZfA3W2c7QKJjL4ICBRvzwLhb90m2U3uFGiS3xCdYy+tcXtEK1KZfvAq6Ic+Gxe//jDIOl/vQSW/aVxFA5Lz/wCf4zmFCB2HYKvg4wYAeXgyufaZZDwb6r/duQ==",
12
        "biller_id": "0311001621"
13
    }
14
}
Copied!
1
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
    "type": "RPPS-US",
7
    "info": {
8
        "nickname": "Fake Account",
9
        "account_num": "ihvwKkb0RrsRSqlOJo3xXCTX7hADg2eA+dN3nSVoFsulhypfDlFLoVrdM0I4T/7rX0ZPj7IdlHDUmkGFm/PwQ9Of/FDzg74h/hdIpS48KNAJR31ZZaGecTpL8AOYDM0oCWS2bnowOG+2pPNP7aa63d4DK5I+uzK9y95eIvWrcnM6GM9dYUFm2pIvW1WrXr2qVr+WpjRUSbfLAky0cNzvg3CQsjusLZfA3W2c7QKJjL4ICBRvzwLhb90m2U3uFGiS3xCdYy+tcXtEK1KZfvAq6Ic+Gxe//jDIOl/vQSW/aVxFA5Lz/wCf4zmFCB2HYKvg4wYAeXgyufaZZDwb6r/duQ==",
10
        "biller_id": "0311001621"
11
    }
12
}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
Create Check Account
HTTP
cURL
Python
JS
PHP
GO
1
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-USER-IP: 255.127.79.76
4
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
5
Content-Type: application/json
6
​
7
{
8
  "type": "CHECK-US",
9
  "info":{
10
      "nickname":"Rent",
11
      "payee_name":"Some Name",
12
      "payee_address":{
13
      	"address_street":"1 Market St",
14
      	"address_city":"San Francisco",
15
      	"address_subdivision":"CA",
16
      	"address_country_code":"US",
17
      	"address_postal_code":"94105"
18
      }
19
  }
20
}
Copied!
1
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
2
--header 'X-SP-USER-IP: 255.127.79.76' \
3
--header 'X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
  "type": "CHECK-US",
7
  "info":{
8
      "nickname":"Rent",
9
      "payee_name":"Some Name",
10
      "payee_address":{
11
      	"address_street":"1 Market St",
12
      	"address_city":"San Francisco",
13
      	"address_subdivision":"CA",
14
      	"address_country_code":"US",
15
      	"address_postal_code":"94105"
16
      }
17
  }
18
}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
View Node
Update Node
Last modified 1mo ago
Export as PDF
Copy link
Contents
post
Node
Create Deposit Account
Create Cash Management Account
Create Credit Account
Create Crypto Account
Create ACH Account
Create Interchange Account