Create Node

post
Node

https://api.synapsefi.com/v3.1/users/:user_id/nodes
This endpoint allows you to create a node.
Request
Response
Request
Path Parameters
user_id
required
string
ID of the user.
Headers
X-SP-USER
required
string
User's OAuth key and device fingerprint, separated by a pipe.
X-SP-USER-IP
required
string
IP address of user's device.
X-SP-GATEWAY
optional
string
Your Client ID and Secret, separated by a pipe.
Response
200: OK
User Successfully Created.
{
"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
}
400: Bad Request
Request Failing.
{
"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 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
HTTP
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_WFecuSPqxGgU027IRAjtOf35vrNCpQZE1DYohX9y|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
{
"type": "DEPOSIT-US",
"info": {
"nickname":"My Deposit Account",
"document_id":"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
}
}
cURL
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_WFecuSPqxGgU027IRAjtOf35vrNCpQZE1DYohX9y|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json'
--data-raw '{
"type": "DEPOSIT-US",
"info": {
"nickname":"My Deposit Account",
"document_id":"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
}
}'
Python
//
JS
//
PHP
//
GO
//

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
HTTP
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
{
"type": "REPAY-US",
"info": {
"loan_type": "ONE-TIME",
"nickname": "My Loan",
"credit_limit": {
"amount": 5.2,
"currency": "USD"
},
"interest": {
"apr": 10,
"cap": 5
},
"payment_node_id": "5fd7e2b0039b95223d5f4fd3",
"disbursement_node_id": "5fd7e2b0039b95223d5f4fd3",
"auto_pay": true,
"document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
"schedule": "MONTHLY",
"next_payment": 30,
"num_payments": 1,
"reserve_node_id": "5fd901bb20b3aa0bc7caee85"
},
"extra": {
"supp_id": "xx123c"
}
}
cURL
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_WFecuSPqxGgU027IRAjtOf35vrNCpQZE1DYohX9y|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "REPAY-US",
"info": {
"loan_type": "ONE-TIME",
"nickname": "My Loan",
"credit_limit": {
"amount": 5.2,
"currency": "USD"
},
"interest": {
"apr": 10,
"cap": 5
},
"payment_node_id": "5fd7e2b0039b95223d5f4fd3",
"disbursement_node_id": "5fd7e2b0039b95223d5f4fd3",
"auto_pay": true,
"document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
"schedule": "MONTHLY",
"next_payment": 30,
"num_payments": 1,
"reserve_node_id": "5fd901bb20b3aa0bc7caee85"
},
"extra": {
"supp_id": "xx123c"
}
}'
Python
//
JS
//
PHP
//
GO
//

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
HTTP
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
Cookie: __cfduid=de9ca185b34253012e30046d93e73cef91605826497
Content-Length: 730
{
"type": "LOAN-US",
"info": {
"loan_type": "ONE-TIME",
"nickname": "My Loan",
"credit_limit": {
"amount": 5.2,
"currency": "USD"
},
"interest": {
"apr": 10,
"cap": 5
},
"payment_node_id": "5fd7e2b0039b95223d5f4fd3",
"disbursement_node_id": "5fd7e2b0039b95223d5f4fd3",
"auto_pay": true,
"document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
"schedule": "MONTHLY",
"next_payment": 30,
"num_payments": 10,
"reserve_node_id": "5fd901bb20b3aa0bc7caee85"
},
"extra": {
"supp_id": "xx123c"
}
}
cURL
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_WFecuSPqxGgU027IRAjtOf35vrNCpQZE1DYohX9y|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "LOAN-US",
"info": {
"loan_type": "ONE-TIME",
"nickname": "My Loan",
"credit_limit": {
"amount": 5.2,
"currency": "USD"
},
"interest": {
"apr": 10,
"cap": 5
},
"payment_node_id": "5fd7e2b0039b95223d5f4fd3",
"disbursement_node_id": "5fd7e2b0039b95223d5f4fd3",
"auto_pay": true,
"document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
"schedule": "MONTHLY",
"next_payment": 30,
"num_payments": 10,
"reserve_node_id": "5fd901bb20b3aa0bc7caee85"
},
"extra": {
"supp_id": "xx123c"
}
}'
Python
//
JS
//
PHP
//
GO
//

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
HTTP
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
{
"type": "LOAN-US",
"info": {
"loan_type": "OPEN",
"nickname": "My Loan",
"interest": {
"apr": 10,
"cap": 5
},
"document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
"reserve_node_id": "5fd901bb20b3aa0bc7caee85",
"schedule":"MONTHLY"
},
"extra": {
"supp_id": "xx123c"
}
}
cURL
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "LOAN-US",
"info": {
"loan_type": "OPEN",
"nickname": "My Loan",
"interest": {
"apr": 10,
"cap": 5
},
"document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
"reserve_node_id": "5fd901bb20b3aa0bc7caee85",
"schedule":"MONTHLY"
},
"extra": {
"supp_id": "xx123c"
}
}'
Python
//
JS
//
PHP
//
GO
//

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
HTTP
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
{
"type": "LOAN-US",
"info": {
"loan_type": "REVOLVING",
"nickname": "My Loan",
"credit_limit": {
"amount": 50.2,
"currency": "USD"
},
"interest": {
"apr": 10,
"cap": 5
},
"document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
"schedule": "MONTHLY",
"reserve_node_id": "5fd901bb20b3aa0bc7caee85"
},
"extra": {
"supp_id": "xx123c"
}
}
cURL
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--header 'Cookie: __cfduid=de9ca185b34253012e30046d93e73cef91605826497' \
--data-raw '{
"type": "LOAN-US",
"info": {
"loan_type": "REVOLVING",
"nickname": "My Loan",
"credit_limit": {
"amount": 50.2,
"currency": "USD"
},
"interest": {
"apr": 10,
"cap": 5
},
"document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
"schedule": "MONTHLY",
"reserve_node_id": "5fd901bb20b3aa0bc7caee85"
},
"extra": {
"supp_id": "xx123c"
}
}'
Python
//
JS
//
PHP
//
GO
//

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
HTTP
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
{
"type": "LOAN-US",
"info": {
"loan_type": "REVOLVING",
"nickname": "My Loan",
"credit_limit": {
"amount": 500.2,
"currency": "USD"
},
"interest": {
"apr": 10,
"cap": 5
},
"payment_node_id": "5fd7e2b0039b95223d5f4fd3",
"document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
"schedule": "MONTHLY",
"next_payment": 30,
"num_payments": 10,
"reserve_node_id": "5fd901bb20b3aa0bc7caee85"
},
"extra": {
"supp_id": "xx123c",
"note": "ACCOUNT|TOOSHORT"
},
"allowed": "REJECTED"
}
cURL
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--header 'Cookie: __cfduid=de9ca185b34253012e30046d93e73cef91605826497' \
--data-raw '{
"type": "LOAN-US",
"info": {
"loan_type": "REVOLVING",
"nickname": "My Loan",
"credit_limit": {
"amount": 500.2,
"currency": "USD"
},
"interest": {
"apr": 10,
"cap": 5
},
"payment_node_id": "5fd7e2b0039b95223d5f4fd3",
"document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
"schedule": "MONTHLY",
"next_payment": 30,
"num_payments": 10,
"reserve_node_id": "5fd901bb20b3aa0bc7caee85"
},
"extra": {
"supp_id": "xx123c",
"note": "ACCOUNT|TOOSHORT"
},
"allowed": "REJECTED"
}'
Python
//
JS
//
PHP
//
GO
//

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
HTTP
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
{
"type": "CRYPTO-US",
"info": {
"nickname": "My CRYPTO 2",
"document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
}
}
cURL
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
"preview_only": true,
"type": "CRYPTO-US",
"info": {
"nickname": "My CRYPTO 2",
"document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
}
}'
Python
//
JS
//
PHP
//
GO
//

