[УКР](https://hackmd.io/a_-XSuzvRvG9t9cU2yoUvg) | ENG
:arrow_left: [Guide](https://hackmd.io/QA2NYRliRLGviJl5P4-ZCw)

# [20009] Get Limit for Operation [10101]

## Usage

Request [20009] is used to get the current limit for the operation [[10101] "Card-to-card"](https://hackmd.io/VYlXRMiWRkimK0sxlTZ2BA), where **limit** is the maximum available transfer sum from card to card in UAH.

## Request

*See the description of the "Partner", "KeyAES" and "Sign" attributes in the section "[General API Integration Information](https://hackmd.io/ijxPm0xtTpycgTjuU_NHQQ)".*

### Data Structure

The Data structure for this operation is formed from the following parameters:

:::info
<details>
<summary>Data structure formation (examples are below)</summary>
<br>

~~~
{
"Currency": "",
"Exchange": "",
"Sum": ,
"SenderCard": {
"PAN": ""
},
"RecipientCard": {
"PAN": ""
},
"Transaction": {
"TransactionID": "",
"TerminalID": "",
"DateTime": ""
}
}
~~~
</details>
:::

|Parameter|Required|Type|Description|Example|
|:----:|:----:|:----:|----|:----:|
| `Currency` | Yes - paying in a currency different from UAH. | String | Currency *debit* code is an abbreviated currency designation described in the standard [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Non_ISO_4217_currencies) ("UAH", "GBP", "USD", etc.). |`UAH`|
| `Exchange` | Yes - paying in a currency different from UAH. | String | Currency *credit* code is an abbreviated currency designation described in the standard [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Non_ISO_4217_currencies) ("UAH", "GBP", "USD", etc). |`UAH`|
|`Sum`|No|Integer| Payment sum for limit check in kopecks. |1UAH=>`100`|
|`SenderCard`^1^|Yes|Structure|Structure transmits sender's bank card data.|See example below.|
|`RecipientCard`^2^|Yes|Structure|Structure transmits recipient's bank card data.|See example below.|
|`Transaction`|Yes|Structure|Structure transmits transaction data. See section "[Transaction Structure](https://hackmd.io/ijxPm0xtTpycgTjuU_NHQQ?view#2-Data)".|See example below.|

^1^ **"SenderCard"** Structure Parameters:

|Parameter|Required|Type|Description|Example|
|:----:|:----:|:----:|----|:----:|
| `PAN` | Yes | String[16] | Sender card PAN (bank card number). | `8888888888888888` |

^2^ **"RecipientCard"** Structure Parameters:

|Parameter|Required|Type|Description|Example|
|:----:|:----:|:----:|----|:----:|
| `PAN` | Yes | String[16] | Recipient card PAN (bank card number). | `8888888888888888` |

:::success
<details>
<summary>Example of the "Data" structure</summary>
<br>

~~~md
{
"Currency": "UAH",
"Exchange": "UAH",
"Sum": 1000,
"SenderCard": {
"PAN": "535124******0453"
},
"RecipientCard": {
"PAN": "537541******5416"
},
"Transaction": {
"TerminalID": "1",
"TransactionID": "8fd04e6e-c7c1-4bb6-8ee0-e67116062cf5"
}
}
~~~
</details>
:::

## Response

*See the general information on the response structure formation in the section "[General API Integration Information](https://hackmd.io/ijxPm0xtTpycgTjuU_NHQQ?view#Response-Structure)"*.

### Data Structure

Successful response to the request [20009] contains the `limit` parameter:

|Parameter|Required|Type|Description|Example|
|:----:|:----:|:----:|----|:----:|
| `limit` | Yes | Integer | Transfer limit for operation [[10101] “Card-card”](https://hackmd.io/VYlXRMiWRkimK0sxlTZ2BA) in kopecks. |1UAH=>`100`|
| `attr` | Yes | Array | Array transmits the necessary attributes for operation. Available array values: `PIB` - recipient's full name.|See below.|

### Response Examples

:::success
<details>
<summary>Operation Successfully Completed</summary>
<br>

~~~md
{
"Code": 200,
"Message": "done",
"Data": {
"limit": 1000000,
"attr": [
{
"PIB": "Oleg Serhiyovych Shevchenko"
}
]
"OperationID": 35718,
"OperationStatus": 10
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

:::success
<details>
<summary>Operation Failed</summary>
<br>

~~~md
{
"Code": 200,
"Message": "done",
"Data": {
"OperationID": 111,
"OperationStatus": 21,
"Reason": 3
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

## Related Requests

[[20001] Get Wallet Balance](https://hackmd.io/SVZQwSioRiGRiy0JwUQFWw)
[[20002] Get Wallet Statement](https://hackmd.io/ChiiYaRgQVeZcjvM5Wt7VA)
[[20003] Get Operation Status](https://hackmd.io/_eAjmoG-QPWoWWmsLOGf1g)
[[20004] Get Transaction Receipt](https://hackmd.io/k3KrwPbcRK-1G7qxG0ORlg)
[[20008] Get Exchange Rate](https://hackmd.io/k_ZnVoMwQ-i4WelDZ0wtZA)
[[20110] Get Card Data](https://hackmd.io/WruG7PGDRsuF0gL0Wl21bA)

## Reference Materials

General parameters of the XPAY system are given in the section ["Reference Materials"](https://hackmd.io/16yLv895Qo-FWTvrWWQwbg):  operation types, payment types, response codes, operation status, reasons of operation rejection, etc.

:arrow_left: [Guide](https://hackmd.io/QA2NYRliRLGviJl5P4-ZCw)
:arrow_left: [General API Integration Information](https://hackmd.io/ijxPm0xtTpycgTjuU_NHQQ)

<details>
<summary>XPAY Support</summary>
</br>

Phone: [phone]
Email: [e-mail]
Telegram: @xpaysupportbot
</details>