Flipdish.Api.PayoutsApi

All URIs are relative to https://api.flipdish.co

Method	HTTP request	Description
GetPayout	GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}
GetPayoutChargebacks	GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/chargebacks
GetPayoutOrders	GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/orders
GetPayoutOtherCharges	GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/othercharges
GetPayoutRefunds	GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/refunds
GetPayoutSummaries	GET /api/v1.0/{appId}/payouts/summaries
GetPayouts	GET /api/v1.0/{appId}/payouts

GetPayout

PayoutDetail GetPayout (string appId, int? bankAccountId, int? payoutId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetPayoutExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PayoutsApi();
            var appId = appId_example;  // string | 
            var bankAccountId = 56;  // int? | 
            var payoutId = 56;  // int? | 

            try
            {
                PayoutDetail result = apiInstance.GetPayout(appId, bankAccountId, payoutId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutsApi.GetPayout: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
appId	string
bankAccountId	int?
payoutId	int?

Return type

PayoutDetail

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

GetPayoutChargebacks

RestApiPaginationResultPayoutChargeback GetPayoutChargebacks (string appId, int? bankAccountId, int? payoutId, int? page = null, int? limit = null, List<int?> storeIds = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetPayoutChargebacksExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PayoutsApi();
            var appId = appId_example;  // string | 
            var bankAccountId = 56;  // int? | 
            var payoutId = 56;  // int? | 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 
            var storeIds = new List<int?>(); // List<int?> |  (optional) 

            try
            {
                RestApiPaginationResultPayoutChargeback result = apiInstance.GetPayoutChargebacks(appId, bankAccountId, payoutId, page, limit, storeIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutsApi.GetPayoutChargebacks: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Notes
appId	string
bankAccountId	int?
payoutId	int?
page	int?	[optional]
limit	int?	[optional]
storeIds	List<int?>	[optional]

Return type

RestApiPaginationResultPayoutChargeback

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

GetPayoutOrders

RestApiPaginationResultPayoutOrder GetPayoutOrders (string appId, int? bankAccountId, int? payoutId, int? page = null, int? limit = null, List<int?> storeIds = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetPayoutOrdersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PayoutsApi();
            var appId = appId_example;  // string | 
            var bankAccountId = 56;  // int? | 
            var payoutId = 56;  // int? | 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 
            var storeIds = new List<int?>(); // List<int?> |  (optional) 

            try
            {
                RestApiPaginationResultPayoutOrder result = apiInstance.GetPayoutOrders(appId, bankAccountId, payoutId, page, limit, storeIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutsApi.GetPayoutOrders: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Notes
appId	string
bankAccountId	int?
payoutId	int?
page	int?	[optional]
limit	int?	[optional]
storeIds	List<int?>	[optional]

Return type

RestApiPaginationResultPayoutOrder

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

GetPayoutOtherCharges

RestApiPaginationResultPayoutOtherCharge GetPayoutOtherCharges (string appId, int? bankAccountId, int? payoutId, int? page = null, int? limit = null, List<int?> storeIds = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetPayoutOtherChargesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PayoutsApi();
            var appId = appId_example;  // string | 
            var bankAccountId = 56;  // int? | 
            var payoutId = 56;  // int? | 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 
            var storeIds = new List<int?>(); // List<int?> |  (optional) 

            try
            {
                RestApiPaginationResultPayoutOtherCharge result = apiInstance.GetPayoutOtherCharges(appId, bankAccountId, payoutId, page, limit, storeIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutsApi.GetPayoutOtherCharges: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Notes
appId	string
bankAccountId	int?
payoutId	int?
page	int?	[optional]
limit	int?	[optional]
storeIds	List<int?>	[optional]

Return type

RestApiPaginationResultPayoutOtherCharge

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

GetPayoutRefunds

RestApiPaginationResultPayoutRefund GetPayoutRefunds (string appId, int? bankAccountId, int? payoutId, int? page = null, int? limit = null, List<int?> storeIds = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetPayoutRefundsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PayoutsApi();
            var appId = appId_example;  // string | 
            var bankAccountId = 56;  // int? | 
            var payoutId = 56;  // int? | 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 
            var storeIds = new List<int?>(); // List<int?> |  (optional) 

            try
            {
                RestApiPaginationResultPayoutRefund result = apiInstance.GetPayoutRefunds(appId, bankAccountId, payoutId, page, limit, storeIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutsApi.GetPayoutRefunds: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Notes
appId	string
bankAccountId	int?
payoutId	int?
page	int?	[optional]
limit	int?	[optional]
storeIds	List<int?>	[optional]

Return type

RestApiPaginationResultPayoutRefund

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

GetPayoutSummaries

RestApiArrayResultPayoutSummary GetPayoutSummaries (string appId, DateTime? startDate = null, DateTime? endDate = null, List<int?> payoutRequestIdsBankAccountIds = null, List payoutRequestIdsStates = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetPayoutSummariesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PayoutsApi();
            var appId = appId_example;  // string | 
            var startDate = 2013-10-20T19:20:30+01:00;  // DateTime? |  (optional) 
            var endDate = 2013-10-20T19:20:30+01:00;  // DateTime? |  (optional) 
            var payoutRequestIdsBankAccountIds = new List<int?>(); // List<int?> | List of bank account ids to search for (optional) 
            var payoutRequestIdsStates = payoutRequestIdsStates_example;  // List<string> | List of {Flipdish.PublicModels.V1.Payouts.PayoutStatus} so search for (optional) 

            try
            {
                RestApiArrayResultPayoutSummary result = apiInstance.GetPayoutSummaries(appId, startDate, endDate, payoutRequestIdsBankAccountIds, payoutRequestIdsStates);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutsApi.GetPayoutSummaries: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
appId	string
startDate	DateTime?		[optional]
endDate	DateTime?		[optional]
payoutRequestIdsBankAccountIds	List<int?>	List of bank account ids to search for	[optional]
payoutRequestIdsStates	List<string>	List of {Flipdish.PublicModels.V1.Payouts.PayoutStatus} so search for	[optional]

Return type

RestApiArrayResultPayoutSummary

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

GetPayouts

RestApiPaginationResultPayout GetPayouts (string appId, DateTime? startDate = null, DateTime? endDate = null, int? page = null, int? limit = null, List<int?> payoutRequestIdsBankAccountIds = null, List payoutRequestIdsStates = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetPayoutsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PayoutsApi();
            var appId = appId_example;  // string | 
            var startDate = 2013-10-20T19:20:30+01:00;  // DateTime? |  (optional) 
            var endDate = 2013-10-20T19:20:30+01:00;  // DateTime? |  (optional) 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 
            var payoutRequestIdsBankAccountIds = new List<int?>(); // List<int?> | List of bank account ids to search for (optional) 
            var payoutRequestIdsStates = payoutRequestIdsStates_example;  // List<string> | List of {Flipdish.PublicModels.V1.Payouts.PayoutStatus} so search for (optional) 

            try
            {
                RestApiPaginationResultPayout result = apiInstance.GetPayouts(appId, startDate, endDate, page, limit, payoutRequestIdsBankAccountIds, payoutRequestIdsStates);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutsApi.GetPayouts: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
appId	string
startDate	DateTime?		[optional]
endDate	DateTime?		[optional]
page	int?		[optional]
limit	int?		[optional]
payoutRequestIdsBankAccountIds	List<int?>	List of bank account ids to search for	[optional]
payoutRequestIdsStates	List<string>	List of {Flipdish.PublicModels.V1.Payouts.PayoutStatus} so search for	[optional]

Return type

RestApiPaginationResultPayout

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

FilesExpand file tree

PayoutsApi.md

Latest commit

History

PayoutsApi.md

File metadata and controls

Flipdish.Api.PayoutsApi

GetPayout

Example

Parameters

Return type

Authorization

HTTP request headers

GetPayoutChargebacks

Example

Parameters

Return type

Authorization

HTTP request headers

GetPayoutOrders

Example

Parameters

Return type

Authorization

HTTP request headers

GetPayoutOtherCharges

Example

Parameters

Return type

Authorization

HTTP request headers

GetPayoutRefunds

Example

Parameters

Return type

Authorization

HTTP request headers

GetPayoutSummaries

Example

Parameters

Return type

Authorization

HTTP request headers

GetPayouts

Example

Parameters

Return type

Authorization

HTTP request headers