Create ACH Account

There are two ways to link an ACH account with us. Either by supplying the account & routing numbers to us or by allowing your customers to link their ACH accounts using their login credentials. To learn more about the second option, go to Chatbot Product Guide. Following is the example of linking an ACH account with account & routing number:

HTTP
cURL
Python
JS
PHP
GO
HTTP
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
{
"type": "ACH-US",
"info": {
"nickname": "Fake Account",
"account_num": "12322134",
"routing_num": "051000017",
"type": "PERSONAL",
"class": "CHECKING"
}
}
cURL
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "ACH-US",
"info": {
"nickname": "Fake Account",
"account_num": "12322134",
"routing_num": "051000017",
"type": "PERSONAL",
"class": "CHECKING"
}
}'
Python
//
JS
//
PHP
//
GO
//

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
HTTP
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
{
"type": "INTERCHANGE-US",
"info": {
"nickname": "My BofA Card",
"card_number": "Zoo8g2vBUjt7TwmEpRW8f6eQT3AOEEYePw2LkoxD+mO9lOT5OemHlGwgamgLGUbrmWu3DPwnEr2IqDy5YMFVgvQWP3w9nLOFzFFSW43auDgsVAqZScoRf8nI+6/B9KvOEV4XI8JeyXT+O+y3p3RtbiXGmYQNJ56Hy3hs2E5O+yn+3fpLfJQpVvNc38V+aE21VEsJuXFFNtS/8r4jJ6Dx/etTEaE/rtcEUEbwLLHFHjPiOWaHWZPuhXFLtyYrR9zG8FWSJVFwNTG/mEpv2O7We1iCB+9WoEKqdHyGwjjBcVgkUlU5huJIXv9xj53RGNvmHkDFTqgrlHpKkb0E/Ot0Zg==",
"exp_date": "ctA4Zj1CP0WCiMefPYsyewVbIHNilfwA09X9NSCyWxft4WGwFZmZkhsBJh51QL751/iFkUHbd09ZpDYjS86PqyNPZ5LkBueGHDIghLwWyzH1l99RiIs8urOW9c4g3L1USD+kzzRAqG1DBkW47FAX6AhPSi3YgQd94ery1H+asaqDrP79ayzoJ+nRXeEqe83FIgNUk/J5+EcAz3JYnoBmp1sfz7a4zHkvk0eKCxQWLETdqvONyCZyXdC/4CkaCxJ/87VsN3i4+ToULtSluRv8xr1NpRhzipKiEKTYW1nvNDAaJQezTVP/+GxmTmQfnfpVNDpJbXjNrOTej1HgMFpg4w==",
"document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
}
}
cURL
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "INTERCHANGE-US",
"info": {
"nickname": "My BofA Card",
"card_number": "Zoo8g2vBUjt7TwmEpRW8f6eQT3AOEEYePw2LkoxD+mO9lOT5OemHlGwgamgLGUbrmWu3DPwnEr2IqDy5YMFVgvQWP3w9nLOFzFFSW43auDgsVAqZScoRf8nI+6/B9KvOEV4XI8JeyXT+O+y3p3RtbiXGmYQNJ56Hy3hs2E5O+yn+3fpLfJQpVvNc38V+aE21VEsJuXFFNtS/8r4jJ6Dx/etTEaE/rtcEUEbwLLHFHjPiOWaHWZPuhXFLtyYrR9zG8FWSJVFwNTG/mEpv2O7We1iCB+9WoEKqdHyGwjjBcVgkUlU5huJIXv9xj53RGNvmHkDFTqgrlHpKkb0E/Ot0Zg==",
"exp_date": "ctA4Zj1CP0WCiMefPYsyewVbIHNilfwA09X9NSCyWxft4WGwFZmZkhsBJh51QL751/iFkUHbd09ZpDYjS86PqyNPZ5LkBueGHDIghLwWyzH1l99RiIs8urOW9c4g3L1USD+kzzRAqG1DBkW47FAX6AhPSi3YgQd94ery1H+asaqDrP79ayzoJ+nRXeEqe83FIgNUk/J5+EcAz3JYnoBmp1sfz7a4zHkvk0eKCxQWLETdqvONyCZyXdC/4CkaCxJ/87VsN3i4+ToULtSluRv8xr1NpRhzipKiEKTYW1nvNDAaJQezTVP/+GxmTmQfnfpVNDpJbXjNrOTej1HgMFpg4w==",
"document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
}
}'
Python
//
JS
//
PHP
//
GO
//

