Request

List account information access requests

Unique resource name : ais.v1.request.list

get/api/v1.0/ais/Request/List

Request

  • Base URL: https://sandbox.sparefinancial.sa
  • URL: https://sandbox.sparefinancial.sa/api/v1.0/ais/Request/List
  • Auth: API key in header Authorization

Query parameters

pageinteger

Page number

perPageinteger

Number of items per page maximum allow is 500 per page

Response

error'INVALID_DATA' | 'INVALID_SIGNATURE' | 'RESOURCE_LOCKED' | 'COUNTRY_NOT_FOUND' | 'CURRENCY_NOT_FOUND' | 'PROVIDER_NOT_FOUND' | 'CONNECTION_NOT_FOUND' | 'INSUFFICIENT_CONSENT_PERMISSIONS' | 'CONSENT_EXPIRED' | 'CONSENT_REVOKED' | 'CONSENT_UNAUTHORIZED' | 'CONSENT_NOT_FOUND' | 'ACCOUNT_INFORMATION_REPORT_NOT_FOUND' | 'MULTIPLE_CURRENCY_NOT_ALLOWED' | 'MULTIPLE_CONSENT_DATE_NOT_ALLOWED' | 'PAYMENT_NOT_FOUND' | 'CONSENT_REJECTED' | 'PAYMENT_REQUEST_NOT_FOUND' | 'CUSTOMER_NOT_FOUND' | 'REAL_ESTATE_VERIFY_NOT_FOUND' | 'REAL_ESTATE_VALIDATE_NOT_FOUND' | 'REAL_ESTATE_SEARCH_NOT_FOUND' | 'CUSTOMER_ALREADY_EXISTS' | 'BANK_ACCOUNT_NOT_FOUND' | 'SERVER_ERROR' | 'PROVIDER_CONNECTION_FAILURE' | 'TRANSACTION_NOT_FOUND' | 'ACCOUNT_INFORMATION_ACCESS_REQUEST_NOT_FOUND' | 'CONSENT_REVOCATION_FAILED' | 'CONSENT_REVOKED_OR_EXPIRED' | 'SUBSCRIPTION_EXPIRED' | 'NOT_SUBSCRIBED_TO_SERVICE' | 'BENEFICIARY_NOT_FOUND' | 'PARTIES_NOT_FOUND' | 'DIRECT_DEBIT_NOT_FOUND' | 'SCHEDULED_PAYMENT_NOT_FOUND' | 'DEBTOR_ACCOUNT_NOT_FOUND' | 'CREDITOR_ACCOUNT_NOT_FOUND' | 'UNAUTHORIZED_IP_ADDRESS' | 'REAL_ESTATE_FAILED'
errorDescriptionobject nullable

Example response

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "consentExpiryDate": "2025-01-01T00:00:00Z",
      "consent": {
        "expiryDate": "2025-01-01T00:00:00Z",
        "transactionsFromDate": "2025-01-01T00:00:00Z",
        "transactionsToDate": "2025-01-01T00:00:00Z",
        "statusHistory": [
          {
            "dateTime": "2025-01-01T00:00:00Z"
          }
        ],
        "connection": {
          "provider": {
            "id": "00000000-0000-0000-0000-000000000000",
            "country": {
              "id": "00000000-0000-0000-0000-000000000000",
              "createdAt": "2025-01-01T00:00:00Z",
              "updatedAt": "2025-01-01T00:00:00Z",
              "currency": {
                "id": "00000000-0000-0000-0000-000000000000"
              }
            },
            "logo": "https://example.com"
          },
          "id": "00000000-0000-0000-0000-000000000000",
          "createdAt": "2025-01-01T00:00:00Z",
          "updatedAt": "2025-01-01T00:00:00Z"
        },
        "id": "00000000-0000-0000-0000-000000000000",
        "customerId": "00000000-0000-0000-0000-000000000000",
        "createdAt": "2025-01-01T00:00:00Z"
      },
      "country": {
        "id": "00000000-0000-0000-0000-000000000000",
        "createdAt": "2025-01-01T00:00:00Z",
        "updatedAt": "2025-01-01T00:00:00Z",
        "currency": {
          "id": "00000000-0000-0000-0000-000000000000"
        }
      },
      "createdAt": "2025-01-01T00:00:00Z",
      "updatedAt": "2025-01-01T00:00:00Z",
      "customerId": "00000000-0000-0000-0000-000000000000",
      "consentTransactionsFromDate": "2025-01-01T00:00:00Z",
      "consentTransactionsToDate": "2025-01-01T00:00:00Z",
      "countryCode": "SA",
      "successRedirectUrl": "https://example.com",
      "failureRedirectUrl": "https://example.com"
    }
  ]
}

Changes

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