Batch payment order status API call flow (PISP)

API history

This API allows to get actual status of initiated batch payment order.


Step 1: Use the access token with the scope PISP
Obtaining access token can be based on SCA by OAuth 2.0 Authorization code grant flow (SCA) or on OAuth 2.0 Client credentials grant flow (Token by secret). See Authorization API section.


Step 2: Get the batch payment order status
Initiate GET request for Batch payment order status with valid access token and BatchId of initiated bytch payment order:

Batch payment order status
Version1
URL LIVE
URL SANDBOX
GET https://api.csob.sk/pisp/api/v1/payments/{batchId}/batchStatus
GET https://api.csob.sk/pisp-test/api/v1/payments/{batchId}/batchStatus

Status of initiated batch payment order is exchanged between bank and third party provider, which is obliged to provide this status to the client in his application. Payment order status is available during payment order processing and 7 days after its final status. After this period, payment status will no longer exist for this service. Batch payment order status service will return only statuses of payment orders which are active or final status is no older than 7 days. On API Explorer web site there is a possibility to test the API online (Try it) and download API definition (WADL, Open API).


Request:

Header

Attributes structure
Optionality
Type
Description
Authorization
Mandatory
String
Authorization is defined in RFC 6750 - The OAuth 2.0 Authorization Framework: Bearer Token Usage
Access token from step 1 wit the scope PISP must be used.
Request-ID
Mandatory
String
A unique identifier of a particular request message. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Identifier (UUID) version 4 form (RFC4122).
Correlation-ID
Optional
String
A unique correlation identifier correlates the request and the response messages as a pair especially useful for audit logs. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Identifier (UUID) version 4 form (RFC4122).
Process-ID
Optional
String
Identifier of a business or technical process to what the set of requests and response pairs are organized (e.g. paging of transaction history should have same ProcessID). Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Identifier (UUID) version 4 form (RFC4122).
PSU–IP-Address
Mandatory
String
Identifier of a customer’s IP address from which he/she is connected to the TPP infrastructure. It might be in the format of IPv4 o IPv6 address.
ASPSP shall indicate which values are acceptable.
PSU-Device-OS
Mandatory
String
A customer’s device and/or operating system identification from which he/she is connected to the TPP infrastructure.
PSU-User-Agent
Mandatory
String
A customer’s web browser of other client device identification from which he/she is connected to the TPP infrastructure. Agent header field of the http request between PSU and TPP.)
PSU-GeoLocation
Optional
String
The GPS coordinates of the current customer’s location in the moment of connection to the TPP infrastructure. (Required GPS format: Latitude, Longitude)
PSU-Last-Logged-Time
Optional
DateTime
Last date and time when user was logged to TPP app (RFC3339 format).

Body

Payload is empty


Response:

Header

Attributes structure
Optionality
Type
Description
Content-Type
Mandatory
String
application/xml
Response-ID
Mandatory
String
An unique identifier of a particular request message. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122).
Correlation-ID
Optional
String
A unique correlation identifier correlates the request and the response messages as a pair especially useful for audit logs. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Identifier (UUID) version 4 form (RFC4122).
Process-ID
Optional
String
Identifier of a business or technical process to what the set of requests and response pairs are organized (e.g. paging of transaction history should have same ProcessID). Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Identifier (UUID) version 4 form (RFC4122).

Body

XML response according to ISO20022 pain.002.001.03:

Definition: pain.002.001.03.CSOBv1.1.xlsx
Schema: pain.002.001.03.xsd

Response is composed according to schema pain.002.001.03.xsd. Any of the field stated in this schema can be used in response. TPP should be able to process every response which is valid acording to this schema.

Example:

Request

GET https://api.csob.sk/pisp/api/v1/payments/SPIqFjuDqTpgUea3bWW2Rnq3f/batchStatus HTTP/1.1
Accept-Encoding: gzip,deflate
Authorization: nfLnmy5hGQrNKbPnfAasw2FDVw4fw6kWjVapMVa9zJw8emNvTU
Request-ID: 9414566785
Correlation-ID: 7196793210
Process-ID: 3464679206
PSU-IP-Address: 192.168.8.1
PSU-Device-OS: MAC
PSU-User-Agent: Safari
PSU-Geo-Location: 2.050279, 45.338591
PSU-Last-Logged-Time: 2021-03-07T10:22:31+01:00
Host: api.csob.sk
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

Response

HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Transfer-Encoding: chunked
Content-Length: 1093
Content-Type: application/xml
Content-Encoding: gzip
Expires: -1
Vary: Accept-Encoding
Server-Process-ID: d3HFNv3CEEua2cvR8uLqX3gdxf6NTabB
Process-ID: 3464679206
Correlation-ID: 7196793210
Response-ID: 9414566785
Strict-Transport-Security: max-age=31536000; includeSubDomains
Date: Mon, 08 Mar 2021 09:22:34 GMT 
<Document xsi:schemaLocation="urn:iso:std:iso:20022:tech:xsd:pain.002.001.03 pain.002.001.03.xsd" xmlns="urn:iso:std:iso:20022:tech:xsd:pain.002.001.03" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <CstmrPmtStsRpt>
        <GrpHdr>
            <MsgId>GPSqFjuDqTpgUea3bWW2Rnq3f</MsgId>
            <CreDtTm>2021-03-08T10:22:34+01:00</CreDtTm>
        </GrpHdr>
        <OrgnlGrpInfAndSts>
            <OrgnlMsgId>MCCT1803221557465327386x</OrgnlMsgId>
            <OrgnlMsgNmId>pain.001.001.03</OrgnlMsgNmId>
            <GrpSts>ACSC</GrpSts>
        </OrgnlGrpInfAndSts>
        <OrgnlPmtInfAndSts>
            <OrgnlPmtInfId>18032200002</OrgnlPmtInfId>
            <PmtInfSts>ACSC</PmtInfSts>
            <TxInfAndSts>
                <OrgnlInstrId>PAYORD20190315000001</OrgnlInstrId>
                <TxSts>ACSC</TxSts>
                <AcctSvcrRef>qFjuDqTpgUea3bWW2Rnq3f</AcctSvcrRef>
            </TxInfAndSts>
            <TxInfAndSts>
                <OrgnlInstrId>PAYORD20190315000002</OrgnlInstrId>
                <TxSts>ACSC</TxSts>
                <AcctSvcrRef>npLvnFaYtYUw0D5fjrTS</AcctSvcrRef>
            </TxInfAndSts>
        </OrgnlPmtInfAndSts>
    </CstmrPmtStsRpt>
</Document>