Setting up and using the callback service

Callback status re-poll service
The callback service is a service within the framework of which WS2MPI processes client requests as follows:
• initiates re-poll on the status of the operation execution in the event that the client has not received a response to the request received from it;
• initiates sending the re-poll result to the client.
The callback status re-poll service can be used only for WS2MPI methods:
p2pTransfer transfer
p2pTransfer a2c
p2pTransfer c2a
Payment
The label for using the callback service by a specific client is configured at the client's request in the WS2MPI system configuration file.

Clarification on the logic of the mechanism:

for each ExtSystemid, its own callback URL is configured (if this was specified during registration).

during the request execution, if we see that the client has not received a response with the final status of the operation, a watch dog is set up on our side, which monitors the payment status.

as soon as the payment status changes, our service calls the method specified in the settings for this ExtSystemid with a minimum set of data (see the structure of the callback request body)

after that, to obtain detailed information about this operation, you can make a request to the corresponding method (/ConfirmExt).

After receiving a successful response with the value of the OrderStatus field = 1 or 2 or after sending the maximum allowed number of requests, the service:
a) callback generates and sends a POST request to the client with the following structure:
• request body:

Callback request body

№	Tag name	Data type	Mandatory	Description
1	orderNumber	ANS 1..32	Yes	Order number (identifier) in the seller's online store system. Unique for each store in the system and generated when registering an order
2	respStatus	N3	Yes	Request processing status
3	orderStatus	N1	No	Order status generated after order registration. Available if respStatus = 200.
4	orderId	ANS 1..36	No	Order number received during order registration.

b) callback accepts a response from the client with the following structure:
• response body:

Response body for callback service

№	Tag name	Data type	Mandatory	Description
1	orderNumber	ANS 1..32	Yes	Order number (identifier) in the seller's online store system. Unique for each store in the system and generated when registering an order.
2	applicationStatus	N3	Yes	Request processing status

If the response message has applicationStatus ≠ 200, WS2MPI sends repeated POST requests every h milliseconds, the maximum allowable number of requests is k, until a corresponding message with applicationStatus = 200 is received or until the maximum allowable number of requests is sent.

Setting up and using the callback service

Callback request body#

Response body for callback service#

Callback request body

Response body for callback service