The connection URL for the sandbox server is:
https://[server-name]/reports/[report-name].[report-format]?[parameters], where
- [report-name] is a name of a report;
- [report-format] - format in which the report is generated, see integration notes for more information;
- [parameters] - fields in the report request, indicating what data is going to be included in the report.
For example, to generate a
merchant-statement-list report in the CSV format, connection URL should look similar to the following one:
https://[server-name]/reports/merchant-statement-list.csv?userName=myUsername&password=myP%40ssword&fromDate=10180101&toDate=20180131&accountId=2001
Authorization is done via service users. To access the API, a service user is required to be granted with a corresponding privilege. A user can submit API requests using either associated credentials or temporary password generated via authentication operation.
When submitting an API request, you can use either UniPay server URL or the Sanitizing Data Filter (Unibroker) server URL as an endpoint.
Requests that contain tokenized card numbers/bank account numbers can be submitted directly to {Unipay} server.
To reduce PCI exposure, requests with non-tokenized (raw) account data should be passed through the sanitizing data filter server. Otherwise,
L04 error will be returned (Processing of raw account data is not allowed through the specified API end-point for the current user).
If you don’t have a specific reason, we recommend sending all the requests to the same endpoint (data filter).
To learn more about service users and end-points used for API submission, review
Security Management guide.
See
Security Management guide for more information.
Request method is
GET. The content-type must be set to
application/x-www-form-urlencoded.
Request fields are passed within HTTPS request body (including cases with callbacks) and are required to be URL-encoded.
Response fields are passed within HTTPS response body.
Both request and response field values are passed using
name1=key1&name2=key2 format.
