Get Payment Order Status

Get payment order status functionality provides user with the possibility to check the status of any
imported single or batch payment order. In case a batch payment order status is requested - this interface
in addition provides (if available at given moment) information about each payment order in the imported
batch: position (this element matches the position element in ImportBatchPaymentOrderRequestIo),
paymentId assigned to the payment order by Bank's digital channel (Internet/Mobile banking; DBI integration service) and status of the payment order.

📘
In this web service the Nonce element in security header is not required!

Interface Specification

Attribute	Type	Comment
singlePaymentId	Long	Single payment ID
batchPaymentId	Long	Batch payment ID

🚧
Only one of the two attributes (singlePaymentId or batchPaymentId) must be supplied. In case none or both attributes are sent to the Web Service will return a SOAP fault.

❗️
Example 1:Both SinglePaymentId and BatchPaymentId Are Sent To The Web Service

<s:Envelope
	xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
	<s:Header/>
	<s:Body>
		<s:Fault>
			<faultcode
				xmlns:a="http://www.mygemini.com/schemas/mygemini">a:INCORRECT_INPUT_DATA
			</faultcode>
			<faultstring xml:lang="en">Both IDs cannot be filled at the same time.</faultstring>
		</s:Fault>
	</s:Body>
</s:Envelope>

Example 2: Valid Get Payment Order Status Request (Single Payment)

<soapenv:Envelope
	xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
	xmlns:myg="http://www.mygemini.com/schemas/mygemini"
	xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<soapenv:Header>
		<wsse:Security>
			<wsse:UsernameToken>
				<wsse:Username>USERNAME</wsse:Username>
				<wsse:Password>PASSWORD</wsse:Password>
			</wsse:UsernameToken>
		</wsse:Security>
	</soapenv:Header>
	<soapenv:Body>
		<myg:GetPaymentOrderStatusRequestIo>
			<myg:singlePaymentId>541202011</myg:singlePaymentId>
		</myg:GetPaymentOrderStatusRequestIo>
	</soapenv:Body>
</soapenv:Envelope>

Example 3: Valid Get Payment Order Status Request (Batch Payment)

<soapenv:Envelope
	xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
	xmlns:myg="http://www.mygemini.com/schemas/mygemini"
	xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<soapenv:Header>
		<wsse:Security>
			<wsse:UsernameToken>
				<wsse:Username>USERNAME</wsse:Username>
				<wsse:Password>PASSWORD</wsse:Password>
			</wsse:UsernameToken>
		</wsse:Security>
	</soapenv:Header>
	<soapenv:Body>
		<myg:GetPaymentOrderStatusRequestIo>
			<myg:batchPaymentId>541202011</myg:batchPaymentId>
		</myg:GetPaymentOrderStatusRequestIo>
	</soapenv:Body>
</soapenv:Envelope>

Single Payments Status Catalog

Status	Definition
I	Initial state
DR	Draft
G	Registered
D	Deleted
WC	Waiting for certification
CERT	In progress
VERIF	In progress
CPE	Error
WS	In progress
F	Finished
FL	Failed
C	Cancelled

Batch Payments Status Catalog

Status	Definition
INIT	Uploading
REGISTERED	Registered
WAITING_FOR_CERTIFICATION	Waiting for certification
CERTIFIED	In progress
VERIFIED	In progress
FINISHED	Finished
FINISHED_WITH_ERRORS	Finished with errors
FAILED	Failed
CANCELLED	Cancelled
ERROR	Error

Payment Status DataIo

Attribute	Type	Comment
position	Integer	Position of given payment order in Single payment and Batch import request
paymentId	String	Payment order ID assigned by Bank's digital channel (Internet/Mobile banking; DBI integration service)
paymentStatus	String	Current status of payment order (for values see catalogs above)
errorDetailEN	String	Detail of error in English
errorDetailGE	String	Detail of error in Georgian

List of response attributes in Payment Order Status Web Service

Attribute	Type	Comment
status	status	Current status of payment (for values see catalogs above)
singlePaymentData	[PaymentStatus DataIo](Payment Status DataIo)	In case singlePaymentId is supplied in the GetPaymentOrderStatusRequestIo and the single payment is in some error status, this element will be included in the response and will contain errorDetailEN/GE elements.
batchPaymentData	[PaymentStatus DataIo](Payment Status DataIo)	In case batchPaymentId is supplied in the GetPaymentOrderStatusRequestIo and the batch has been processed, one such element is provided for each payment in the imported batch.

There are 4 Possible Scenarios When Getting Status Of Batch Payment:

