# Payment status update

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



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"

## 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, required)

  - `data.orderCode` (string, required)
    order number. Caution! This does not have to be number only, it can contain also letters, dash, etc.

  - `data.returnUrl` (string, required)
    URL, where the payment gateway should be redirected to, after the payment is completed

  - `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