OPay Error Codes

The OPay initialize endpoint can return validation errors when a request fails validation.

Validation Error

If validation fails, the API returns HTTP 400 Bad Request.

{
    "status": false,
    "message": "The email field is required.",
    "error": {
        "email": ["The email field is required."],
        "amount": ["The amount field is required."]
    }
}

Error Fields

FieldTypeDescription
statusbooleanfalse when validation fails.
messagestringHuman-readable validation message.
errorobjectField-level validation errors.
error.emailarrayValidation errors for the email field.
error.amountarrayValidation errors for the amount field.

Request Validation Rules

ParameterTypeRequiredValidation Rules
emailstringRequiredValid email address, minimum 6 characters
amountnumericRequiredMinimum value: 1
referencestringOptionalMin 16 characters, max 33 characters
first_namestringOptionalMaximum 100 characters
last_namestringOptionalMaximum 100 characters
callbackUrlstringOptionalMust be a valid URL