MI Report Download API
GET /requester/v1.0/cop-iban-check/reports/uk-mi-reportsThe API allows to download mi report of name verification requests which had been processed earlier. By providing desired month and year,user will be allowed to download this report.
BANFICO LTD will provide the APIs for persisting certain information (mostly related to response reason code, user action, date/time of transaction) that is required to meet for the Management Reporting requirements of PayUK. BANFICO LTD's CoP solution has the required logic to use such persisted data and generate the MI reports that in the format specified by the regulator. A bank employee will be required to generate reports (periodically) and email/ submit it to the regulator.
Request Headers
| Attribute | Type | Condition | Description |
|---|---|---|---|
| Authorization | String | Mandatory | An Authorisation Token as per https://tools.ietf.org/html/rfc6750 |
| Content-Type | String | Mandatory | Value = application/json |
Request Parameters
| Attribute | Type | Condition |
|---|---|---|
| month | Integer | Mandatory |
| year | Integer | Mandatory |
Response Headers
| Attribute | Type | Condition | Description |
|---|---|---|---|
| Content-disposition | String | Mandatory | Value = attachment; filename=MI-report-{{month}}-{{year}}.xlsx |
| Content-Type | String | Mandatory | Value = application/vnd.ms-excel |
Response Body
| Attribute | Type | Condition | Description |
|---|---|---|---|
| File | xls | Mandatory | mi report for provided month and year will be downloaded in excel format. |
Response Codes
| Status Code | Description |
|---|---|
| 200 | OK - File downloaded successfully |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 415 | Unsupported Media Type |
| 429 | Too Many Requests |
| 500 | Internal Server Error |
Example
-
Request
GET /v1.0/cop-iban-check/reports/uk-mi-reports?month=9&year=2022
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
Content-Type: application/json
Accept: application/json-
Response
HTTP/1.1 200 OK
Content-disposition: attachment; filename=MI-report-{{month}}-{{year}}.xlsx
Content-Type: application/vnd.ms-excel