Skip to content

Gaining the information about payment

Request

Returns the URL, at which the payment gateway shall redirect the users after completion of operation and order number.

Security
shoptetAccessToken or shoptetPrivateApiToken
Path
paymentCodestringrequired

the 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 the e-shop to the payment gateway.

Example:os8FtURz7PpO46Z87euEAoBAn9RClB2d
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/payment-status/os8FtURz7PpO46Z87euEAoBAn9RClB2d \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "orderCode": "2018000016",
    "returnUrl": "https://www.domena-eshopu.cz/api/pay/apigate/return?paymentCode=os8FtURz7PpO46Z87euEAoBAn9RClB2d"
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}