Requests And Responses
Valora APIs use predictable HTTP methods, JSON request bodies, and JSON responses.
Request basics
| Item | Convention |
|---|---|
| Headers | Send Accept: application/json on every request. |
| JSON bodies | Send Content-Type: application/json. |
| Dates | Use YYYY-MM-DD unless the endpoint documents another format. |
| Booleans | Use JSON booleans true and false in request bodies. |
| Filters | Use query string parameters for list filters. |
Success responses
Successful responses usually include a human-readable message and a data object or array.
{
"message": "Transactions retrieved successfully.",
"data": []
}
List endpoints may also include pagination metadata.
{
"message": "Transactions retrieved successfully.",
"pagination": {
"total": 123,
"per_page": 100,
"current_page": 1,
"last_page": 2,
"from": 1,
"to": 100
},
"data": []
}
Amounts and currency
When an endpoint returns monetary values, amounts are commonly returned in minor units such as cents. For example, 10000 means 100.00 in the response currency.
Endpoint pages document exceptions, including filters that accept major units such as 100.50.
Connection tests
Some endpoints support ?test=connection.
GET https://valora.spotahome.com/api/v1/c/transactions?test=connection
Authorization: Bearer {token}
Accept: application/json
Use connection tests to verify:
- The host is reachable.
- The bearer token is valid.
- The token has the right audience for the endpoint.
- Your client sends the required headers.