AndDoneSecureClientLibrary.Api.SecurePaymentBatchingApi

All URIs are relative to https://api.uat.anddone.com

Method	HTTP request	Description
SecureBatchesDetailsPost	POST /secure/batches/details	This API is used for getting Secure Payment Batch Details
SecureBatchesExecutePost	POST /secure/batches/execute	This API execute on-demand batch transaction.
SecureBatchesPost	POST /secure/batches	This API is used for getting Secure Payment Batches
SecureBatchesTimelinesPost	POST /secure/batches/timelines	This API will returns batch timeline.
SecureBatchesTransactionsCancelPost	POST /secure/batches/transactions/cancel	This API cancels transactions from an active batch.

SecureBatchesDetailsPost

List<PaymentBatchDetailsResponse> SecureBatchesDetailsPost (string xApiKey, string xAppKey, float xVersion, string origin, SecurePaymentBatchDetailsRequest securePaymentBatchDetailsRequest)

This API is used for getting Secure Payment Batch Details

Example

using System.Collections.Generic;
using System.Diagnostics;
using AndDoneSecureClientLibrary.Api;
using AndDoneSecureClientLibrary.Client;
using AndDoneSecureClientLibrary.Model;

namespace Example
{
    public class SecureBatchesDetailsPostExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.uat.anddone.com";
            var apiInstance = new SecurePaymentBatchingApi(config);
            var xApiKey = "xApiKey_example";  // string | an authorization header
            var xAppKey = "xAppKey_example";  // string | an authorization header
            var xVersion = 8.14D;  // float | x-version
            var origin = "origin_example";  // string | origin
            var securePaymentBatchDetailsRequest = new SecurePaymentBatchDetailsRequest(); // SecurePaymentBatchDetailsRequest | Secure Payment Batch Details Request

