---
updatedAt: 2026-03-25T11:17:45.000Z
---

# Get Payment ID

# Get Single Payment ID

When **ImportSinglePaymentOrdersRequestIo** is successfull, Bank's digital channel (Internet/Mobile banking; DBI integration service), assigns unique ID to each imported single payment order and returns its value in **ImportSinglePaymentOrdersResponseIo**, in the **PaymentId** attribute;\
in case connection between client system and Bank's digital channel (Internet/Mobile banking; DBI integration service) is broken before client system gets response, **GetSinglePaymentId** Web Service can be used to get ID that was assigned by Bank's digital channel (Internet/Mobile banking; DBI integration service) to the imported payment order:

> 📘 In the GetSinglePaymentId web service the **Nonce** element in security header **is not required!**

# Payment Order Attribute Formats

Attribute format defines allowed character set and maximal number of characters in the attribute value.\
Exclamation mark (!) means that value should contain exactly the specified number of characters; e.g.:

* '22!S' – value should contain exactly 22 characters that correspond to 'S' charset;
* '22S' – value can contain up to 22 characters that correspond to 'S' charset;
* '13n.2n' – digits and decimal point: up to 13 digits before point and up to 2 digits after the point.

[block:parameters]
{
  "data": {
    "h-0": "Format Code",
    "h-1": "Allowed Charset",
    "0-0": "n",
    "0-1": "Digits: 0123456789",
    "1-0": "A",
    "1-1": "Capital letters of the Latin alphabet: ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    "2-0": "S",
    "2-1": "Capital letters of the Latin alphabet: ABCDEFGHIJKLMNOPQRSTUVWXYZ  \nDigits: 0123456789  \nCharacters: / - ? : ( ) . , \\` + \\_ \\* \\< > & SPACE",
    "3-0": "R",
    "3-1": "Georgian (Unicode, UTF-8) letters: აბგდევზთიკლმნოპჟრსტუფქღყშჩცძწჭხჯჰ  \nLower case letters of the Latin alphabet: abcdefghijklmnopqrstuvwxyz  \nCapital letters of the Latin alphabet: ABCDEFGHIJKLMNOPQRSTUVWXYZ  \nDigits: 0123456789  \nCharacters: / - ? : ( ) . , ' + space"
  },
  "cols": 2,
  "rows": 4,
  "align": [
    "left",
    "left"
  ]
}
[/block]

> 🚧 Characters < > & must be represented as:
>
> ```
> Characters must be represented: "<" as &lt; ">" as &gt; "&"as &amp;
> ```

# Get Single Payment ID Request Attributes

[block:parameters]
{
  "data": {
    "h-0": "Attribute",
    "h-1": "Type",
    "h-2": "Comment",
    "0-0": "singlePaymentRequestId",
    "0-1": "Long  \n[19n](#payment-order-attribute-formats)",
    "0-2": "Single payment request ID that was specified in the import request"
  },
  "cols": 3,
  "rows": 1,
  "align": [
    "left",
    "left",
    "left"
  ]
}
[/block]

### Example 1: Get Single Payment ID Request

```xml
<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">
	<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:GetSinglePaymentIdRequestIo>
			<myg:singlePaymentRequestId>23160119123213120</myg:singlePaymentRequestId>
		</myg:GetSinglePaymentIdRequestIo>
	</soapenv:Body>
</soapenv:Envelope>
```

# Get Single Payment ID Response Attributes

| Attribute | Type   | Comment                                                                                                |
| :-------- | :----- | :----------------------------------------------------------------------------------------------------- |
| PaymentId | String | Payment order ID assigned by Bank's digital channel (Internet/Mobile banking; DBI integration service) |

> ❗️ In Case Specified Single Payment Request ID Is Not Found For A Given Client, Web Service Will Return A SOAP Fault
>
> ```xml
> <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:SINGLE_PAYMENT_REQUEST_NOT_FOUND
> 			</faultcode>
> 			<faultstring xml:lang="en">Specified single payment request ID is not found for a current client</faultstring>
> 		</s:Fault>
> 	</s:Body>
> </s:Envelope>
> ```

> 👍 Example 3: Get Single Payment ID Response
>
> ```xml
> <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:GetSinglePaymentIdResponseIo
> 			xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
> 			xmlns:xsd="http://www.w3.org/2001/XMLSchema">
>             <ns2:paymentId>541202011</ns2:paymentId>
>         </ns2:GetSinglePaymentIdResponseIo>
>     </SOAP-ENV:Body>
> </SOAP-ENV:Envelope>
> ```

# Get Batch Payment ID

When **ImportBatchPaymentOrderRequestIo**is successfull, Bank's digital channel (Internet/Mobile banking; DBI integration service), assigns unique ID to each imported single payment order and returns its value in **ImportBatchPaymentOrdersResponseIo**, in the **PaymentId** attribute;\
in case connection between client system and Bank's digital channel (Internet/Mobile banking; DBI integration service) is broken before client system gets response, **GetBatchPaymentId** Web Service can be used to get ID that was assigned by Bank's digital channel (Internet/Mobile banking; DBI integration service) to the imported payment order:

> 📘 In the GetBatchPaymentId web service the **Nonce** element in security header **is not required!**

# Get Batch Payment ID Request Attributes

[block:parameters]
{
  "data": {
    "h-0": "Attribute",
    "h-1": "Type",
    "h-2": "Comment",
    "0-0": "batchPaymentRequestId",
    "0-1": "Long  \n[19n](#payment-order-attribute-formats)",
    "0-2": "Batch payment request ID that was specified in the import request"
  },
  "cols": 3,
  "rows": 1,
  "align": [
    "left",
    "left",
    "left"
  ]
}
[/block]

### Example 4: Get Batch Payment Payment ID Request

```xml
<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">
	<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:GetBatchPaymentIdRequestIo>
			<myg:batchPaymentRequestId>1234321</myg:batchPaymentRequestId>
		</myg:GetBatchPaymentIdRequestIo>
	</soapenv:Body>
</soapenv:Envelope>
```

# Get Batch Payment ID Response Attributes

| Attribute | Type   | Comment                                                                                                    |
| :-------- | :----- | :--------------------------------------------------------------------------------------------------------- |
| BatchId   | String | Internal ID of batch assigned by Bank's digital channel (Internet/Mobile banking; DBI integration service) |

> ❗️ In Case Specified Batch Payment Request ID Is Not Found For A Given Client, Web Service Will Return A SOAP Fault
>
> ```xml
> <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:BATCH_PAYMENT_REQUEST_NOT_FOUND
> 			</faultcode>
> 			<faultstring xml:lang="en">Specified batch payment request ID is not found for a current client</faultstring>
> 		</s:Fault>
> 	</s:Body>
> </s:Envelope>
> ```

> 👍 Example 6: Get Batch Payment ID Response
>
> ```xml
> <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:GetBatchPaymentIdResponseIo
> 			xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
> 			xmlns:xsd="http://www.w3.org/2001/XMLSchema">
>             <ns2:batchId>1339307</ns2:batchId>
>         </ns2:GetBatchPaymentIdResponseIo>
>     </SOAP-ENV:Body>
> </SOAP-ENV:Envelope>
> ```