accountRequests

Account Requests Create

post/data/account-requests

Request

  • Base URL: https://api.sandbox.tryspare.ae
  • URL: https://api.sandbox.tryspare.ae/data/account-requests
  • 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).

countryCodestring required
failureRedirectUrlstring

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

requestPermissionsDataAisPermission[] 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",
  "countryCode": "AE"
}

Response

Success response

errorstring nullable
errorDescriptionobject nullable

Example response

{
  "data": {
    "consent": {
      "connection": {
        "createdAt": "2025-01-01T00:00:00Z",
        "provider": {
          "country": {
            "createdAt": "2025-01-01T00:00:00Z",
            "updatedAt": "2025-01-01T00:00:00Z"
          }
        },
        "updatedAt": "2025-01-01T00:00:00Z"
      },
      "createdAt": "2025-01-01T00:00:00Z",
      "expiryDate": "2025-01-01T00:00:00Z",
      "statusHistory": [
        {
          "dateTime": "2025-01-01T00:00:00Z"
        }
      ],
      "transactionsFromDate": "2025-01-01T00:00:00Z",
      "transactionsToDate": "2025-01-01T00:00:00Z"
    },
    "consentExpiryDate": "2025-01-01T00:00:00Z",
    "consentTransactionsFromDate": "2025-01-01T00:00:00Z",
    "consentTransactionsToDate": "2025-01-01T00:00:00Z",
    "country": {
      "createdAt": "2025-01-01T00:00:00Z",
      "updatedAt": "2025-01-01T00:00:00Z"
    },
    "createdAt": "2025-01-01T00:00:00Z",
    "updatedAt": "2025-01-01T00:00:00Z"
  }
}

Changes

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