SpareSpare Docs
GuidesAPI Reference

Statements & Reports

PDF statements and account information reports.

POST
/api/v1.0/ais/AccountInformationReport/Create
Authorization
Body
*object

Request Body

application/json

Account information report model

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1.0/ais/AccountInformationReport/Create" \  -H "Content-Type: application/json" \  -d '{}'
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "jobId": "string",    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",    "startDate": "2019-08-24T14:15:22Z",    "endDate": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "accountsCount": 0,    "totalBalance": 0,    "description": "string",    "currency": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "englishName": "string",      "arabicName": "string",      "iso4117Code": "str",      "iso4117Number": "stri"    },    "status": "Awaiting"  }}
{  "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
Empty
GET
/api/v1.0/ais/AccountInformationReport/Get
Authorization
Query

Account information report job id

Customer id

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1.0/ais/AccountInformationReport/Get?jobId=497f6eca-6276-4993-bfeb-53cbbbba6f08&customerId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": {    "accountHolderName": "string",    "cashFlowTrend": {      "accounts": [        "4a495fe5-8a51-4e75-94d5-7139133df298"      ],      "currency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      },      "dailyTotalCredit": [        {          "key": "2019-08-24T14:15:22Z",          "value": 0.1        }      ],      "dailyTotalDebit": [        {          "key": "2019-08-24T14:15:22Z",          "value": 0.1        }      ]    },    "affordability": {      "month": "2019-08-24T14:15:22Z",      "averageIncomeAffordability": 0,      "averageNetAffordability": 0,      "income": 0,      "expenses": 0,      "incomeAffordability": 0,      "netAffordability": 0,      "currency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      }    },    "accounts": [      {        "provider": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "country": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "createdAt": "2019-08-24T14:15:22Z",            "updatedAt": "2019-08-24T14:15:22Z",            "currency": {              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",              "englishName": "string",              "arabicName": "string",              "iso4117Code": "str",              "iso4117Number": "stri"            },            "englishName": "string",            "arabicName": "string",            "iso3166Code": "st",            "timeZone": "string"          },          "allowedPermissions": [            "ReadAccountsBasic"          ],          "address": "string",          "phone": "string",          "arabicName": "string",          "englishName": "string",          "status": "Active",          "isEnable": true,          "logo": "http://example.com"        },        "createdAt": "2019-08-24T14:15:22Z",        "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"      }    ],    "transactionsCategories": {      "debit": {        "totalDebit": 0,        "currency": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "englishName": "string",          "arabicName": "string",          "iso4117Code": "str",          "iso4117Number": "stri"        },        "categories": [          {            "subCategoryName": "string",            "amount": 0,            "bookingDateTime": "2019-08-24",            "categoryName": "string",            "transactionInformation": "string"          }        ]      },      "credit": {        "totalCredit": 0,        "totalDebit": 0,        "currency": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "englishName": "string",          "arabicName": "string",          "iso4117Code": "str",          "iso4117Number": "stri"        },        "categories": [          {            "subCategoryName": "string",            "amount": 0,            "bookingDateTime": "2019-08-24",            "categoryName": "string",            "transactionInformation": "string"          }        ]      }    },    "balanceSummary": {      "accounts": [        "4a495fe5-8a51-4e75-94d5-7139133df298"      ],      "currency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      },      "currentBalance": 0,      "minimumBalance": 0,      "maximumBalance": 0,      "averageBalance": 0,      "totalCredit": 0,      "totalSixMonthCredit": 0,      "totalDebit": 0,      "averageMonthlyCredit": 0,      "averageMonthlyDebit": 0,      "daysBelowMean": 0,      "trendLine": 0,      "balanceTrendModel": [        {          "slope": 0,          "intercept": 0,          "accountBalanceHistory": {            "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",            "history": [              {                "date": "string",                "balances": [                  {                    "type": "string",                    "amount": {                      "amount": 0.1,                      "currency": "string",                      "localExchange": {                        "sourceCurrency": "string",                        "targetCurrency": "string",                        "rate": 0.1,                        "date": "2019-08-24",                        "value": 0.1                      }                    }                  }                ]              }            ]          }        }      ]    },    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "jobId": "string",    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",    "startDate": "2019-08-24T14:15:22Z",    "endDate": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "accountsCount": 0,    "totalBalance": 0,    "description": "string",    "currency": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "englishName": "string",      "arabicName": "string",      "iso4117Code": "str",      "iso4117Number": "stri"    },    "status": "Awaiting"  }}
{  "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
Empty
GET
/api/v1.0/ais/AccountInformationReport/File
Authorization
Query

Account information report job id

Customer id

Response Body

curl -X GET "https://example.com/api/v1.0/ais/AccountInformationReport/File?jobId=497f6eca-6276-4993-bfeb-53cbbbba6f08&customerId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": {    "accountHolderName": "string",    "cashFlowTrend": {      "accounts": [        "4a495fe5-8a51-4e75-94d5-7139133df298"      ],      "currency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      },      "dailyTotalCredit": [        {          "key": "2019-08-24T14:15:22Z",          "value": 0.1        }      ],      "dailyTotalDebit": [        {          "key": "2019-08-24T14:15:22Z",          "value": 0.1        }      ]    },    "affordability": {      "month": "2019-08-24T14:15:22Z",      "averageIncomeAffordability": 0,      "averageNetAffordability": 0,      "income": 0,      "expenses": 0,      "incomeAffordability": 0,      "netAffordability": 0,      "currency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      }    },    "accounts": [      {        "provider": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "country": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "createdAt": "2019-08-24T14:15:22Z",            "updatedAt": "2019-08-24T14:15:22Z",            "currency": {              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",              "englishName": "string",              "arabicName": "string",              "iso4117Code": "str",              "iso4117Number": "stri"            },            "englishName": "string",            "arabicName": "string",            "iso3166Code": "st",            "timeZone": "string"          },          "allowedPermissions": [            "ReadAccountsBasic"          ],          "address": "string",          "phone": "string",          "arabicName": "string",          "englishName": "string",          "status": "Active",          "isEnable": true,          "logo": "http://example.com"        },        "createdAt": "2019-08-24T14:15:22Z",        "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"      }    ],    "transactionsCategories": {      "debit": {        "totalDebit": 0,        "currency": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "englishName": "string",          "arabicName": "string",          "iso4117Code": "str",          "iso4117Number": "stri"        },        "categories": [          {            "subCategoryName": "string",            "amount": 0,            "bookingDateTime": "2019-08-24",            "categoryName": "string",            "transactionInformation": "string"          }        ]      },      "credit": {        "totalCredit": 0,        "totalDebit": 0,        "currency": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "englishName": "string",          "arabicName": "string",          "iso4117Code": "str",          "iso4117Number": "stri"        },        "categories": [          {            "subCategoryName": "string",            "amount": 0,            "bookingDateTime": "2019-08-24",            "categoryName": "string",            "transactionInformation": "string"          }        ]      }    },    "balanceSummary": {      "accounts": [        "4a495fe5-8a51-4e75-94d5-7139133df298"      ],      "currency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      },      "currentBalance": 0,      "minimumBalance": 0,      "maximumBalance": 0,      "averageBalance": 0,      "totalCredit": 0,      "totalSixMonthCredit": 0,      "totalDebit": 0,      "averageMonthlyCredit": 0,      "averageMonthlyDebit": 0,      "daysBelowMean": 0,      "trendLine": 0,      "balanceTrendModel": [        {          "slope": 0,          "intercept": 0,          "accountBalanceHistory": {            "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",            "history": [              {                "date": "string",                "balances": [                  {                    "type": "string",                    "amount": {                      "amount": 0.1,                      "currency": "string",                      "localExchange": {                        "sourceCurrency": "string",                        "targetCurrency": "string",                        "rate": 0.1,                        "date": "2019-08-24",                        "value": 0.1                      }                    }                  }                ]              }            ]          }        }      ]    },    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "jobId": "string",    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",    "startDate": "2019-08-24T14:15:22Z",    "endDate": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "accountsCount": 0,    "totalBalance": 0,    "description": "string",    "currency": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "englishName": "string",      "arabicName": "string",      "iso4117Code": "str",      "iso4117Number": "stri"    },    "status": "Awaiting"  }}
{  "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/AccountInformationReport/List
Authorization
Query

Customer id

Page number

Number of items per page maximum allow is 10 per page

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1.0/ais/AccountInformationReport/List?customerId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "jobId": "string",      "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",      "startDate": "2019-08-24T14:15:22Z",      "endDate": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "accountsCount": 0,      "totalBalance": 0,      "description": "string",      "currency": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      },      "status": "Awaiting"    }  ],  "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}
Empty
Empty
GET
/api/v1.0/ais/AccountInformationReport/Status
Authorization
Query

Job id

Customer 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/AccountInformationReport/Status?jobId=497f6eca-6276-4993-bfeb-53cbbbba6f08&customerId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "jobId": "string",    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",    "startDate": "2019-08-24T14:15:22Z",    "endDate": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "accountsCount": 0,    "totalBalance": 0,    "description": "string",    "currency": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "englishName": "string",      "arabicName": "string",      "iso4117Code": "str",      "iso4117Number": "stri"    },    "status": "Awaiting"  }}
{  "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/Statement/File
Authorization
Query

Account id

Response Body

curl -X GET "https://example.com/api/v1.0/ais/Statement/File?accountId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
"string"
Empty
{  "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

Beneficiaries & Parties

Beneficiaries, account parties, and direct debits.

Providers & Requests

Provider directory and account information request management.