Get Balance#

Returns the prepaid balance as well as the available credit on your account.

Request#

HTTP Method: GET

URI Path: /v3/balance

Note

For all returned data attributes, see Balance Object.

URI Query Parameters#

Name

Type

Is Required?

Description

fields[balances]

string

No

Sparse fieldsets

Example#

http

1GET /v3/balance HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]

curl

1curl -i -X GET https://api.didww.com/v3/balance -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"

response

 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": {
 6    "id": "94441ce5-86fa-47bd-8ce7-b5e267d0603a",
 7    "type": "balances",
 8    "attributes": {
 9      "balance": "50.00",
10      "credit": "10.00",
11      "total_balance": "60.00"
12    }
13  }
14}

Other Responses#

Code

Success

Description

401

No

Unauthorized