MI logging API
PATCH /v1.0/cop-iban-check/account-verifications/{Id}The API allows to log Outcome Code of the transaction using Transaction ID.
BANFICO LTD provides the APIs for persisting certain information (mostly related to Response Reason Code, User Action, Date/Time of transaction) which is required to meet the Management Reporting requirements of Pay.UK. BANFICO LTD's CoP solution has the feature to use this data and generate the MI reports in the format specified by the regulator. A member of the organisation will be required to generate reports (periodically) and email/ submit them 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 Body
| Attribute | Type | Condition | Description |
|---|---|---|---|
| Data | CoPMILoggingData | Mandatory | Request to Log the Outcome Code using Transaction ID |
| Data.OutcomeCode | String | Mandatory | Allowed values: BTPT (Beneficiary setup and payment setup completed in same session), BTPF (Beneficiary setup complete but payment not made in same session), BFPF (Beneficiary setup incomplete) |
Response Codes
| Status Code | Description |
|---|---|
| 204 | Outcome code logged 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
PATCH /requester/v1.0/cop-iban-check/account-verifications/{Id}
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
Content-Type: application/json
{
"Data": {
"OutcomeCode": "BTPT"/"BTPF"/"BFPF"
}
}-
Response
HTTP/1.1 204 NO CONTENT