SpareSpare Docs
GuidesAPI Reference

Transactions

Retrieve transaction history and salary transactions.

v1 and v2

Transaction/Get and Transaction/List exist in v1 (/api/v1.0/…) and v2 (/api/v2.0/…). v2 is for long-lived consent; v1 is the standard flow. Transaction/Salaries is v1 only. Pick the version that matches your consent type.

v1

GET
/api/v1.0/ais/Transaction/Get
Authorization
Query

Transaction id

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1.0/ais/Transaction/Get?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": {    "account": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "externalId": "string",      "currency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      },      "servicer": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "address": {          "addressType": "string",          "department": "string",          "subDepartment": "string",          "addressLine": "string",          "streetName": "string",          "buildingNumber": "string",          "postalCode": "string",          "townName": "string",          "countrySubDivision": "string",          "country": "string",          "shortAddress": "string",          "unitNumber": 0,          "secondaryNumber": "string",          "district": "string",          "city": "string"        },        "scheme": "string",        "identification": "string"      },      "accounts": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "scheme": "string",          "identification": "string",          "name": "string"        }      ],      "status": "string",      "statusUpdatedDateTime": "2019-08-24T14:15:22Z",      "type": "string",      "subType": "string",      "description": "string",      "openingDate": "2019-08-24T14:15:22Z",      "maturityDate": "2019-08-24T14:15:22Z"    },    "balance": {      "currency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      },      "creditDebitIndicator": "string",      "type": "string",      "amount": 0,      "chargeIncluded": true    },    "creditorAgent": {      "scheme": "string",      "identification": "string",      "address": {        "addressType": "string",        "department": "string",        "subDepartment": "string",        "addressLine": "string",        "streetName": "string",        "buildingNumber": "string",        "postalCode": "string",        "townName": "string",        "countrySubDivision": "string",        "countryName": "string",        "shortAddress": "string",        "unitNumber": 0,        "secondaryNumber": "string",        "district": "string",        "city": "string",        "country": "string"      }    },    "debtorAgent": {      "scheme": "string",      "identification": "string",      "address": {        "addressType": "string",        "department": "string",        "subDepartment": "string",        "addressLine": "string",        "streetName": "string",        "buildingNumber": "string",        "postalCode": "string",        "townName": "string",        "countrySubDivision": "string",        "countryName": "string",        "shortAddress": "string",        "unitNumber": 0,        "secondaryNumber": "string",        "district": "string",        "city": "string",        "country": "string"      }    },    "deborAccount": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "scheme": "string",      "identification": "string",      "name": "string"    },    "creditorAccount": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "scheme": "string",      "identification": "string",      "name": "string"    },    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "externalTransactionId": "string",    "externalAccountId": "string",    "transactionReference": "string",    "localTimeZone": "string",    "transactionDateTime": "2019-08-24T14:15:22Z",    "subTransactionType": "string",    "transactionType": "string",    "flags": [      "string"    ],    "paymentModes": "string",    "transactionMutability": "string",    "transactionInformation": "string",    "statementReference": "string",    "creditDebitIndicator": "string",    "status": "string",    "bookingDateTime": "2019-08-24",    "valueDateTime": "2019-08-24",    "addressLine": "string",    "amount": {      "currency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      },      "localExchange": {        "sourceCurrency": "string",        "targetCurrency": "string",        "rate": 0.1,        "date": "2019-08-24",        "value": 0.1      },      "amount": 0,      "chargeIncluded": true    },    "chargeAmount": {      "currency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      },      "amount": 0,      "chargeIncluded": true    },    "billDetails": {      "billerId": "string",      "billNumber": "string",      "billPaymentType": "string"    },    "currencyExchange": {      "sourceCurrency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      },      "targetCurrency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      },      "exchangeRate": 0,      "unitCurrency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      },      "contractIdentification": "string",      "quotationDate": "2019-08-24",      "instructedAmount": {        "currency": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "englishName": "string",          "arabicName": "string",          "iso4117Code": "str",          "iso4117Number": "stri"        },        "amount": 0,        "chargeIncluded": true      }    },    "bankTransactionCode": {      "subCode": "string",      "domain": "string",      "domainCode": "string",      "family": "string",      "familyCode": "string",      "subFamily": "string",      "subFamilyCode": "string",      "code": "string"    },    "proprietaryBankTransactionCode": {      "issuer": "string",      "code": "string"    },    "merchantDetails": {      "categoryCode": "string",      "name": "string",      "merchantId": 0    },    "subCategoryName": "string",    "categoryCode": "string",    "categoryName": "string"  }}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
Empty
POST
/api/v1.0/ais/Transaction/List
Authorization
Query

Consent id

Page number

Number of items per page maximum allow is 200 per page

Bank account id

Body
*object

Request Body

application/json

