Site Logo

🎉 ShipEngine is becoming ShipStation API 🎉

Over the next few months you'll notice the ShipEngine website, documentation portal, and dashboard being rebranded as ShipStation API. For our ShipEngine customers, you don't need to take any action or change any of your integrations in any way. All endpoints will remain the same and continue to function as they always have.

To learn more about what's coming, review our New ShipStation API page.

Fund Your Account Balance

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 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 API dashboard, see the Add Funds section of our ShipStation Carriers help article.

Requirements

  • The carrier_id property for one of your ShipStation carriers.
  • The currency and amount properties. Currently, all ShipStation API transactions are in US Dollars (USD) or British Pounds (GBP) only.
  • The add_funds endpoint must first be enabled by the ShipStation API Support team. If you'd like to add funds via this endpoint, submit a request with our support team.

Add Funds

Example Request & Response

PUT /v1/carriers/:carrier_id/add_funds

1
2
3
4
5
6
7
8
9
PUT /v1/carriers/se-123890/add_funds HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
"currency": "usd",
"amount": 10.0
}

Example Response

1
2
3
4
5
6
{
"balance": {
"currency": "usd",
"amount": 50.00
}
}

Check Your Balance

You can check your balance for a particular carrier using the List Carriers endpoint. For any carrier account where requires_funded_amount is set to true, you can add funds.

Fund Balances for Stamps.com or Endicia Standalone Accounts

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.