Response Code

Generic API Error

HTTP Method	Error Type	Error Code	Message	Scenario
400	API_ERROR	api_validation_error	The request was invalid, or an error occurred in downstream provider	User hit any endpoints with invalid payload
401	API_ERROR	credentials_invalid	Access token is invalid, please verify that the authentication is provided and valid	User hit any endpoints but can't authenticate its API Access
403	API_ERROR	resource_not_complete	Please verify that the setup is complete	User hit any endpoints but not set mandatory setup like redirect url, etc
403	API_ERROR	forbidden_access	Provided API Key does not have the correct permissions to perform the operation	User is already authenticated but hit endpoints which out of scope of the authorization
404	GATEWAY_ERROR	not_found	The requested URL does not exist	User is already authenticated but hit wrong endpoints
404	GATEWAY_ERROR	resource_missing	The $resource with ID $id cannot be found	User is already authenticated but can't found the resources with specific ID
409	GATEWAY_ERROR	duplicate_error	There's already existing record with the provided details	User is already authenticated and send payload request which conflicted with existing resource
409	API_ERROR	idempotency_error	The same Idempotency-key was provided with a different payload	User is already authenticated and send same idempotency key with different payload request, can be different data or different endpoint
429	API_ERROR	frequency_above_limit	The frequency limit of $resource is reached for operation $operation	User hit same endpoints repeatedly many times in short period
500	GATEWAY_ERROR	internal_error	An internal error was encountered. Please Try again later	User is hit any endpoints but the pivot's server has encountered a problem
502	GATEWAY_ERROR	bad_gateway	An internal error was encountered. Please Try again later	User is hit any endpoints but the pivot's server has encountered a problem
503	GATEWAY_ERROR	service_unavailable	An internal error was encountered. Please Try again later	User is hit any endpoints but the pivot's server has encountered a problem
504	GATEWAY_ERROR	gateway_timeout	An internal error was encountered. Please Try again later	User is hit any endpoints but the pivot's server has encountered a problem

Response Code

Response Code	Response Message	Error Object
00	success	-
credentials_invalid	Access token is invalid	{ "error": { "type": "API_ERROR", "details": [ { "field": "", "message": "Request new access token" } ], "traceId": "{trace id}" } }
api_validation_error	The request was invalid, or an error occurred in downstream provider	{ "error": { "type": "API_ERROR", "details": [ { "field": "recipientID", "message": "Make sure recipientID format is correct" }, { "field": "referenceID", "message": "Make sure referenceID value is fulfilled" } ], "traceId": "7fadd95da98e59cfad5148382095f2c1" } }
field_required	Mandatory Field is Missing	{ "error": { "type": "API_ERROR", "details": [ { "field": "{field name}", "message": "Make sure {field name} value is fulfilled" } ], "traceId": "{trace id}" } }
resource_already_exists	ID is already exists	{ "error": { "type": "API_ERROR", "details": [ { "field": "{field name}", "message": "Use unique {field name}" } ], "traceId": "{trace id}" } }
invalid_recepient	Receepient ID is invalid	{ "error": { "type": "API_ERROR", "details": [ { "field": "", "message": "Make sure the Recipient ID is correct" } ], "trace_id": "{trace id}" } }
insufficient_fund	Insufficient balance for Transfer	{ "error": { "type": "API_ERROR", "details": [ { "field": "", "message": "Make sure balance is sufficient for Transfer" } ], "trace_id": "{trace id}" } }
resend_failed	Resend Invitation Failed: User Is Invalid	{ "error": { "type": "API_ERROR", "details": [ { "field": "", "message": "Cannot resend invitation: the user is invalid or no longer eligible for an invitation" } ], "traceId": "{trace id}" } }
resend_failed	Resend Invitation Failed: User Already Active	{ "error": { "type": "API_ERROR", "details": [ { "field": "", "message": "Cannot resend invitation: the user is already active" } ], "traceId": "{trace id}" } }
topup_va_failed	Failed to Generate Virtual Account for Topup	{ "error": { "type": "API_ERROR", "details": [ { "field": "", "message": "Failed to generate VA for topup" } ], "traceId": "{trace id}" } }
assign_user_failed	Assign Admin User: Email Already Exist	{ "error": { "type": "API_ERROR", "details": [ { "field": "", "message": "Cannot assign admin user: the email is already exists" } ], "traceId": "{trace id}" } }
general_error	General Error	{ "error": { "type": "API_ERROR", "details": [ { "field": "", "message": "Please contact our representative team" } ], "traceId": "{trace id}" } }