Skip to content

BankAccountApi.md

Latest commit

 

History

History
464 lines (307 loc) · 12 KB

BankAccountApi.md

File metadata and controls

464 lines (307 loc) · 12 KB
Raw

Flipdish.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, opts)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.BankAccountApi();
let appId = "appId_example"; // String | 
let bankAccountId = 56; // Number | 
let storeId = 56; // Number | 
let opts = {
  'skipBankAccountUpdateWarningEmail': true // Boolean | 
};
apiInstance.attachBankAccountToStore(appId, bankAccountId, storeId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
appId String
bankAccountId Number
storeId Number
skipBankAccountUpdateWarningEmail Boolean [optional]

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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.BankAccountApi();
let appId = "appId_example"; // String | 
let account = new Flipdish.BankAccountCreate(); // BankAccountCreate | 
apiInstance.createBankAccount(appId, account, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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, Data

deleteBankAccount

deleteBankAccount(appId, bankAccountId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.BankAccountApi();
let appId = "appId_example"; // String | 
let bankAccountId = 56; // Number | 
apiInstance.deleteBankAccount(appId, bankAccountId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
appId String
bankAccountId Number

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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.BankAccountApi();
let bankAccountId = 56; // Number | 
let appId = "appId_example"; // String | 
apiInstance.getBankAccountById(bankAccountId, appId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
bankAccountId Number
appId String

Return type

RestApiResultBankAccountDetail

Authorization

oauth2

HTTP request headers

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

getBankAccounts

RestApiArrayResultBankAccountSummary getBankAccounts(appId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.BankAccountApi();
let appId = "appId_example"; // String | 
apiInstance.getBankAccounts(appId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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, Data

getCountriesWithFieldDefinitions

RestApiArrayResultCountryWithAccountFieldsDefinitions getCountriesWithFieldDefinitions(appId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.BankAccountApi();
let appId = "appId_example"; // String | 
apiInstance.getCountriesWithFieldDefinitions(appId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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, Data

getFieldDefinitions

RestApiResultAccountFieldsDefinitions getFieldDefinitions(appId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.BankAccountApi();
let appId = "appId_example"; // String | 
apiInstance.getFieldDefinitions(appId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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, Data

updateBankAccount

updateBankAccount(appId, bankAccountId, account)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.BankAccountApi();
let appId = "appId_example"; // String | 
let bankAccountId = 56; // Number | 
let account = new Flipdish.BankAccountCreate(); // BankAccountCreate | 
apiInstance.updateBankAccount(appId, bankAccountId, account, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
appId String
bankAccountId Number
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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.BankAccountApi();
let appId = "appId_example"; // String | 
let bankAccountId = 56; // Number | 
let state = "state_example"; // String | 
let reason = "reason_example"; // String | 
apiInstance.updateBankAccountState(appId, bankAccountId, state, reason, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

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