Skip to content

Latest commit

 

History

History
502 lines (363 loc) · 16.7 KB

StripeCustomConnectApi.md

File metadata and controls

502 lines (363 loc) · 16.7 KB

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(appId, account)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.StripeCustomConnectApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

StripeCustomConnectApi apiInstance = new StripeCustomConnectApi();
String appId = "appId_example"; // String | 
BankAccountCreate account = new BankAccountCreate(); // BankAccountCreate | 
try {
    RestApiResultBankAccountDetail result = apiInstance.createBankAccountAndConnectedAccount(appId, account);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StripeCustomConnectApi#createBankAccountAndConnectedAccount");
    e.printStackTrace();
}

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

createStripeConnectedAccount

RestApiResultStripeConnectedAccount createStripeConnectedAccount(appId, bankAccountId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.StripeCustomConnectApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

StripeCustomConnectApi apiInstance = new StripeCustomConnectApi();
String appId = "appId_example"; // String | 
Integer bankAccountId = 56; // Integer | 
try {
    RestApiResultStripeConnectedAccount result = apiInstance.createStripeConnectedAccount(appId, bankAccountId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StripeCustomConnectApi#createStripeConnectedAccount");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
bankAccountId Integer

Return type

RestApiResultStripeConnectedAccount

Authorization

oauth2

HTTP request headers

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

createStripeConnectedAccountLink

RestApiResultStripeConnectedAccount createStripeConnectedAccountLink(appId, stripeConnectedAccountId, stripeAccountLinkRequest)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.StripeCustomConnectApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

StripeCustomConnectApi apiInstance = new StripeCustomConnectApi();
String appId = "appId_example"; // String | 
String stripeConnectedAccountId = "stripeConnectedAccountId_example"; // String | 
StripeAccountLinkRequest stripeAccountLinkRequest = new StripeAccountLinkRequest(); // StripeAccountLinkRequest | 
try {
    RestApiResultStripeConnectedAccount result = apiInstance.createStripeConnectedAccountLink(appId, stripeConnectedAccountId, stripeAccountLinkRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StripeCustomConnectApi#createStripeConnectedAccountLink");
    e.printStackTrace();
}

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

getCustomConnect

RestApiArrayResultStripeCustomConnectedAccount getCustomConnect(storeId, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.StripeCustomConnectApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

StripeCustomConnectApi apiInstance = new StripeCustomConnectApi();
Integer storeId = 56; // Integer | 
String appId = "appId_example"; // String | 
try {
    RestApiArrayResultStripeCustomConnectedAccount result = apiInstance.getCustomConnect(storeId, appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StripeCustomConnectApi#getCustomConnect");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
storeId Integer
appId String

Return type

RestApiArrayResultStripeCustomConnectedAccount

Authorization

oauth2

HTTP request headers

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

getVerificationStatus

RestApiResultStripeConnectedAccount getVerificationStatus(appId, stripeConnectedAccountId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.StripeCustomConnectApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

StripeCustomConnectApi apiInstance = new StripeCustomConnectApi();
String appId = "appId_example"; // String | 
String stripeConnectedAccountId = "stripeConnectedAccountId_example"; // String | 
try {
    RestApiResultStripeConnectedAccount result = apiInstance.getVerificationStatus(appId, stripeConnectedAccountId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StripeCustomConnectApi#getVerificationStatus");
    e.printStackTrace();
}

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

setBankAccountBusinessType

RestApiResultBankAccountDetail setBankAccountBusinessType(appId, bankAccountId, businessType)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.StripeCustomConnectApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

StripeCustomConnectApi apiInstance = new StripeCustomConnectApi();
String appId = "appId_example"; // String | 
Integer bankAccountId = 56; // Integer | 
String businessType = "businessType_example"; // String | 
try {
    RestApiResultBankAccountDetail result = apiInstance.setBankAccountBusinessType(appId, bankAccountId, businessType);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StripeCustomConnectApi#setBankAccountBusinessType");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
bankAccountId Integer
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

stripeCustomConnectRefresh

Object stripeCustomConnectRefresh(linkRequestId, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.StripeCustomConnectApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

StripeCustomConnectApi apiInstance = new StripeCustomConnectApi();
Integer linkRequestId = 56; // Integer | 
String appId = "appId_example"; // String | 
try {
    Object result = apiInstance.stripeCustomConnectRefresh(linkRequestId, appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StripeCustomConnectApi#stripeCustomConnectRefresh");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
linkRequestId Integer
appId String

Return type

Object

Authorization

oauth2

HTTP request headers

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

updateBankAccountDetails

RestApiResultStripeConnectedAccount updateBankAccountDetails(appId, bankAccountId, updateRequest)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.StripeCustomConnectApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

StripeCustomConnectApi apiInstance = new StripeCustomConnectApi();
String appId = "appId_example"; // String | 
Integer bankAccountId = 56; // Integer | 
BankAccountDetailsUpdateRequest updateRequest = new BankAccountDetailsUpdateRequest(); // BankAccountDetailsUpdateRequest | 
try {
    RestApiResultStripeConnectedAccount result = apiInstance.updateBankAccountDetails(appId, bankAccountId, updateRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StripeCustomConnectApi#updateBankAccountDetails");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
bankAccountId Integer
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

updatePayoutSchedule

RestApiResultModelBase updatePayoutSchedule(appId, stripeConnectedAccountId, interval)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.StripeCustomConnectApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

StripeCustomConnectApi apiInstance = new StripeCustomConnectApi();
String appId = "appId_example"; // String | 
String stripeConnectedAccountId = "stripeConnectedAccountId_example"; // String | 
String interval = "interval_example"; // String | 
try {
    RestApiResultModelBase result = apiInstance.updatePayoutSchedule(appId, stripeConnectedAccountId, interval);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StripeCustomConnectApi#updatePayoutSchedule");
    e.printStackTrace();
}

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