            try
            {
                // This API is used for getting Secure Payment Batch Details
                List<PaymentBatchDetailsResponse> result = apiInstance.SecureBatchesDetailsPost(xApiKey, xAppKey, xVersion, origin, securePaymentBatchDetailsRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SecurePaymentBatchingApi.SecureBatchesDetailsPost: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the SecureBatchesDetailsPostWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // This API is used for getting Secure Payment Batch Details
    ApiResponse<List<PaymentBatchDetailsResponse>> response = apiInstance.SecureBatchesDetailsPostWithHttpInfo(xApiKey, xAppKey, xVersion, origin, securePaymentBatchDetailsRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling SecurePaymentBatchingApi.SecureBatchesDetailsPostWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description
xApiKey	string	an authorization header
xAppKey	string	an authorization header
xVersion	float	x-version
origin	string	origin
securePaymentBatchDetailsRequest	SecurePaymentBatchDetailsRequest	Secure Payment Batch Details Request

Return type

List<PaymentBatchDetailsResponse>

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
401	Unauthorized	-
404	Not Found	-
500	Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SecureBatchesExecutePost

void SecureBatchesExecutePost (string xApiKey, string xAppKey, float xVersion, string origin, SecureBatchExecuteRequest secureBatchExecuteRequest)

This API execute on-demand batch transaction.

Example

using System.Collections.Generic;
using System.Diagnostics;
using AndDoneSecureClientLibrary.Api;
using AndDoneSecureClientLibrary.Client;
using AndDoneSecureClientLibrary.Model;

namespace Example
{
    public class SecureBatchesExecutePostExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.uat.anddone.com";
            var apiInstance = new SecurePaymentBatchingApi(config);
            var xApiKey = "xApiKey_example";  // string | an authorization header
            var xAppKey = "xAppKey_example";  // string | an authorization header
            var xVersion = 8.14D;  // float | x-version
            var origin = "origin_example";  // string | origin
            var secureBatchExecuteRequest = new SecureBatchExecuteRequest(); // SecureBatchExecuteRequest | Payment Batch Execution Request

            try
            {
                // This API execute on-demand batch transaction.
                apiInstance.SecureBatchesExecutePost(xApiKey, xAppKey, xVersion, origin, secureBatchExecuteRequest);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SecurePaymentBatchingApi.SecureBatchesExecutePost: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the SecureBatchesExecutePostWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // This API execute on-demand batch transaction.
    apiInstance.SecureBatchesExecutePostWithHttpInfo(xApiKey, xAppKey, xVersion, origin, secureBatchExecuteRequest);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling SecurePaymentBatchingApi.SecureBatchesExecutePostWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description
xApiKey	string	an authorization header
xAppKey	string	an authorization header
xVersion	float	x-version
origin	string	origin
secureBatchExecuteRequest	SecureBatchExecuteRequest	Payment Batch Execution Request

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
404	Not Found	-
500	Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SecureBatchesPost

PaymentBatchResponse SecureBatchesPost (string xApiKey, string xAppKey, float xVersion, string origin, int? startRow = null, int? pageSize = null, string sortField = null, bool? asc = null)

This API is used for getting Secure Payment Batches

Example

using System.Collections.Generic;
using System.Diagnostics;
using AndDoneSecureClientLibrary.Api;
using AndDoneSecureClientLibrary.Client;
using AndDoneSecureClientLibrary.Model;

namespace Example
{
    public class SecureBatchesPostExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.uat.anddone.com";
            var apiInstance = new SecurePaymentBatchingApi(config);
            var xApiKey = "xApiKey_example";  // string | an authorization header
            var xAppKey = "xAppKey_example";  // string | an authorization header
            var xVersion = 8.14D;  // float | x-version
            var origin = "origin_example";  // string | origin
            var startRow = 56;  // int? | Set StartRow (optional) 
            var pageSize = 56;  // int? | Set PageSize (optional) 
            var sortField = "sortField_example";  // string | Set SortField (optional) 
            var asc = true;  // bool? | Set Asc (optional) 

            try
            {
                // This API is used for getting Secure Payment Batches
                PaymentBatchResponse result = apiInstance.SecureBatchesPost(xApiKey, xAppKey, xVersion, origin, startRow, pageSize, sortField, asc);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SecurePaymentBatchingApi.SecureBatchesPost: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the SecureBatchesPostWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // This API is used for getting Secure Payment Batches
    ApiResponse<PaymentBatchResponse> response = apiInstance.SecureBatchesPostWithHttpInfo(xApiKey, xAppKey, xVersion, origin, startRow, pageSize, sortField, asc);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling SecurePaymentBatchingApi.SecureBatchesPostWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
xApiKey	string	an authorization header
xAppKey	string	an authorization header
xVersion	float	x-version
origin	string	origin
startRow	int?	Set StartRow	[optional]
pageSize	int?	Set PageSize	[optional]
sortField	string	Set SortField	[optional]
asc	bool?	Set Asc	[optional]

Return type

PaymentBatchResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
401	Unauthorized	-
404	Not Found	-
500	Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SecureBatchesTimelinesPost

List<PaymentBatchEventLogResponse> SecureBatchesTimelinesPost (string xApiKey, string xAppKey, float xVersion, string origin, SecurePaymentBatchDetailsRequest securePaymentBatchDetailsRequest)

This API will returns batch timeline.

Example

using System.Collections.Generic;
using System.Diagnostics;
using AndDoneSecureClientLibrary.Api;
using AndDoneSecureClientLibrary.Client;
using AndDoneSecureClientLibrary.Model;

namespace Example
{
    public class SecureBatchesTimelinesPostExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.uat.anddone.com";
            var apiInstance = new SecurePaymentBatchingApi(config);
            var xApiKey = "xApiKey_example";  // string | an authorization header
            var xAppKey = "xAppKey_example";  // string | an authorization header
            var xVersion = 8.14D;  // float | x-version
            var origin = "origin_example";  // string | origin
            var securePaymentBatchDetailsRequest = new SecurePaymentBatchDetailsRequest(); // SecurePaymentBatchDetailsRequest | Payment Batch Timeline Request

            try
            {
                // This API will returns batch timeline.
                List<PaymentBatchEventLogResponse> result = apiInstance.SecureBatchesTimelinesPost(xApiKey, xAppKey, xVersion, origin, securePaymentBatchDetailsRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SecurePaymentBatchingApi.SecureBatchesTimelinesPost: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the SecureBatchesTimelinesPostWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // This API will returns batch timeline.
    ApiResponse<List<PaymentBatchEventLogResponse>> response = apiInstance.SecureBatchesTimelinesPostWithHttpInfo(xApiKey, xAppKey, xVersion, origin, securePaymentBatchDetailsRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling SecurePaymentBatchingApi.SecureBatchesTimelinesPostWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description
xApiKey	string	an authorization header
xAppKey	string	an authorization header
xVersion	float	x-version
origin	string	origin
securePaymentBatchDetailsRequest	SecurePaymentBatchDetailsRequest	Payment Batch Timeline Request

Return type

List<PaymentBatchEventLogResponse>

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
404	Not Found	-
500	Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SecureBatchesTransactionsCancelPost

void SecureBatchesTransactionsCancelPost (string xApiKey, string xAppKey, float xVersion, string origin, PaymentBatchCancellationRequest paymentBatchCancellationRequest)

This API cancels transactions from an active batch.

Example

using System.Collections.Generic;
using System.Diagnostics;
using AndDoneSecureClientLibrary.Api;
using AndDoneSecureClientLibrary.Client;
using AndDoneSecureClientLibrary.Model;

namespace Example
{
    public class SecureBatchesTransactionsCancelPostExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.uat.anddone.com";
            var apiInstance = new SecurePaymentBatchingApi(config);
            var xApiKey = "xApiKey_example";  // string | an authorization header
            var xAppKey = "xAppKey_example";  // string | an authorization header
            var xVersion = 8.14D;  // float | x-version
            var origin = "origin_example";  // string | origin
            var paymentBatchCancellationRequest = new PaymentBatchCancellationRequest(); // PaymentBatchCancellationRequest | Payment Batch Cancellation Request

            try
            {
                // This API cancels transactions from an active batch.
                apiInstance.SecureBatchesTransactionsCancelPost(xApiKey, xAppKey, xVersion, origin, paymentBatchCancellationRequest);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SecurePaymentBatchingApi.SecureBatchesTransactionsCancelPost: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the SecureBatchesTransactionsCancelPostWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // This API cancels transactions from an active batch.
    apiInstance.SecureBatchesTransactionsCancelPostWithHttpInfo(xApiKey, xAppKey, xVersion, origin, paymentBatchCancellationRequest);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling SecurePaymentBatchingApi.SecureBatchesTransactionsCancelPostWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description
xApiKey	string	an authorization header
xAppKey	string	an authorization header
xVersion	float	x-version
origin	string	origin
paymentBatchCancellationRequest	PaymentBatchCancellationRequest	Payment Batch Cancellation Request

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
404	Not Found	-
500	Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

SecurePaymentBatchingApi.md

Latest commit

History

SecurePaymentBatchingApi.md

File metadata and controls

AndDoneSecureClientLibrary.Api.SecurePaymentBatchingApi

SecureBatchesDetailsPost

Example

Using the SecureBatchesDetailsPostWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

SecureBatchesExecutePost

Example

Using the SecureBatchesExecutePostWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

SecureBatchesPost

Example

Using the SecureBatchesPostWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

SecureBatchesTimelinesPost

Example

Using the SecureBatchesTimelinesPostWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

SecureBatchesTransactionsCancelPost

Example

Using the SecureBatchesTransactionsCancelPostWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details