ResponseWrapperOTPSMSResponseDto

Generic API response wrapper

statusstring

Response status

Possible values: [SUCCESS, ERROR]

Example: ERROR/SUCCESS

messagestring

Message describing the response

Example: Request failed/Request successful

codeMessagestring

Code message describing the response

Example: ERR-001/SUC-001

data object

This DTO represents the response of the process of sending an OTP via SMS.

idinteger<int64>

The identifier of the signed bill payment request.

Example: 123456

billPaymentRequestIdinteger<int64>

The identifier associated with the bill payment request.

Example: 123456789

channelstring

channel used for payment

Possible values: [WEB, Mobile]

Example: web

signatureMethodstring

The method used for signing.

Possible values: [VIRTUAL_KEYBOARD, OTP_SMS]

Example: clavier virtuel

otpSentboolean

error object

Details of any error that occurred

codestring

Error code

Example: ERR-142

messagestring

Human-readable error message

Example: Resource not found

details object[]

List of error details

Array [

codestring

Specific error code

Example: ER4001

messagestring

What went wrong

Example: Invalid input

targetstring

Field that caused the issue

Example: username

]

suggestionsstring[]

Suggested fixes

Example: ["Check the resource ID","Ensure the resource exists"]

metaData object

Extra metadata to help debugging

property name*string

timestampstring<date-time>

Timestamp of when the response was generated

Example: 22024-10-14T14:28:11.284+01:00

ResponseWrapperOTPSMSResponseDto
{
  "status": "ERROR/SUCCESS",
  "message": "Request failed/Request successful",
  "codeMessage": "ERR-001/SUC-001",
  "data": {
    "id": 123456,
    "billPaymentRequestId": 123456789,
    "channel": "web",
    "signatureMethod": "clavier virtuel",
    "otpSent": true
  },
  "error": {
    "code": "ERR-142",
    "message": "Resource not found",
    "details": [
      {
        "code": "ER4001",
        "message": "Invalid input",
        "target": "username"
      },
      {
        "code": "ER4002",
        "message": "Missing field",
        "target": "email"
      }
    ],
    "suggestions": [
      "Check the resource ID",
      "Ensure the resource exists"
    ],
    "metaData": {}
  },
  "timestamp": "22024-10-14T14:28:11.284+01:00"
}

#ResponseWrapperOTPSMSResponseDto

ResponseWrapperOTPSMSResponseDto