Skip to content

Latest commit

 

History

History
492 lines (353 loc) · 14.5 KB

BankAccountApi.md

File metadata and controls

492 lines (353 loc) · 14.5 KB

BankAccountApi

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

Method HTTP request Description
attachBankAccountToStore POST /api/v1.0/{appId}/bankaccounts/{bankAccountId}/store/{storeId}
createBankAccount POST /api/v1.0/{appId}/bankaccounts
deleteBankAccount DELETE /api/v1.0/{appId}/bankaccounts/{bankAccountId}
getBankAccountById GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}
getBankAccounts GET /api/v1.0/{appId}/bankaccounts
getCountriesWithFieldDefinitions GET /api/v1.0/{appId}/bankaccounts/countries-field-definitions
getFieldDefinitions GET /api/v1.0/{appId}/bankaccounts/field-definitions
updateBankAccount POST /api/v1.0/{appId}/bankaccounts/{bankAccountId}
updateBankAccountState POST /api/v1.0/{appId}/bankaccounts/{bankAccountId}/state/{state}

attachBankAccountToStore

attachBankAccountToStore(appId, bankAccountId, storeId)

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.BankAccountApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

BankAccountApi apiInstance = new BankAccountApi();
String appId = "appId_example"; // String | 
Integer bankAccountId = 56; // Integer | 
Integer storeId = 56; // Integer | 
try {
    apiInstance.attachBankAccountToStore(appId, bankAccountId, storeId);
} catch (ApiException e) {
    System.err.println("Exception when calling BankAccountApi#attachBankAccountToStore");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
bankAccountId Integer
storeId Integer

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

createBankAccount

RestApiResultBankAccountDetail createBankAccount(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.BankAccountApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

BankAccountApi apiInstance = new BankAccountApi();
String appId = "appId_example"; // String | 
BankAccountCreate account = new BankAccountCreate(); // BankAccountCreate | 
try {
    RestApiResultBankAccountDetail result = apiInstance.createBankAccount(appId, account);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BankAccountApi#createBankAccount");
    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

deleteBankAccount

deleteBankAccount(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.BankAccountApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name Type Description Notes
appId String
bankAccountId Integer

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

getBankAccountById

RestApiResultBankAccountDetail getBankAccountById(bankAccountId, 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.BankAccountApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name Type Description Notes
bankAccountId Integer
appId String

Return type

RestApiResultBankAccountDetail

Authorization

oauth2

HTTP request headers

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

getBankAccounts

RestApiArrayResultBankAccountSummary getBankAccounts(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.BankAccountApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

BankAccountApi apiInstance = new BankAccountApi();
String appId = "appId_example"; // String | 
try {
    RestApiArrayResultBankAccountSummary result = apiInstance.getBankAccounts(appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BankAccountApi#getBankAccounts");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String

Return type

RestApiArrayResultBankAccountSummary

Authorization

oauth2

HTTP request headers

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

getCountriesWithFieldDefinitions

RestApiArrayResultCountryWithAccountFieldsDefinitions getCountriesWithFieldDefinitions(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.BankAccountApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

BankAccountApi apiInstance = new BankAccountApi();
String appId = "appId_example"; // String | 
try {
    RestApiArrayResultCountryWithAccountFieldsDefinitions result = apiInstance.getCountriesWithFieldDefinitions(appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BankAccountApi#getCountriesWithFieldDefinitions");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String

Return type

RestApiArrayResultCountryWithAccountFieldsDefinitions

Authorization

oauth2

HTTP request headers

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

getFieldDefinitions

RestApiResultAccountFieldsDefinitions getFieldDefinitions(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.BankAccountApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

BankAccountApi apiInstance = new BankAccountApi();
String appId = "appId_example"; // String | 
try {
    RestApiResultAccountFieldsDefinitions result = apiInstance.getFieldDefinitions(appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BankAccountApi#getFieldDefinitions");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String

Return type

RestApiResultAccountFieldsDefinitions

Authorization

oauth2

HTTP request headers

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

updateBankAccount

updateBankAccount(appId, bankAccountId, 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.BankAccountApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

BankAccountApi apiInstance = new BankAccountApi();
String appId = "appId_example"; // String | 
Integer bankAccountId = 56; // Integer | 
BankAccountCreate account = new BankAccountCreate(); // BankAccountCreate | 
try {
    apiInstance.updateBankAccount(appId, bankAccountId, account);
} catch (ApiException e) {
    System.err.println("Exception when calling BankAccountApi#updateBankAccount");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
bankAccountId Integer
account BankAccountCreate

Return type

null (empty response body)

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

updateBankAccountState

updateBankAccountState(appId, bankAccountId, state, reason)

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.BankAccountApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

BankAccountApi apiInstance = new BankAccountApi();
String appId = "appId_example"; // String | 
Integer bankAccountId = 56; // Integer | 
String state = "state_example"; // String | 
String reason = "reason_example"; // String | 
try {
    apiInstance.updateBankAccountState(appId, bankAccountId, state, reason);
} catch (ApiException e) {
    System.err.println("Exception when calling BankAccountApi#updateBankAccountState");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
bankAccountId Integer
state String
reason String

Return type

null (empty response body)

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