Create Shipment

Shipments

POST https://api.synapsefi.com/v3.1/users/:user_id/nodes/:node_id/subnets/:subnet_id/ship

This endpoint allows you to create a shipment.

Path Parameters

Name	Type	Description
subnet_id	string	ID of the subnet.
node_id	string	ID of the node.
user_id	string	ID of the user.

Headers

Name	Type	Description
X-SP-USER	string	User's OAuth key and device fingerprint, separated by a pipe.
X-SP-USER-IP	string	IP address of user's device.
X-SP-GATEWAY	string	Your Client ID and Secret, separated by a pipe.

200 Subnet Successfully Created.

{
    "_id": "5fdaa7d0d608d8b2ea80a6e4",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets/5fdaa7d0d608d8b2ea80a6e4"
        }
    },
    "account_class": "CHECKING",
    "account_num": "9826994713",
    "agreements": [],
    "client": {
        "id": "589acd9ecb3cd400fa75ac06",
        "name": "SynapseFi"
    },
    "created_on": 1608165328800,
    "nickname": "Test AC/RT",
    "node_id": "5fd901bb20b3aa0bc7caee85",
    "routing_num": {
        "ach": "084106768",
        "wire": "084106768"
    },
    "status": "ACTIVE",
    "status_code": null,
    "supp_id": null,
    "updated_on": 1608165328806,
    "user_id": "5fd7acfd8677040053ad486d"
}

400 Request Failing.

{
    "error": {
        "code": "missing_user_credentials",
        "en": "User credentials are missing from the request."
    },
    "error_code": "200",
    "http_code": "400",
    "success": false
}

Go to Shipment Object Details to see all the required and optional body parameters allowed during shipment creation.

Example Request

HTTP

POST /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets/5fe393cac55b7036478223be/ship HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_5FhywpZgtn0GPqkMidJCazIKmSc0UjQ1bW8VEYOL|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
    "fee_node_id": "5fd901bb20b3aa0bc7caee85",
    "delivery": "STANDARD",
    "card_style_id": "660"
}

cURL

curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets/5fe393cac55b7036478223be/ship' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_5FhywpZgtn0GPqkMidJCazIKmSc0UjQ1bW8VEYOL|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fee_node_id": "5fd901bb20b3aa0bc7caee85",
    "delivery": "STANDARD",
    "card_style_id": "660"
}'

Python

//

JS

//

PHP

//

GO

//