accountConsents

Account Consents Create Access

post/data/account-access

Request

  • Base URL: https://api.sandbox.tryspare.ae
  • URL: https://api.sandbox.tryspare.ae/data/account-access
  • Auth: HTTP bearer

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

consentExpiryDatestring date-time

Format: ISO 8601 date-time (e.g. 2025-01-01T00:00:00Z).

consentTransactionsFromDatestring date-time

Format: ISO 8601 date-time (e.g. 2025-01-01T00:00:00Z).

consentTransactionsToDatestring date-time

Format: ISO 8601 date-time (e.g. 2025-01-01T00:00:00Z).

customerEmailstring required
failureRedirectUrlstring

URL to redirect the payer to after a failed or cancelled authorization.

providerIdstring required
referenceCustomerIdstring required
requestedPermissionsDataAisPermission[] required
successRedirectUrlstring

URL to redirect the payer to after a successful authorization.

Example request

{
  "consentExpiryDate": "2025-01-01T00:00:00Z",
  "consentTransactionsFromDate": "2025-01-01T00:00:00Z",
  "consentTransactionsToDate": "2025-01-01T00:00:00Z"
}

Response

Success response

errorstring nullable
errorDescriptionobject nullable

Changes

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