Transaction

List transactions

Unique resource name : ais.v1.transaction.list

Important!:

The permissions bellow are required on the consent:

  • ReadTransactionsBasic
  • ReadTransactionsDetail
  • ReadTransactionsDebits
  • ReadTransactionsCredits
post/api/v1.0/ais/Transaction/List

Request

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

Query parameters

consentIdstring uuid required

Consent id

pageinteger

Page number

perPageinteger

Number of items per page maximum allow is 200 per page

accountIdstring uuid

Bank account id

Request body

fromBookingDateTimestring date-time nullable

Start of the booking date-time range (ISO 8601).

toBookingDateTimestring date-time nullable

End of the booking date-time range (ISO 8601).

status'BOOKED' | 'PENDING' | 'REJECTED'
type'CREDIT' | 'DEBIT'
searchBy'BOOKING_DATE' | 'STATUS' | 'TYPE' | 'MERCHANT_NAME' | 'MERCHANT_CATEGORY_CODE'
searchKeyWordstring nullable

Keyword to filter results by.

orderBy'BOOKING_DATE' | 'STATUS' | 'TYPE' | 'MERCHANT_NAME' | 'MERCHANT_CATEGORY_CODE'
order'ASCENDING' | 'DESCENDING'

Example request

{
  "fromBookingDateTime": "2025-01-01T00:00:00Z",
  "toBookingDateTime": "2025-01-01T00:00:00Z"
}

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",
      "transactionDateTime": "2025-01-01T00:00:00Z",
      "bookingDateTime": "2025-01-01",
      "valueDateTime": "2025-01-01",
      "amount": {
        "currency": {
          "id": "00000000-0000-0000-0000-000000000000"
        },
        "localExchange": {
          "sourceCurrency": "SAR",
          "targetCurrency": "SAR",
          "date": "2025-01-01"
        }
      },
      "chargeAmount": {
        "currency": {
          "id": "00000000-0000-0000-0000-000000000000"
        }
      },
      "currencyExchange": {
        "sourceCurrency": {
          "id": "00000000-0000-0000-0000-000000000000"
        },
        "targetCurrency": {
          "id": "00000000-0000-0000-0000-000000000000"
        },
        "unitCurrency": {
          "id": "00000000-0000-0000-0000-000000000000"
        },
        "quotationDate": "2025-01-01",
        "instructedAmount": {
          "currency": {
            "id": "00000000-0000-0000-0000-000000000000"
          }
        }
      }
    }
  ]
}

Changes

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