Endpoints

Payment confirmation screen

Returns the payment-confirmation screenshot (image/png) for a SUCCESSFUL transaction, scoped to the caller. On success the body is the PNG; failures return the standard JSON error envelope with a distinct status: 401 when the token is unknown or the transaction is not in your scope (the two are indistinguishable), 404 when a successful, in-scope transaction has no screenshot on file, and 400 when the transaction is not a successful payment so no status screen applies.

GET
/v1/transactions/{token}/status-screen

Authorization

bearerAuth
AuthorizationBearer <token>

A partner API token issued to a Master Account. Send Authorization: Bearer <token> on every request. Tokens are issued and revoked by a SuperAdmin in the backoffice, not through this API.

In: header

Path Parameters

token*string

The transaction token.

Response Body

image/png

application/json

application/json

application/json

application/json

"string"
{
  "error": {
    "code": "validation_failed",
    "message": "Invalid request: a status screen is only available for a successful transaction.",
    "requestid": "8f3c1a9b2d7e4f60"
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Access denied.",
    "requestid": "8f3c1a9b2d7e4f60"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "No status screen available.",
    "requestid": "8f3c1a9b2d7e4f60"
  }
}
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after the period indicated.",
    "requestid": "8f3c1a9b2d7e4f60"
  }
}

On this page