Customer

Customer API Documentation

Documentation for customer-scoped REST API endpoints. Each endpoint has its own file so the request/response contract stays focused and easy to maintain.

API hosts (use these with the paths below):

  • Production: https://valora.spotahome.com/ (sandbox compatible)
  • Staging / testing: https://valora-testing.laravel.cloud/ (sandbox compatible)

Shared conventions

Convention Details
Auth type Bearer token (long-lived API token, auth:api guard)
How to obtain a token See Long-Lived API Token Authentication
Headers Authorization: Bearer {token} and Accept: application/json (both required)
Token class Customer only. Non-customer users receive HTTP 403 from CheckCustomerApi middleware.
Rate limit 120 requests per minute per authenticated customer
Customer API (production) https://valora.spotahome.com/api/v1/c
Customer API (sandbox) https://valora-testing.laravel.cloud/api/sandbox/v1/c
Amounts All monetary values in responses are in minor units (cents). Filter parameters (amount_from, amount_to) accept major units (e.g. 100.50).
Pagination Default page size: 100. Maximum: 500.
Connection test Send ?test=connection (or no parameters where documented) to receive 200 You are connected! with accepted params.

Each customer endpoint page links back here for shared conventions, auth, and base URLs.

Endpoints

Resource Method Production URL Description
Transactions GET https://valora.spotahome.com/api/v1/c/transactions List completed transactions.
Scheduled Transactions GET https://valora.spotahome.com/api/v1/c/transactions/scheduled List upcoming/scheduled payments.
Invoices GET https://valora.spotahome.com/api/v1/c/invoices List invoices and credit notes.
Penalties GET https://valora.spotahome.com/api/v1/c/penalties List penalty records.
Debt GET https://valora.spotahome.com/api/v1/c/debtors List outstanding debt records.
Conciliation by Booking GET https://valora.spotahome.com/api/v1/c/conciliation/booking Full financial conciliation for a booking.