Create Wire Account

HTTP
cURL
Python
JS
PHP
GO
HTTP
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
{
"type": "WIRE-US",
"info":{
"nickname": "Some Account",
"account_num": "1235674342",
"routing_num": "026009593"
}
}
cURL
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "WIRE-US",
"info":{
"nickname": "Some Account",
"account_num": "1235674342",
"routing_num": "026009593"
}
}'
Python
//
JS
//
PHP
//
GO
//

Create SWIFT Account

HTTP
cURL
Python
JS
PHP
GO
HTTP
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
{
"type": "WIRE-INT",
"info": {
"nickname": "Some Account",
"account_num": "1235674342",
"swift": "CCBPFRPPXXX"
}
}
cURL
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "WIRE-INT",
"info": {
"nickname": "Some Account",
"account_num": "1235674342",
"swift": "CCBPFRPPXXX"
}
}'
Python
//
JS
//
PHP
//
GO
//

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
HTTP
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
{
"type": "RPPS-US",
"info": {
"nickname": "Fake Account",
"account_num": "ihvwKkb0RrsRSqlOJo3xXCTX7hADg2eA+dN3nSVoFsulhypfDlFLoVrdM0I4T/7rX0ZPj7IdlHDUmkGFm/PwQ9Of/FDzg74h/hdIpS48KNAJR31ZZaGecTpL8AOYDM0oCWS2bnowOG+2pPNP7aa63d4DK5I+uzK9y95eIvWrcnM6GM9dYUFm2pIvW1WrXr2qVr+WpjRUSbfLAky0cNzvg3CQsjusLZfA3W2c7QKJjL4ICBRvzwLhb90m2U3uFGiS3xCdYy+tcXtEK1KZfvAq6Ic+Gxe//jDIOl/vQSW/aVxFA5Lz/wCf4zmFCB2HYKvg4wYAeXgyufaZZDwb6r/duQ==",
"biller_id": "0311001621"
}
}
cURL
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "RPPS-US",
"info": {
"nickname": "Fake Account",
"account_num": "ihvwKkb0RrsRSqlOJo3xXCTX7hADg2eA+dN3nSVoFsulhypfDlFLoVrdM0I4T/7rX0ZPj7IdlHDUmkGFm/PwQ9Of/FDzg74h/hdIpS48KNAJR31ZZaGecTpL8AOYDM0oCWS2bnowOG+2pPNP7aa63d4DK5I+uzK9y95eIvWrcnM6GM9dYUFm2pIvW1WrXr2qVr+WpjRUSbfLAky0cNzvg3CQsjusLZfA3W2c7QKJjL4ICBRvzwLhb90m2U3uFGiS3xCdYy+tcXtEK1KZfvAq6Ic+Gxe//jDIOl/vQSW/aVxFA5Lz/wCf4zmFCB2HYKvg4wYAeXgyufaZZDwb6r/duQ==",
"biller_id": "0311001621"
}
}'
Python
//
JS
//
PHP
//
GO
//

Create Check Account

HTTP
cURL
Python
JS
PHP
GO
HTTP
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
{
"type": "CHECK-US",
"info":{
"nickname":"Rent",
"payee_name":"Some Name",
"payee_address":{
"address_street":"1 Market St",
"address_city":"San Francisco",
"address_subdivision":"CA",
"address_country_code":"US",
"address_postal_code":"94105"
}
}
}
cURL
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_Bno93GavyeDfbzt0kpwmjZrQdS8IMUVH65AC21Og|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "CHECK-US",
"info":{
"nickname":"Rent",
"payee_name":"Some Name",
"payee_address":{
"address_street":"1 Market St",
"address_city":"San Francisco",
"address_subdivision":"CA",
"address_country_code":"US",
"address_postal_code":"94105"
}
}
}'
Python
//
JS
//
PHP
//
GO
//