Response Model

View as Markdown

Most Pay4Power responses use a consistent envelope so your integration can handle success, validation, and processing states predictably.

FieldMeaning
successIndicates whether the API request was accepted or completed successfully.
messageHuman-readable status or error summary.
errorsNull on success, otherwise an array of error details.
statusCodeHTTP-style status code returned inside the response body.
correlationIdIdentifier useful for support, tracing, and reconciliation.
dataProduct-specific response payload.

Success handling

Use both HTTP status and the response body. A successful HTTP response can still represent a business-level pending or failed state depending on the endpoint and payload.

Pending handling

When a vend endpoint returns a pending or accepted response, store the transaction reference and call the requery endpoint until the transaction reaches a final state.

Error handling

Display clear, product-specific errors to operators or customers, but keep raw correlationId values in your logs so support can trace the request.