Skip to content

Payment status update

Request

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.

Security
shoptetAccessToken or shoptetPrivateApiToken
Path
paymentCodestringrequired

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
suppressDocumentGenerationboolean

suppress the generation of linked documents.

Default:false
Example:suppressDocumentGeneration=true
suppressEmailSendingboolean

suppress sending the linked information e-mails.

Default:false
Example:suppressEmailSending=true
Headers
Content-Typestringrequired
Default:"application/json"
Bodyapplication/json
dataobjectrequired
curl -i -X PATCH \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/payment-status/os8FtURz7PpO46Z87euEAoBAn9RClB2d?suppressDocumentGeneration=true&suppressEmailSending=true' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "status": "OK",
      "message": "Not enough finances on the card"
    }
  }'

Responses

OK

Bodyapplication/json
dataobject or nullrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {},
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}