Filter model

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1.0/ais/Transaction/List?consentId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "externalTransactionId": "string",      "externalAccountId": "string",      "transactionReference": "string",      "localTimeZone": "string",      "transactionDateTime": "2019-08-24T14:15:22Z",      "subTransactionType": "string",      "transactionType": "string",      "flags": [        "string"      ],      "paymentModes": "string",      "transactionMutability": "string",      "transactionInformation": "string",      "statementReference": "string",      "creditDebitIndicator": "string",      "status": "string",      "bookingDateTime": "2019-08-24",      "valueDateTime": "2019-08-24",      "addressLine": "string",      "amount": {        "currency": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "englishName": "string",          "arabicName": "string",          "iso4117Code": "str",          "iso4117Number": "stri"        },        "localExchange": {          "sourceCurrency": "string",          "targetCurrency": "string",          "rate": 0.1,          "date": "2019-08-24",          "value": 0.1        },        "amount": 0,        "chargeIncluded": true      },      "chargeAmount": {        "currency": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "englishName": "string",          "arabicName": "string",          "iso4117Code": "str",          "iso4117Number": "stri"        },        "amount": 0,        "chargeIncluded": true      },      "billDetails": {        "billerId": "string",        "billNumber": "string",        "billPaymentType": "string"      },      "currencyExchange": {        "sourceCurrency": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "englishName": "string",          "arabicName": "string",          "iso4117Code": "str",          "iso4117Number": "stri"        },        "targetCurrency": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "englishName": "string",          "arabicName": "string",          "iso4117Code": "str",          "iso4117Number": "stri"        },        "exchangeRate": 0,        "unitCurrency": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "englishName": "string",          "arabicName": "string",          "iso4117Code": "str",          "iso4117Number": "stri"        },        "contractIdentification": "string",        "quotationDate": "2019-08-24",        "instructedAmount": {          "currency": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "englishName": "string",            "arabicName": "string",            "iso4117Code": "str",            "iso4117Number": "stri"          },          "amount": 0,          "chargeIncluded": true        }      },      "bankTransactionCode": {        "subCode": "string",        "domain": "string",        "domainCode": "string",        "family": "string",        "familyCode": "string",        "subFamily": "string",        "subFamilyCode": "string",        "code": "string"      },      "proprietaryBankTransactionCode": {        "issuer": "string",        "code": "string"      },      "merchantDetails": {        "categoryCode": "string",        "name": "string",        "merchantId": 0      },      "subCategoryName": "string",      "categoryCode": "string",      "categoryName": "string"    }  ],  "meta": {    "currentPageNumber": 0,    "pageSize": 0,    "totalNumberOfPages": 0,    "totalItems": 0  }}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
Empty
GET
/api/v1.0/ais/Transaction/Salaries
Authorization
Query

Account id

From booking date time

To booking date time

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1.0/ais/Transaction/Salaries?accountId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": [    {      "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",      "month": "string",      "amount": 0.1,      "currency": "string"    }  ]}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
Empty
GET
/api/v2.0/ais/Transaction/Get
Authorization
Query

Transaction id

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2.0/ais/Transaction/Get?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": {    "account": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "externalId": "string",      "currency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      },      "servicer": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "address": {          "addressType": "string",          "department": "string",          "subDepartment": "string",          "addressLine": "string",          "streetName": "string",          "buildingNumber": "string",          "postalCode": "string",          "townName": "string",          "countrySubDivision": "string",          "country": "string",          "shortAddress": "string",          "unitNumber": 0,          "secondaryNumber": "string",          "district": "string",          "city": "string"        },        "scheme": "string",        "identification": "string"      },      "accounts": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "scheme": "string",          "identification": "string",          "name": "string"        }      ],      "status": "string",      "statusUpdatedDateTime": "2019-08-24T14:15:22Z",      "type": "string",      "subType": "string",      "description": "string",      "openingDate": "2019-08-24T14:15:22Z",      "maturityDate": "2019-08-24T14:15:22Z"    },    "balance": {      "currency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      },      "creditDebitIndicator": "string",      "type": "string",      "amount": 0,      "chargeIncluded": true    },    "creditorAgent": {      "scheme": "string",      "identification": "string",      "address": {        "addressType": "string",        "department": "string",        "subDepartment": "string",        "addressLine": "string",        "streetName": "string",        "buildingNumber": "string",        "postalCode": "string",        "townName": "string",        "countrySubDivision": "string",        "countryName": "string",        "shortAddress": "string",        "unitNumber": 0,        "secondaryNumber": "string",        "district": "string",        "city": "string",        "country": "string"      }    },    "debtorAgent": {      "scheme": "string",      "identification": "string",      "address": {        "addressType": "string",        "department": "string",        "subDepartment": "string",        "addressLine": "string",        "streetName": "string",        "buildingNumber": "string",        "postalCode": "string",        "townName": "string",        "countrySubDivision": "string",        "countryName": "string",        "shortAddress": "string",        "unitNumber": 0,        "secondaryNumber": "string",        "district": "string",        "city": "string",        "country": "string"      }    },    "deborAccount": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "scheme": "string",      "identification": "string",      "name": "string"    },    "creditorAccount": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "scheme": "string",      "identification": "string",      "name": "string"    },    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "externalTransactionId": "string",    "externalAccountId": "string",    "transactionReference": "string",    "localTimeZone": "string",    "transactionDateTime": "2019-08-24T14:15:22Z",    "subTransactionType": "string",    "transactionType": "string",    "flags": [      "string"    ],    "paymentModes": "string",    "transactionMutability": "string",    "transactionInformation": "string",    "statementReference": "string",    "creditDebitIndicator": "string",    "status": "string",    "bookingDateTime": "2019-08-24",    "valueDateTime": "2019-08-24",    "addressLine": "string",    "amount": {      "currency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      },      "localExchange": {        "sourceCurrency": "string",        "targetCurrency": "string",        "rate": 0.1,        "date": "2019-08-24",        "value": 0.1      },      "amount": 0,      "chargeIncluded": true    },    "chargeAmount": {      "currency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      },      "amount": 0,      "chargeIncluded": true    },    "billDetails": {      "billerId": "string",      "billNumber": "string",      "billPaymentType": "string"    },    "currencyExchange": {      "sourceCurrency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      },      "targetCurrency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      },      "exchangeRate": 0,      "unitCurrency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      },      "contractIdentification": "string",      "quotationDate": "2019-08-24",      "instructedAmount": {        "currency": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "englishName": "string",          "arabicName": "string",          "iso4117Code": "str",          "iso4117Number": "stri"        },        "amount": 0,        "chargeIncluded": true      }    },    "bankTransactionCode": {      "subCode": "string",      "domain": "string",      "domainCode": "string",      "family": "string",      "familyCode": "string",      "subFamily": "string",      "subFamilyCode": "string",      "code": "string"    },    "proprietaryBankTransactionCode": {      "issuer": "string",      "code": "string"    },    "merchantDetails": {      "categoryCode": "string",      "name": "string",      "merchantId": 0    },    "subCategoryName": "string",    "categoryCode": "string",    "categoryName": "string"  }}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
Empty
POST
/api/v2.0/ais/Transaction/List
Authorization
Query

