GET {API_URL}/{reference}), return the appropriate error code so VTPE can inform the customer about what went wrong. This page documents the three required error responses.
Error Response Format
All error responses from your Product Information API must use this JSON structure:error field is the machine-readable code that VTPE uses to determine the error type. The errorMessage field is displayed to the customer.
Error Codes
NOT_FOUND (404)
Return this error when the requested reference does not exist in your system.ALREADY_PAID (409)
Return this error when payment was already completed for this reference. This prevents the customer from paying twice for the same order.SERVICE_UNAVAILABLE (503)
Return this error when your service is temporarily unable to respond, for example during maintenance or an outage.VTPE uses the
errorMessage value to inform the customer. Use clear, concise messages so the customer understands what went wrong.