Link a Wire Account (International)

POST WIRE-US node to add wiring instructions.

Reminder: Please create a user with the necessary KYC, then OAuth the user to perform actions on their behalf.

To send outgoing wires, link a wire account to the recipient. The wire account can be a domestic wire account (WIRE-US node) or an international wire account (WIRE-INT node).

API Endpoint

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

PATH PARAMETER

Path Params

user_id :
required
string

The user ID of the user you wish to add the WIRE-INT node under

BODY PARAMETER

type :
required
string

Type of node you wish to add

info.nickname :
required
string

Nickname for the node

info.swift :
required
string

SWIFT Code of the bank

info.account_num :
required
string

Account number associated with the bank

info.routing_num :
string

Routing number associated with the bank

info.correspondent_info.routing_num :
string

Routing number of correspondent bank

info.correspondent_info.bank_name :
string

Name of correspondent bank

info.correspondent_info.address :
string

Address of correspondent bank

extra.supp_id :
string

Any ID you wish to register to the node

is_active :
boolean

If the node is indexed or marked deleted

Node Permissions
Every account has the following permissions associated with them:

Permission
Comments

CREDIT-AND-DEBIT

Node can be used for sending and receiving funds

INACTIVE

Node has been disabled and cannot be used for any transactions

LOCKED

Node has been locked and cannot be used for any transactions

Example Request

POST /v3.1/users/5bb5258fb9b35b0094e508fc/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_053uaoUncXmjJlDYONfdBPLypKIiZFxMbQhRg417|n38dj3h8NE393bv24ovoRY34kd62
Content-Type: application/json


{
  "type": "WIRE-INT",
  "info":{
      "nickname": "Some Account",
      "account_num": "1235674342",
      "swift": "TSIGFR22"
    }
}
body = {
	"type": "WIRE-INT",
  "info":{
      "nickname": "Some Account",
      "account_num": "1235674342",
      "swift": "TSIGFR22"
    }
}

user.create_node(body)
const body = {
	"type": "WIRE-INT",
  "info":{
      "nickname": "Some Account",
      "account_num": "1235674342",
      "swift": "TSIGFR22"
    }
};

user.createNode(body);
body = {
	"type": "WIRE-INT",
  "info":{
      "nickname": "Some Account",
      "account_num": "1235674342",
      "swift": "TSIGFR22"
    }
}

user.create_node(payload: body)
$info= (object) [
  "nickname" => "My Checking",
  "account_num" => "1235674342",
  "swift" => "TSIGFR22"
];
$body = (object) [
   'type' => 'WIRE-INT',
   'info' => $info
];

$user->create_node($body );
body := `{
  type: 'WIRE-INT',
  info: {
    "nickname": "Some Account",
    "account_num": "1235674342",
    "routing_num": "026009593",
    "swift": "TSIGFR22"
  }
}`

data, err := user.CreateNode(body)

Example Successful 200 Response

{
  "error_code": "0",
  "http_code": "200",
  "limit": 20,
  "node_count": 1,
  "nodes": [
    {
      "_id": "5c50b01f871883634a839156",
      "_links": {
        "self": {
          "href": "https://uat-api.synapsefi.com/v3.1/users/5bb5258fb9b35b0094e508fc/nodes/5c50b01f871883634a839156"
        }
      },
      "allowed": "CREDIT-AND-DEBIT",
      "client": {
        "id": "5ade26b4567a900029e2afd2",
        "name": "Test Account"
      },
      "extra": {
        "note": null,
        "other": {},
        "supp_id": ""
      },
      "info": {
        "account_num": "4342",
        "address": "PLACE DE LA REPUBLIQUE 4 CROIX 59170 FR",
        "balance": {
          "amount": "0.00",
          "currency": "USD"
        },
        "bank_logo": "",
        "bank_long_name": "3 SUISSES INTERNATIONAL",
        "bank_name": "3 SUISSES INTERNATIONAL",
        "correspondent_info": {
          "address": null,
          "bank_name": null,
          "routing_num": null,
          "swift": null
        },
        "name_on_account": " ",
        "nickname": "Some Account"
      },
      "is_active": true,
      "timeline": [
        {
          "date": 1548791839321,
          "note": "Node created."
        }
      ],
      "type": "WIRE-INT",
      "user_id": "5bb5258fb9b35b0094e508fc"
    }
  ],
  "page_count": 1,
  "success": true
}

Subscribe to Webhooks

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

Link a Wire Account (International)


POST WIRE-US node to add wiring instructions.

Suggested Edits are limited on API Reference Pages

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