Once you've activated ShipStation Carriers, you'll need to add funds to your account balance to start purchasing labels.
This article explains how to add funds to your ShipStation V2 API account balance programmatically using the PUT method with the add_funds endpoint.
To learn how to add funds to your account balance via the ShipStation dashboard, see the Add Funds section of our ShipStation Carriers help article.
- The
carrier_idproperty for one of your ShipStation carriers. - The
currencyandamountproperties. Currently, all ShipStation V2 API transactions are in US Dollars (USD) or British Pounds (GBP) only. - The
add_fundsendpoint must first be enabled by the ShipStation V2 API Support team. If you'd like to add funds via this endpoint, submit a request with our support team. - The minimum transaction amount for adding funds is 10.00 (USD/GBP)
IMPORTANT: This request is a live transaction that charges your payment method! There is no test mode for adding funds. You will be charged when making this request. Credit card processing fees may apply.
PUT /v2/carriers/:carrier_id/add_funds
PUT /v2/carriers/carr_8a1b2c3d4e5f6a7b/add_funds HTTP/1.1
Host: api.shipstation.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
"currency": "usd",
"amount": 10.0
}Example Response
{
"balance": {
"currency": "usd",
"amount": 50.00
}
}
You can check your balance for a particular carrier using the List Carriers (ShipEngine guide) endpoint. For any carrier account where requires_funded_amount is set to true, you can add funds.
If you have connected a standalone Stamps.com or Endicia account, you can use the same endpoint to fund those account balances as well. Simply use the corresponding carrier_id to indicate which balance you want to fund.