Account API - Stannp Direct Mail API Documentation

Get account balance

You can use the API to check your account balance.

[GET]
https://api-us1.stannp.com/v1/accounts/balance

Request Example

        curl "https://api-us1.stannp.com/v1/accounts/balance" \
-u {API_KEY}:
    

Response Example

{
  "success": true,
  "data": {
    "balance": "214.42"
  }
}

Top up balance

You can use the API to top up your balance if you have a saved card and set one to default.

[POST]
https://api-us1.stannp.com/v1/accounts/topup

Parameters

ParameterTypeDescription
netstringThe amount to top up. Eg: "100.00". Be aware tax may be added on after.

Request Example

        curl "https://api-us1.stannp.com/v1/accounts/topup" \
-u {API_KEY}: \
-d "net=100.00" 
    

Response Example

{
  "success": true,
  "data": {
    "receipt_pdf": "https://www.stannp.com/invoice/12345--abcdefg-uhusdsfsi34545-fgfdfdb.pdf"
  }
}