diff --git a/digifi_swagger.json b/digifi_swagger.json index 18a8f53..9d5e0e3 100644 --- a/digifi_swagger.json +++ b/digifi_swagger.json @@ -312,6 +312,53 @@ ] } }, + "/CustomerConsent": { + "post": { + "tags": [ + "CustomerConsent" + ], + "summary": "Customer Consent Request", + "description": "Customer Consent Request", + "operationId": "customerConsentRequest", + "requestBody": { + "description": "Post JSON for customer consent", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerConsentRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerConsentResponse" + } + } + } + }, + "400": { + "description": "Invalid request parameters" + }, + "404": { + "description": "Resource not found" + }, + "422": { + "description": "Validation exception" + } + }, + "security": [ + { + "basicAuth": [] + } + ] + } + }, "/NotificationCallback": { "post": { @@ -1020,6 +1067,75 @@ "description": "Description of provided result code" } } + }, + "CustomerConsentRequest": { + "type": "object", + "required": [ + "$type", + "transactionId", + "customerId", + "accountId", + "requestTime", + "consentType", + "channel" + ], + "properties": { + "$type": { + "type": "string", + "example": "CustomerConsentRequest", + "description": "Value is fixed to 'CustomerConsentRequest'" + }, + "transactionId": { + "type": "string", + "example": "20171209232177", + "description": "Unique identifier of transaction in FIRSTBANK system" + }, + "customerId": { + "type": "string", + "example": "CN621868", + "description": "Unique identifier of a customer" + }, + "accountId": { + "type": "string", + "example": "ACN8263457", + "description": "Specific identifier of a user's account" + }, + "requestTime": { + "type": "string", + "format": "date-time", + "example": "2019-10-18 14:26:21.063", + "description": "Date and time of consent request" + }, + "consentType": { + "type": "string", + "example": "Revoke", + "description": "'Enable' or 'Revoke'" + }, + "channel": { + "type": "string", + "example": "USSD", + "description": "Request channel: 'USSD' or 'APP'" + } + } + }, + "CustomerConsentResponse": { + "type": "object", + "required": [ + "resultCode", + "resultDescription" + ], + "properties": { + "resultCode": { + "type": "string", + "example": "00", + "description": "Result code of executed transaction" + }, + "resultDescription": { + "type": "string", + "example": "Request is received", + "description": "Description of provided result code" + } + } } }, "securitySchemes": {