Batch is in REGISTERED, WAITING_FOR_CERTIFICATION, CERTIFIED, VERIFIED or FINISHED status – in such case all payment orders in the batch will be returned and batchPaymentData elements will contain: position, paymentId, paymentStatus;
Batch is in FINISHED_WITH_ERRORS status (some payment orders in the batch are in finished status and others are in failed status) or in FAILED status (all payment orders in the batch are in failed status) - all payment orders in the batch will be returned and batchPaymentData elements will contain:
a. for finished payments: position, paymentId, paymentStatus;
b. for failed payments: position, paymentId, paymentStatus, errorDetailEN, errorDetailGE;
Batch is in ERROR status - only payment orders with errors will be returned and batchPaymentData elements will contain: position, errorDetailEN, errorDetailGE;
Batch is in CANCELLED status - only batch status will be returned, no batchPaymentData elements will be returned in the response.

Example 4: Single Payment In Failed Status

<SOAP-ENV:Envelope
	xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
	xmlns:ns2="http://www.mygemini.com/schemas/mygemini">
	<SOAP-ENV:Header/>
	<SOAP-ENV:Body>
		<ns2:GetPaymentOrderStatusResponseIo
			xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
			xmlns:xsd="http://www.w3.org/2001/XMLSchema">
            <ns2:status>FL</ns2:status>
            <ns2:singlePaymentData>
                <ns2:errorDetailEN>Supplied currency differs from accounts's currency.</ns2:errorDetailEN>
                <ns2:errorDetailGE>მითითებული ვალუტა განსხვავდება ანგარიშის ვალუტისაგან.</ns2:errorDetailGE>
            </ns2:singlePaymentData>
        </ns2:GetPaymentOrderStatusResponseIo>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example 5: Single Payment In Finished Status

<SOAP-ENV:Envelope
	xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
	xmlns:ns2="http://www.mygemini.com/schemas/mygemini">
	<SOAP-ENV:Header/>
	<SOAP-ENV:Body>
		<ns2:GetPaymentOrderStatusResponseIo
			xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
			xmlns:xsd="http://www.w3.org/2001/XMLSchema">
            <ns2:status>F</ns2:status>
        </ns2:GetPaymentOrderStatusResponseIo>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example 6:Single Payment In Canceled Status

<SOAP-ENV:Envelope
	xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
	xmlns:ns2="http://www.mygemini.com/schemas/mygemini">
	<SOAP-ENV:Header/>
	<SOAP-ENV:Body>
		<ns2:GetPaymentOrderStatusResponseIo
			xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
			xmlns:xsd="http://www.w3.org/2001/XMLSchema">
            <ns2:status>C</ns2:status>
        </ns2:GetPaymentOrderStatusResponseIo>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example 7: Single Payment In Waiting For Certification Status

<SOAP-ENV:Envelope
	xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
	xmlns:ns2="http://www.mygemini.com/schemas/mygemini">
	<SOAP-ENV:Header/>
	<SOAP-ENV:Body>
		<ns2:GetPaymentOrderStatusResponseIo
			xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
			xmlns:xsd="http://www.w3.org/2001/XMLSchema">
            <ns2:status>WC</ns2:status>
        </ns2:GetPaymentOrderStatusResponseIo>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example 8: Single Payment In Verified Status

<SOAP-ENV:Envelope
	xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
	xmlns:ns2="http://www.mygemini.com/schemas/mygemini">
	<SOAP-ENV:Header/>
	<SOAP-ENV:Body>
		<ns2:GetPaymentOrderStatusResponseIo
			xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
			xmlns:xsd="http://www.w3.org/2001/XMLSchema">
            <ns2:status>VERIF</ns2:status>
        </ns2:GetPaymentOrderStatusResponseIo>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example 9: Batch in Error Status

<SOAP-ENV:Envelope
	xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
	xmlns:ns2="http://www.mygemini.com/schemas/mygemini">
	<SOAP-ENV:Header/>
	<SOAP-ENV:Body>
		<ns2:GetPaymentOrderStatusResponseIo
			xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
			xmlns:xsd="http://www.w3.org/2001/XMLSchema">
			<ns2:status>ERROR</ns2:status>
			<ns2:batchPaymentData>
				<ns2:position>1</ns2:position>
				<ns2:errorDetailEN>incorrect value in ReceiverName - . waiting for correction;</ns2:errorDetailEN>
				<ns2:errorDetailGE>არასწორი ReceiverName - . საჭიროებს რედაქტირებას;</ns2:errorDetailGE>
			</ns2:batchPaymentData>
		</ns2:GetPaymentOrderStatusResponseIo>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example 10: Batch In Waiting For Certification Status

<SOAP-ENV:Envelope
	xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
	xmlns:ns2="http://www.mygemini.com/schemas/mygemini">
	<SOAP-ENV:Header/>
	<SOAP-ENV:Body>
		<ns2:GetPaymentOrderStatusResponseIo
			xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
			xmlns:xsd="http://www.w3.org/2001/XMLSchema">
            <ns2:status>WAITING_FOR_CERTIFICATION</ns2:status>
            <ns2:batchPaymentData>
                <ns2:position>4</ns2:position>
                <ns2:paymentId>541202058</ns2:paymentId>
                <ns2:paymentStatus>G</ns2:paymentStatus>
            </ns2:batchPaymentData>
        </ns2:GetPaymentOrderStatusResponseIo>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example 11: Batch In Canceled Status

