Skip to content

StripeCustomConnectApi.md

Latest commit

 

History

History
592 lines (444 loc) · 18.4 KB

StripeCustomConnectApi.md

File metadata and controls

592 lines (444 loc) · 18.4 KB

Flipdish.Api.StripeCustomConnectApi

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

Method HTTP request Description
CreateBankAccountAndConnectedAccount POST /api/v1.0/{appId}/customconnect/bank-account
CreateStripeConnectedAccount POST /api/v1.0/{appId}/customconnect/{bankAccountId}/create-update-account
CreateStripeConnectedAccountLink POST /api/v1.0/{appId}/customconnect/{stripeConnectedAccountId}/create-account-link
GetCustomConnect GET /api/v1.0/{appId}/customconnect/{storeId}
GetVerificationStatus GET /api/v1.0/{appId}/customconnect/verification-status
SetBankAccountBusinessType POST /api/v1.0/{appId}/customconnect/bank-account/{bankAccountId}/businesstype
StripeCustomConnectRefresh GET /api/v1.0/{appId}/customconnect/refresh-link
UpdateBankAccountDetails POST /api/v1.0/{appId}/customconnect/{bankAccountId}/update-bank-account-details
UpdatePayoutSchedule POST /api/v1.0/{appId}/customconnect/update-payout-schedule/{stripeConnectedAccountId}/{interval}

CreateBankAccountAndConnectedAccount

RestApiResultBankAccountDetail CreateBankAccountAndConnectedAccount (string appId, BankAccountCreate account)

Example

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

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

            var apiInstance = new StripeCustomConnectApi();
            var appId = appId_example;  // string | 
            var account = new BankAccountCreate(); // BankAccountCreate | 

            try
            {
                RestApiResultBankAccountDetail result = apiInstance.CreateBankAccountAndConnectedAccount(appId, account);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StripeCustomConnectApi.CreateBankAccountAndConnectedAccount: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
account BankAccountCreate

Return type

RestApiResultBankAccountDetail

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

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

CreateStripeConnectedAccount

RestApiResultStripeConnectedAccount CreateStripeConnectedAccount (string appId, int? bankAccountId)

Example

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

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

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

            try
            {
                RestApiResultStripeConnectedAccount result = apiInstance.CreateStripeConnectedAccount(appId, bankAccountId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StripeCustomConnectApi.CreateStripeConnectedAccount: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
bankAccountId int?

Return type

RestApiResultStripeConnectedAccount

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]

CreateStripeConnectedAccountLink

RestApiResultStripeConnectedAccount CreateStripeConnectedAccountLink (string appId, string stripeConnectedAccountId, StripeAccountLinkRequest stripeAccountLinkRequest)

Example

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

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

            var apiInstance = new StripeCustomConnectApi();
            var appId = appId_example;  // string | 
            var stripeConnectedAccountId = stripeConnectedAccountId_example;  // string | 
            var stripeAccountLinkRequest = new StripeAccountLinkRequest(); // StripeAccountLinkRequest | 

            try
            {
                RestApiResultStripeConnectedAccount result = apiInstance.CreateStripeConnectedAccountLink(appId, stripeConnectedAccountId, stripeAccountLinkRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StripeCustomConnectApi.CreateStripeConnectedAccountLink: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
stripeConnectedAccountId string
stripeAccountLinkRequest StripeAccountLinkRequest

Return type

RestApiResultStripeConnectedAccount

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

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

GetCustomConnect

RestApiArrayResultStripeCustomConnectedAccount GetCustomConnect (int? storeId, string appId)

Example

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

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

            var apiInstance = new StripeCustomConnectApi();
            var storeId = 56;  // int? | 
            var appId = appId_example;  // string | 

            try
            {
                RestApiArrayResultStripeCustomConnectedAccount result = apiInstance.GetCustomConnect(storeId, appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StripeCustomConnectApi.GetCustomConnect: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?
appId string

Return type

RestApiArrayResultStripeCustomConnectedAccount

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]

GetVerificationStatus

RestApiResultStripeConnectedAccount GetVerificationStatus (string appId, string stripeConnectedAccountId)

Example

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

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

            var apiInstance = new StripeCustomConnectApi();
            var appId = appId_example;  // string | 
            var stripeConnectedAccountId = stripeConnectedAccountId_example;  // string | 

            try
            {
                RestApiResultStripeConnectedAccount result = apiInstance.GetVerificationStatus(appId, stripeConnectedAccountId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StripeCustomConnectApi.GetVerificationStatus: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
stripeConnectedAccountId string

Return type

RestApiResultStripeConnectedAccount

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]

SetBankAccountBusinessType

RestApiResultBankAccountDetail SetBankAccountBusinessType (string appId, int? bankAccountId, string businessType)

Example

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

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

            var apiInstance = new StripeCustomConnectApi();
            var appId = appId_example;  // string | 
            var bankAccountId = 56;  // int? | 
            var businessType = businessType_example;  // string | 

            try
            {
                RestApiResultBankAccountDetail result = apiInstance.SetBankAccountBusinessType(appId, bankAccountId, businessType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StripeCustomConnectApi.SetBankAccountBusinessType: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
bankAccountId int?
businessType string

Return type

RestApiResultBankAccountDetail

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

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

StripeCustomConnectRefresh

Object StripeCustomConnectRefresh (int? linkRequestId, string appId)

Example

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

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

            var apiInstance = new StripeCustomConnectApi();
            var linkRequestId = 56;  // int? | 
            var appId = appId_example;  // string | 

            try
            {
                Object result = apiInstance.StripeCustomConnectRefresh(linkRequestId, appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StripeCustomConnectApi.StripeCustomConnectRefresh: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
linkRequestId int?
appId string

Return type

Object

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]

UpdateBankAccountDetails

RestApiResultStripeConnectedAccount UpdateBankAccountDetails (string appId, int? bankAccountId, BankAccountDetailsUpdateRequest updateRequest)

Example

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

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

            var apiInstance = new StripeCustomConnectApi();
            var appId = appId_example;  // string | 
            var bankAccountId = 56;  // int? | 
            var updateRequest = new BankAccountDetailsUpdateRequest(); // BankAccountDetailsUpdateRequest | 

            try
            {
                RestApiResultStripeConnectedAccount result = apiInstance.UpdateBankAccountDetails(appId, bankAccountId, updateRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StripeCustomConnectApi.UpdateBankAccountDetails: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
bankAccountId int?
updateRequest BankAccountDetailsUpdateRequest

Return type

RestApiResultStripeConnectedAccount

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

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

UpdatePayoutSchedule

RestApiResultModelBase UpdatePayoutSchedule (string appId, string stripeConnectedAccountId, string interval)

Example

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

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

            var apiInstance = new StripeCustomConnectApi();
            var appId = appId_example;  // string | 
            var stripeConnectedAccountId = stripeConnectedAccountId_example;  // string | 
            var interval = interval_example;  // string | 

            try
            {
                RestApiResultModelBase result = apiInstance.UpdatePayoutSchedule(appId, stripeConnectedAccountId, interval);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StripeCustomConnectApi.UpdatePayoutSchedule: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
stripeConnectedAccountId string
interval string

Return type

RestApiResultModelBase

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]