|
| 1 | +# cashfree_pg.Api.DefaultApi |
| 2 | + |
| 3 | +All URIs are relative to *https://sandbox.cashfree.com/pg* |
| 4 | + |
| 5 | +| Method | HTTP request | Description | |
| 6 | +|--------|--------------|-------------| |
| 7 | +| [**TerminalCreateQRCodes**](DefaultApi.md#terminalcreateqrcodes) | **POST** /partners/merchant/qrcodes | Create Pre-Activated Vpas for partner | |
| 8 | +| [**TerminalGetQRCodes**](DefaultApi.md#terminalgetqrcodes) | **GET** /partners/merchant/qrcodes | Get Pre-Activated Vpas for partner | |
| 9 | + |
| 10 | +<a id="terminalcreateqrcodes"></a> |
| 11 | +# **TerminalCreateQRCodes** |
| 12 | +> List<StaticQrResponseEntity> TerminalCreateQRCodes (string xApiVersion, string? xRequestId = null, Guid? xIdempotencyKey = null, CreatePartnerVpaRequest? createPartnerVpaRequest = null) |
| 13 | +
|
| 14 | +Create Pre-Activated Vpas for partner |
| 15 | + |
| 16 | +Use this API to create a pre-activated vpa for partner. |
| 17 | + |
| 18 | +### Example |
| 19 | +```csharp |
| 20 | +using System.Collections.Generic; |
| 21 | +using System.Diagnostics; |
| 22 | +using cashfree_pg.Client; |
| 23 | +using cashfree_pg.Model; |
| 24 | + |
| 25 | +namespace Example |
| 26 | +{ |
| 27 | + public class TerminalCreateQRCodesExample |
| 28 | + { |
| 29 | + public static void Main() |
| 30 | + { |
| 31 | + // Configuration |
| 32 | + Cashfree.XClientId = "<x-client-id>"; |
| 33 | + Cashfree.XClientSecret = "<x-client-secret>"; |
| 34 | + Cashfree.XEnvironment = Cashfree.SANDBOX; |
| 35 | + |
| 36 | + // Instance of Cashfree |
| 37 | + var cashfree = new Cashfree(); |
| 38 | + |
| 39 | + |
| 40 | + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") |
| 41 | + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) |
| 42 | + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions. (optional) |
| 43 | + var createPartnerVpaRequest = new CreatePartnerVpaRequest?(); // CreatePartnerVpaRequest? | (optional) |
| 44 | +
|
| 45 | + try |
| 46 | + { |
| 47 | + // Create Pre-Activated Vpas for partner |
| 48 | + List<StaticQrResponseEntity> result = cashfree.TerminalCreateQRCodes(xApiVersion, xRequestId, xIdempotencyKey, createPartnerVpaRequest); |
| 49 | + Debug.WriteLine(result); |
| 50 | + } |
| 51 | + catch (ApiException e) |
| 52 | + { |
| 53 | + Debug.Print("Exception when calling DefaultApi.TerminalCreateQRCodes: " + e.Message); |
| 54 | + Debug.Print("Status Code: " + e.ErrorCode); |
| 55 | + Debug.Print(e.StackTrace); |
| 56 | + } |
| 57 | + } |
| 58 | + } |
| 59 | +} |
| 60 | +``` |
| 61 | + |
| 62 | +### Parameters |
| 63 | + |
| 64 | +| Name | Type | Description | Notes | |
| 65 | +|------|------|-------------|-------| |
| 66 | +| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | |
| 67 | +| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | |
| 68 | +| **xIdempotencyKey** | **Guid?** | An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions. | [optional] | |
| 69 | +| **createPartnerVpaRequest** | [**CreatePartnerVpaRequest?**](CreatePartnerVpaRequest?.md) | | [optional] | |
| 70 | + |
| 71 | +### Return type |
| 72 | + |
| 73 | +[**List<StaticQrResponseEntity>**](StaticQrResponseEntity.md) |
| 74 | + |
| 75 | +### Authorization |
| 76 | + |
| 77 | +No authorization required |
| 78 | + |
| 79 | +### HTTP request headers |
| 80 | + |
| 81 | + - **Content-Type**: application/json |
| 82 | + - **Accept**: application/json |
| 83 | + |
| 84 | + |
| 85 | +### HTTP response details |
| 86 | +| Status code | Description | Response headers | |
| 87 | +|-------------|-------------|------------------| |
| 88 | +| **200** | OK | - | |
| 89 | +| **401** | Invalid Partner API Key | - | |
| 90 | +| **400** | Bad request error | * x-api-version - <br> * x-ratelimit-limit - <br> * x-ratelimit-remaining - <br> * x-ratelimit-retry - <br> * x-ratelimit-type - <br> * x-request-id - <br> * x-idempotency-key - <br> * x-idempotency-replayed - <br> | |
| 91 | +| **404** | Resource Not found | * x-api-version - <br> * x-ratelimit-limit - <br> * x-ratelimit-remaining - <br> * x-ratelimit-retry - <br> * x-ratelimit-type - <br> * x-request-id - <br> * x-idempotency-key - <br> * x-idempotency-replayed - <br> | |
| 92 | +| **409** | Resource already present | * x-api-version - <br> * x-ratelimit-limit - <br> * x-ratelimit-remaining - <br> * x-ratelimit-retry - <br> * x-ratelimit-type - <br> * x-request-id - <br> * x-idempotency-key - <br> * x-idempotency-replayed - <br> | |
| 93 | +| **422** | Idempotency error | * x-api-version - <br> * x-ratelimit-limit - <br> * x-ratelimit-remaining - <br> * x-ratelimit-retry - <br> * x-ratelimit-type - <br> * x-request-id - <br> * x-idempotency-key - <br> * x-idempotency-replayed - <br> | |
| 94 | +| **429** | Rate Limit Error | * x-api-version - <br> * x-ratelimit-limit - <br> * x-ratelimit-remaining - <br> * x-ratelimit-retry - <br> * x-ratelimit-type - <br> * x-request-id - <br> * x-idempotency-key - <br> * x-idempotency-replayed - <br> | |
| 95 | +| **500** | API related Error | * x-api-version - <br> * x-ratelimit-limit - <br> * x-ratelimit-remaining - <br> * x-ratelimit-retry - <br> * x-ratelimit-type - <br> * x-request-id - <br> * x-idempotency-key - <br> * x-idempotency-replayed - <br> | |
| 96 | + |
| 97 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 98 | + |
| 99 | +<a id="terminalgetqrcodes"></a> |
| 100 | +# **TerminalGetQRCodes** |
| 101 | +> List<StaticQrResponseEntity> TerminalGetQRCodes (string xApiVersion, string status, string cfTerminalId, string? xRequestId = null, Guid? xIdempotencyKey = null) |
| 102 | +
|
| 103 | +Get Pre-Activated Vpas for partner |
| 104 | + |
| 105 | +Use this API to get a pre-activated vpa for partner. |
| 106 | + |
| 107 | +### Example |
| 108 | +```csharp |
| 109 | +using System.Collections.Generic; |
| 110 | +using System.Diagnostics; |
| 111 | +using cashfree_pg.Client; |
| 112 | +using cashfree_pg.Model; |
| 113 | + |
| 114 | +namespace Example |
| 115 | +{ |
| 116 | + public class TerminalGetQRCodesExample |
| 117 | + { |
| 118 | + public static void Main() |
| 119 | + { |
| 120 | + // Configuration |
| 121 | + Cashfree.XClientId = "<x-client-id>"; |
| 122 | + Cashfree.XClientSecret = "<x-client-secret>"; |
| 123 | + Cashfree.XEnvironment = Cashfree.SANDBOX; |
| 124 | + |
| 125 | + // Instance of Cashfree |
| 126 | + var cashfree = new Cashfree(); |
| 127 | + |
| 128 | + |
| 129 | + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") |
| 130 | + var status = MAPPED; // string | Status of pre-created Qr. |
| 131 | + var cfTerminalId = 123344; // string | Cashfree terminal id for which you want to get pre-generated staticQRs. |
| 132 | + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) |
| 133 | + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions. (optional) |
| 134 | +
|
| 135 | + try |
| 136 | + { |
| 137 | + // Get Pre-Activated Vpas for partner |
| 138 | + List<StaticQrResponseEntity> result = cashfree.TerminalGetQRCodes(xApiVersion, status, cfTerminalId, xRequestId, xIdempotencyKey); |
| 139 | + Debug.WriteLine(result); |
| 140 | + } |
| 141 | + catch (ApiException e) |
| 142 | + { |
| 143 | + Debug.Print("Exception when calling DefaultApi.TerminalGetQRCodes: " + e.Message); |
| 144 | + Debug.Print("Status Code: " + e.ErrorCode); |
| 145 | + Debug.Print(e.StackTrace); |
| 146 | + } |
| 147 | + } |
| 148 | + } |
| 149 | +} |
| 150 | +``` |
| 151 | + |
| 152 | +### Parameters |
| 153 | + |
| 154 | +| Name | Type | Description | Notes | |
| 155 | +|------|------|-------------|-------| |
| 156 | +| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | |
| 157 | +| **status** | **string** | Status of pre-created Qr. | | |
| 158 | +| **cfTerminalId** | **string** | Cashfree terminal id for which you want to get pre-generated staticQRs. | | |
| 159 | +| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | |
| 160 | +| **xIdempotencyKey** | **Guid?** | An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions. | [optional] | |
| 161 | + |
| 162 | +### Return type |
| 163 | + |
| 164 | +[**List<StaticQrResponseEntity>**](StaticQrResponseEntity.md) |
| 165 | + |
| 166 | +### Authorization |
| 167 | + |
| 168 | +No authorization required |
| 169 | + |
| 170 | +### HTTP request headers |
| 171 | + |
| 172 | + - **Content-Type**: Not defined |
| 173 | + - **Accept**: application/json |
| 174 | + |
| 175 | + |
| 176 | +### HTTP response details |
| 177 | +| Status code | Description | Response headers | |
| 178 | +|-------------|-------------|------------------| |
| 179 | +| **200** | OK | - | |
| 180 | +| **401** | Invalid Partner API Key | - | |
| 181 | +| **400** | Bad request error | * x-api-version - <br> * x-ratelimit-limit - <br> * x-ratelimit-remaining - <br> * x-ratelimit-retry - <br> * x-ratelimit-type - <br> * x-request-id - <br> * x-idempotency-key - <br> * x-idempotency-replayed - <br> | |
| 182 | +| **404** | Resource Not found | * x-api-version - <br> * x-ratelimit-limit - <br> * x-ratelimit-remaining - <br> * x-ratelimit-retry - <br> * x-ratelimit-type - <br> * x-request-id - <br> * x-idempotency-key - <br> * x-idempotency-replayed - <br> | |
| 183 | +| **409** | Resource already present | * x-api-version - <br> * x-ratelimit-limit - <br> * x-ratelimit-remaining - <br> * x-ratelimit-retry - <br> * x-ratelimit-type - <br> * x-request-id - <br> * x-idempotency-key - <br> * x-idempotency-replayed - <br> | |
| 184 | +| **422** | Idempotency error | * x-api-version - <br> * x-ratelimit-limit - <br> * x-ratelimit-remaining - <br> * x-ratelimit-retry - <br> * x-ratelimit-type - <br> * x-request-id - <br> * x-idempotency-key - <br> * x-idempotency-replayed - <br> | |
| 185 | +| **429** | Rate Limit Error | * x-api-version - <br> * x-ratelimit-limit - <br> * x-ratelimit-remaining - <br> * x-ratelimit-retry - <br> * x-ratelimit-type - <br> * x-request-id - <br> * x-idempotency-key - <br> * x-idempotency-replayed - <br> | |
| 186 | +| **500** | API related Error | * x-api-version - <br> * x-ratelimit-limit - <br> * x-ratelimit-remaining - <br> * x-ratelimit-retry - <br> * x-ratelimit-type - <br> * x-request-id - <br> * x-idempotency-key - <br> * x-idempotency-replayed - <br> | |
| 187 | + |
| 188 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 189 | + |
0 commit comments