Consent id

Page number

Number of items per page maximum allow is 200 per page

Bank account id

Body
*object

Request Body

application/json

Filter model

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v2.0/ais/Transaction/List?consentId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "externalTransactionId": "string",      "externalAccountId": "string",      "transactionReference": "string",      "localTimeZone": "string",      "transactionDateTime": "2019-08-24T14:15:22Z",      "subTransactionType": "string",      "transactionType": "string",      "flags": [        "string"      ],      "paymentModes": "string",      "transactionMutability": "string",      "transactionInformation": "string",      "statementReference": "string",      "creditDebitIndicator": "string",      "status": "string",      "bookingDateTime": "2019-08-24",      "valueDateTime": "2019-08-24",      "addressLine": "string",      "amount": {        "currency": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "englishName": "string",          "arabicName": "string",          "iso4117Code": "str",          "iso4117Number": "stri"        },        "localExchange": {          "sourceCurrency": "string",          "targetCurrency": "string",          "rate": 0.1,          "date": "2019-08-24",          "value": 0.1        },        "amount": 0,        "chargeIncluded": true      },      "chargeAmount": {        "currency": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "englishName": "string",          "arabicName": "string",          "iso4117Code": "str",          "iso4117Number": "stri"        },        "amount": 0,        "chargeIncluded": true      },      "billDetails": {        "billerId": "string",        "billNumber": "string",        "billPaymentType": "string"      },      "currencyExchange": {        "sourceCurrency": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "englishName": "string",          "arabicName": "string",          "iso4117Code": "str",          "iso4117Number": "stri"        },        "targetCurrency": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "englishName": "string",          "arabicName": "string",          "iso4117Code": "str",          "iso4117Number": "stri"        },        "exchangeRate": 0,        "unitCurrency": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "englishName": "string",          "arabicName": "string",          "iso4117Code": "str",          "iso4117Number": "stri"        },        "contractIdentification": "string",        "quotationDate": "2019-08-24",        "instructedAmount": {          "currency": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "englishName": "string",            "arabicName": "string",            "iso4117Code": "str",            "iso4117Number": "stri"          },          "amount": 0,          "chargeIncluded": true        }      },      "bankTransactionCode": {        "subCode": "string",        "domain": "string",        "domainCode": "string",        "family": "string",        "familyCode": "string",        "subFamily": "string",        "subFamilyCode": "string",        "code": "string"      },      "proprietaryBankTransactionCode": {        "issuer": "string",        "code": "string"      },      "merchantDetails": {        "categoryCode": "string",        "name": "string",        "merchantId": 0      },      "subCategoryName": "string",      "categoryCode": "string",      "categoryName": "string"    }  ],  "meta": {    "currentPageNumber": 0,    "pageSize": 0,    "totalNumberOfPages": 0,    "totalItems": 0  }}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
Empty

Accounts & Balances

List accounts and read current and historical balances.

Beneficiaries & Parties

Beneficiaries, account parties, and direct debits.