Receives a PayHub server-to-server settlement webhook. Requires the `x-companyid` header (forwarded by the Shop BFF, which resolves the tenant from the storefront domain); it scopes the ReferenceCode/PendingPayment lookup to the tenant partition. Idempote

POST

/api/payments/PayHub/webhook

Request

Header Params

Body Params

application/json-patch+json

Example

{
    "paymentRequestId": 0,
    "paymentId": 0,
    "provider": "string",
    "bankOrderId": "string",
    "amount": 0,
    "type": "string",
    "paymentRequestCode": "string",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "metadata": {
        "property1": null,
        "property2": null
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://platform.shopranos.eu/api/payments/PayHub/webhook' \
--header 'X-Shopranos-Webhook-Secret;' \
--header 'Content-Type: application/json-patch+json' \
--data '{
    "paymentRequestId": 0,
    "paymentId": 0,
    "provider": "string",
    "bankOrderId": "string",
    "amount": 0,
    "type": "string",
    "paymentRequestCode": "string",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "metadata": {
        "property1": null,
        "property2": null
    }
}'

Responses

🟢200

application/json

Webhook processed successfully (or already processed).

Body

Example

{
    "id": "string",
    "checkoutToken": "string",
    "status": "Submitted",
    "provider": "OnePay",
    "providerId": "string",
    "amount": 0,
    "paymentDate": "2019-08-24T14:15:22.123Z",
    "transactionId": "string",
    "approvalCode": "string",
    "cardType": "Other",
    "cardNumber": "string",
    "bankId": "string",
    "installments": 0,
    "postDating": 0
}

🟠400

Modified at 2026-10-06 10:08:22

Initiates a PayHub payment request and returns the hosted payment page URL (Paylink). The shopper pays via bank RF or mobile app, then is redirected back to the shop.

Success return: resolves a PayHub payment request to its checkout and settlement state. PayHub appends `paymentRequestId` to the registration's returnUrlOk and forwards the `ref` the platform appended to the Paylink. When the payment is still pending loca