Add Check Recipient

Add a CHECK-US node with recipient's bill pay information

After you Create a User, OAuth the User and fund their Deposit Account, you are ready to add a check recipient. Each CHECK-US node you create represents a single check recipient. You’ll want to create a check for each person/entity you’d like to send payments to.

To add a payment recipient, all you need is their name and a valid mailing address where you’d like the check to be sent. Synapse will validate the address to confirm that the check is deliverable.

API ENDPOINT

https://uat-api.synapsefi.com/v3.1/users/:user_id/nodes

PATH PARAMETER

user_id :
required
string

The user ID of the user you wish to add the CHECK-US node under

BODY PARAMETER

type :
required
string

Type of node you wish to add

info.nickname :
required
string

Nickname for the node

extra.supp_id :
string

Any ID you wish to register to the node

extra.note :
string

Memo tagged with the node

is_active :
boolean

If the node is indexed or marked deleted.

info.payee_name :
required
string

Name of the payee

info.payee_address.address_street :
required
string

Address of the payee, this can be home address of a person or business address of a corp.

info.payee_address.address_city :
required
string

Address of the payee, this can be home address of a person or business address of a corp.

info.payee_address.address_subdivision :
required
string

Address of the payee, this can be home address of a person or business address of a corp.

info.payee_address.address_country_code :
required
string

Address of the payee, this can be home address of a person or business address of a corp.

info.payee_address.address_postal_code :
required
string

Address of the payee, this can be home address of a person or business address of a corp.

EXAMPLE REQUEST

POST /v3.1/users/594e0fa2838454002ea317a0/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_auVIbQ8WXC0pnLU9ivEs4tcHDejqFJlwoNrZ3fO1|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "type": "CHECK-US",
  "info":{
      "nickname":"My Cellphone Bill Checking",
      "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"
      }
  }
}
body = {
  "type": "CHECK-US",
  "info":{
      "nickname":"My Cellphone Bill Checking",
      "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"
      }
  }
}

user.create_node(body)
const body = {
  "type": "CHECK-US",
  "info":{
      "nickname":"My Cellphone Bill Checking",
      "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"
      }
  }
};

user.createNode(body);
body = {
  "type": "CHECK-US",
  "info":{
      "nickname":"My Cellphone Bill Checking",
      "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"
      }
  }
}

user.create_node(payload: body)
$payee_address = (object)[
   "Address_street" => "1 Market St",
     "Address_city" => "San Francisco",
     "Address_subdivision" => "CA",
     "Address_country_code" => "US",
     "Address_postal_code" => "94105"
];
$info= (object) [
   "nickname" => "My Cell Phone Bill Checking",
   "payee_name" => "Some Name",
   "payee_address" =>$payee_address
];
$body = (object) [
   'type' => 'CHECK-US',
   'info' => $info
];

$user->create_node($body);
body := `{
  type: “CHECK-US”,
  info: {
    "nickname":"My Checking",
      "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"
      }
  }
}`

data, err := user.CreateNode(body)

EXAMPLE RESPONSE

{
    "error_code": "0",
    "http_code": "200",
    "limit": 20,
    "node_count": 1,
    "nodes": [
        {
            "_id": "594e21fc4d1d62002f17e37d",
            "_links": {
                "self": {
                    "href": "https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0/nodes/594e21fc4d1d62002f17e37d"
                }
            },
            "allowed": "CREDIT",
            "client": {
                "id": "589acd9ecb3cd400fa75ac06",
                "name": "SynapseFI"
            },
            "extra": {
                "other": {},
                "supp_id": null,
                "note": null
            },
            "info": {
                "name_on_account": " ",
                "nickname": "My Cellphone Bill Checking",
                "payee_address": {
                    "address_city": "SAN FRANCISCO",
                    "address_country_code": "US",
                    "address_postal_code": "94105",
                    "address_street": "1 MARKET ST",
                    "address_subdivision": "CA"
                },
                "payee_name": "Some Name"
            },
            "is_active": true,
            "timeline": [
                {
                    "date": 1498292731835,
                    "note": "Node created."
                }
            ],
            "type": "CHECK-US",
            "user_id": "594e0fa2838454002ea317a0"
        }
    ],
    "page_count": 1,
    "success": true
}

Subscribe to Webhooks

We recommend that you subscribe to webhooks to stay updated on the status of nodes.


What's Next

Send A Check

Add Check Recipient


Add a CHECK-US node with recipient's bill pay information

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.