-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #20 from cashfree/4.0.0
4.0.0
- Loading branch information
Showing
188 changed files
with
1,835 additions
and
605 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# cashfree_pg.Model.CreateCustomerRequest | ||
Request body to create a customer at cashfree | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**customer_phone** | **string** | Customer Phone Number | | ||
**customer_email** | **string** | Customer Email | [optional] | ||
**customer_name** | **string** | Customer Name | [optional] | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# cashfree_pg.Model.CustomerEntity | ||
The complete customer entity | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**customer_uid** | **string** | unique id generated by cashfree for your customer | [optional] | ||
**customer_phone** | **string** | Customer Phone Number | [optional] | ||
**customer_email** | **string** | Customer Email | [optional] | ||
**customer_name** | **string** | Customer Name | [optional] | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
# cashfree_pg.Api.CustomersApi | ||
|
||
All URIs are relative to *https://sandbox.cashfree.com/pg* | ||
|
||
| Method | HTTP request | Description | | ||
|--------|--------------|-------------| | ||
| [**PGCreateCustomer**](CustomersApi.md#pgcreatecustomer) | **POST** /customers | Create Customer at Cashfree | | ||
|
||
<a id="pgcreatecustomer"></a> | ||
# **PGCreateCustomer** | ||
> CustomerEntity PGCreateCustomer (string xApiVersion, CreateCustomerRequest createCustomerRequest, string? xRequestId = null, Guid? xIdempotencyKey = null) | ||
Create Customer at Cashfree | ||
|
||
Create Customer at Cashfree | ||
|
||
### Example | ||
```csharp | ||
using System.Collections.Generic; | ||
using System.Diagnostics; | ||
using cashfree_pg.Client; | ||
using cashfree_pg.Model; | ||
|
||
namespace Example | ||
{ | ||
public class PGCreateCustomerExample | ||
{ | ||
public static void Main() | ||
{ | ||
// Configuration | ||
Cashfree.XClientId = "<x-client-id>"; | ||
Cashfree.XClientSecret = "<x-client-secret>"; | ||
Cashfree.XEnvironment = Cashfree.SANDBOX; | ||
|
||
// Instance of Cashfree | ||
var cashfree = new Cashfree(); | ||
|
||
|
||
var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") | ||
var createCustomerRequest = new CreateCustomerRequest(); // CreateCustomerRequest | Request to create a new customer at Cashfree | ||
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) | ||
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) | ||
try | ||
{ | ||
// Create Customer at Cashfree | ||
CustomerEntity result = cashfree.PGCreateCustomer(xApiVersion, createCustomerRequest, xRequestId, xIdempotencyKey); | ||
Debug.WriteLine(result); | ||
} | ||
catch (ApiException e) | ||
{ | ||
Debug.Print("Exception when calling CustomersApi.PGCreateCustomer: " + e.Message); | ||
Debug.Print("Status Code: " + e.ErrorCode); | ||
Debug.Print(e.StackTrace); | ||
} | ||
} | ||
} | ||
} | ||
``` | ||
|
||
### Parameters | ||
|
||
| Name | Type | Description | Notes | | ||
|------|------|-------------|-------| | ||
| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | | ||
| **createCustomerRequest** | [**CreateCustomerRequest**](CreateCustomerRequest.md) | Request to create a new customer at Cashfree | | | ||
| **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] | | ||
| **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] | | ||
|
||
### Return type | ||
|
||
[**CustomerEntity**](CustomerEntity.md) | ||
|
||
### Authorization | ||
|
||
[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) | ||
|
||
### HTTP request headers | ||
|
||
- **Content-Type**: application/json | ||
- **Accept**: application/json | ||
|
||
|
||
### HTTP response details | ||
| Status code | Description | Response headers | | ||
|-------------|-------------|------------------| | ||
| **200** | OK | * 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> | | ||
| **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> | | ||
| **401** | Authentication 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> | | ||
| **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> | | ||
| **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> | | ||
| **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> | | ||
| **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> | | ||
| **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> | | ||
|
||
[[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) | ||
|
Oops, something went wrong.