dataSync

Data Sync Start

post/data/sync

Request

  • Base URL: https://api.sandbox.tryspare.ae
  • URL: https://api.sandbox.tryspare.ae/data/sync
  • Auth: HTTP bearer

Query parameters

consentIdstring required

UUID of the consent (returned when the consent was created).

accountIdstring

Headers

x-tenantstring required
Example:UAE

Regulatory jurisdiction the request routes to (e.g. UAE, KSA, MAIN). Match it to the market you're integrating.

Request body

categorizeTransactionsboolean
syncAccountsboolean
syncBalancesboolean
syncBeneficiariesboolean
syncDirectDebitsboolean
syncPartiesboolean
syncProductsboolean
syncSchedulePaymentsboolean
syncStandingOrdersboolean
syncStatementsboolean
syncTransactionsboolean

Example request

{
  "statementFilterPayload": {
    "fromStatementDate": "2025-01-01T00:00:00Z",
    "toStatementDate": "2025-01-01T00:00:00Z"
  }
}

Response

Success response

Changes

No recorded changes to this operation across all 1 revision of this API.