Webhook Configuration Endpoint

We recommend the configuration of a static webhook target endpoints via the merchant portal as outlined in Return URL and Instant Notification URL Configuration

Some use cases however may require the configuration and reconfiguration of this URL via an automatic process. The endpoint provided here can be used to programmatically reconfigure the:

notification callback URL and
return URL

URL	/api/order/setup
HTTP method	PUT

Request
Content-Type	application/json
Path Params	none
Query Params	none
Header Params	Authorization: Bearer <access token>
Body	CallbackURLSetupRequest - [JSON]

Example

Request

PUT /<path>/api/order/setup HTTP/1.1
Host: <host>
Authorization: Bearer 3ab8b859e58ef8528b169c86af2ca
Accept: application/json
Content-Type: application/json; charset=UTF-8

{
"returnUrl": "http://api.my-eshop.enkap.de/bestmov",
"notificationUrl": "http://api.my-eshop.enkap.de/bestmov/callback"
}

Response

HTTP/1.1 200 OK

Data Types

Input Data Types:

Name

Type

Required

Maximum Length

Description

returnUrl

string

Y

255

The URL to which the customer will be redirected once the payment has been completed on the e-Smobilpay for e-commerce portal. When invoking this URL, Smobilpay for e-commerce redirects the browser with the following URL:
<your return URL>/<your_reference_>?status=<status>
Where:

<your_reference_id>: is the unique reference id that is generated by your server and provided to Smobilpay for e-commerce in the initial order placement request.
<status>: gives you the current payment status.

Example:
returnUrl: http://api.my-eshop.enkap.de/bestmov
enhanced return URL by Smobilpay for e-commerce:
http://api.my-eshop.enkap.de/bestmov/32dd667-134grf0388?status=IN_PROGRESS

notificationUrl

string

Y

255

The callback URL to which Smobilpay for e-commerce will notify your e-Shop whenever the payment status has changed. When invoking this URL, Smobilpay for e-commerce calls your server with the following enhanced notification URL:
<notificationUrl>/<your_reference_id>
where:

<your_reference_id>: is the unique reference id that is generated by your server and provided to Smobilpay for e-commerce in the initial order placement request.