# Payment status update

Payment status update via the payment gateway. The paymentCode is the
identifier. Payment status can be updated when the payment has been
successfully recorded.

Please note that message can not be longer than 255 characters.

Endpoint: PATCH /api/payment-status/{paymentCode}
Version: 1.0.0
Security: shoptetAccessToken, shoptetPrivateApiToken

## Path parameters:

  - `paymentCode` (string, required)
    payment code identifies the payment of a single order,
it is generated when the order is completed and received by the payment gateway upon redirection from e-shop to the payment gateway.
    Example: "os8FtURz7PpO46Z87euEAoBAn9RClB2d"

## Query parameters:

  - `suppressDocumentGeneration` (boolean)
    suppress the generation of linked documents.
    Example: true

  - `suppressEmailSending` (boolean)
    suppress sending the linked information e-mails.
    Example: true

## Header parameters:

  - `Content-Type` (string, required)

## Request fields (application/json):

  - `data` (object, required)

  - `data.status` (string, required)
    transaction status
    Enum: "FAILED", "OK", "PENDING"

  - `data.message` (string,null)
    Explanation of the status

## Response 200 fields (application/json):

  - `data` (object,null, required)

  - `errors` (array,null, required)

  - `errors.errorCode` (string, required)
    Short text error identification

  - `errors.message` (string, required)
    Descriptive error message

  - `errors.instance` (string, required)
    Identification of the entity referenced

## Response 404 fields (application/json):

  - `data` (object,null)

  - `errors` (array,null)

  - `errors.errorCode` (string, required)
    Short text error identification

  - `errors.message` (string, required)
    Descriptive error message

  - `errors.instance` (string, required)
    Identification of the entity referenced

## Response 422 fields (application/json):

  - `data` (object,null)

  - `errors` (array,null)

  - `errors.errorCode` (string, required)
    Short text error identification

  - `errors.message` (string, required)
    Descriptive error message

  - `errors.instance` (string, required)
    Identification of the entity referenced