<SOAP-ENV:Envelope
	xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
	xmlns:ns2="http://www.mygemini.com/schemas/mygemini">
	<SOAP-ENV:Header/>
	<SOAP-ENV:Body>
		<ns2:GetPaymentOrderStatusResponseIo
			xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
			xmlns:xsd="http://www.w3.org/2001/XMLSchema">
            <ns2:status>CANCELLED</ns2:status>
        </ns2:GetPaymentOrderStatusResponseIo>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example 12: Batch In verified Status

<SOAP-ENV:Envelope
	xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
	xmlns:ns2="http://www.mygemini.com/schemas/mygemini">
	<SOAP-ENV:Header/>
	<SOAP-ENV:Body>
		<ns2:GetPaymentOrderStatusResponseIo
			xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
			xmlns:xsd="http://www.w3.org/2001/XMLSchema">
            <ns2:status>VERIFIED</ns2:status>
            <ns2:batchPaymentData>
                <ns2:position>4</ns2:position>
                <ns2:paymentId>541202078</ns2:paymentId>
                <ns2:paymentStatus>F</ns2:paymentStatus>
            </ns2:batchPaymentData>
        </ns2:GetPaymentOrderStatusResponseIo>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example 13: Batch In Finished Status

<SOAP-ENV:Envelope
	xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
	xmlns:ns2="http://www.mygemini.com/schemas/mygemini">
	<SOAP-ENV:Header/>
	<SOAP-ENV:Body>
		<ns2:GetPaymentOrderStatusResponseIo
			xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
			xmlns:xsd="http://www.w3.org/2001/XMLSchema">
            <ns2:status>FINISHED</ns2:status>
            <ns2:batchPaymentData>
                <ns2:position>4</ns2:position>
                <ns2:paymentId>541202078</ns2:paymentId>
                <ns2:paymentStatus>F</ns2:paymentStatus>
            </ns2:batchPaymentData>
        </ns2:GetPaymentOrderStatusResponseIo>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Payment Order Status

Get Payment Order Status

📘
In this web service the Nonce element in security header is not required!

Interface Specification

🚧
Only one of the two attributes (singlePaymentId or batchPaymentId) must be supplied. In case none or both attributes are sent to the Web Service will return a SOAP fault.

❗️
Example 1:Both SinglePaymentId and BatchPaymentId Are Sent To The Web Service

Example 2: Valid Get Payment Order Status Request (Single Payment)

Example 3: Valid Get Payment Order Status Request (Batch Payment)

Single Payments Status Catalog

Batch Payments Status Catalog

Payment Status DataIo

List of response attributes in Payment Order Status Web Service

There are 4 Possible Scenarios When Getting Status Of Batch Payment:

Example 4: Single Payment In Failed Status

Example 5: Single Payment In Finished Status

Example 6:Single Payment In Canceled Status

Example 7: Single Payment In Waiting For Certification Status

Example 8: Single Payment In Verified Status

Example 9: Batch in Error Status

Example 10: Batch In Waiting For Certification Status

Example 11: Batch In Canceled Status

Example 12: Batch In verified Status

Example 13: Batch In Finished Status

Get Payment Order Status

📘In this web service the Nonce element in security header is not required!

Interface Specification

🚧Only one of the two attributes (singlePaymentId or batchPaymentId) must be supplied. In case none or both attributes are sent to the Web Service will return a SOAP fault.

❗️Example 1:Both SinglePaymentId and BatchPaymentId Are Sent To The Web Service

Example 2: Valid Get Payment Order Status Request (Single Payment)

Example 3: Valid Get Payment Order Status Request (Batch Payment)

Single Payments Status Catalog

Batch Payments Status Catalog

Payment Status DataIo

List of response attributes in Payment Order Status Web Service

There are 4 Possible Scenarios When Getting Status Of Batch Payment:

Example 4: Single Payment In Failed Status

Example 5: Single Payment In Finished Status

Example 6:Single Payment In Canceled Status

Example 7: Single Payment In Waiting For Certification Status

Example 8: Single Payment In Verified Status

Example 9: Batch in Error Status

Example 10: Batch In Waiting For Certification Status

Example 11: Batch In Canceled Status

Example 12: Batch In verified Status

Example 13: Batch In Finished Status

📘
In this web service the Nonce element in security header is not required!

🚧
Only one of the two attributes (singlePaymentId or batchPaymentId) must be supplied. In case none or both attributes are sent to the Web Service will return a SOAP fault.

❗️
Example 1:Both SinglePaymentId and BatchPaymentId Are Sent To The Web Service