This section describes how to retrieve the payment return status via a pacs.002 HTTP request to the Payments Hub API. To send this request, you need to provide the Payments Hub ID that you received in the response to the pacs.004, 007, 008 HTTP request, or that was provided in the notification (if you have it enabled). For information, see Notifications
Request
Create and send a request using the following operation:
GET https://sandbox.api.pagonxt.com/payments/pacs004/v09/{paymentsHubId}Headers
The request must contain the headers shown in the following table.
Header name | Description | Required/ Optional | Values |
|---|---|---|---|
X-Client-Id | Client ID | Required | <Client ID> |
Parameters
The request must contain the path parameter shown in the following table.
Parameter type | Parameter name | Description | Data format | Required/ Optional |
|---|---|---|---|---|
Path | paymentsHubId | Payments Hub ID related to the payment return whose details you want to retrieve. This is the value you received when you originally submitted the payment return request. | String | Required |
Response
If the request is valid, you receive an HTTP 200 OK response, which means that the payment return status was successfully retrieved. For further details of HTTP response codes and instructions on how to handle errors, see HTTP codes and request error handling. In addition to the response code, the response body returns the fIToFIPmtStsRpt JSON object, which contains a pacs.002 ISO message.
For details on all the response body elements, see Message field definition for pacs.002
Response
If the request is valid, you receive an HTTP 200 OK response, which means that the payment return status was successfully retrieved. For further details of HTTP response codes and instructions on how to handle errors, see HTTP codes and request error handling. In addition to the response code, the response body returns the fIToFIPmtStsRpt JSON object, which contains a pacs.002 ISO message.
For details on all the response body elements, see Message field definition for pacs.002 .
The following tutorials provide some specific examples