Skip to content

Latest commit

 

History

History
358 lines (264 loc) · 11.4 KB

PayoutsExportApi.md

File metadata and controls

358 lines (264 loc) · 11.4 KB

PayoutsExportApi

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

Method HTTP request Description
exportPayoutChargebacks GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/chargebacks/export
exportPayoutOrders GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/orders/export
exportPayoutOtherCharges GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/othercharges/export
exportPayoutRefunds GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/refunds/export
exportPayoutStores GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}/export
exportPayouts GET /api/v1.0/{appId}/payouts/export

exportPayoutChargebacks

String exportPayoutChargebacks(appId, bankAccountId, payoutId, storeIds)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

PayoutsExportApi apiInstance = new PayoutsExportApi();
String appId = "appId_example"; // String | 
Integer bankAccountId = 56; // Integer | 
Integer payoutId = 56; // Integer | 
List<Integer> storeIds = Arrays.asList(56); // List<Integer> | 
try {
    String result = apiInstance.exportPayoutChargebacks(appId, bankAccountId, payoutId, storeIds);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PayoutsExportApi#exportPayoutChargebacks");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
bankAccountId Integer
payoutId Integer
storeIds List<Integer> [optional]

Return type

String

Authorization

oauth2

HTTP request headers

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

exportPayoutOrders

String exportPayoutOrders(appId, bankAccountId, payoutId, storeIds)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

PayoutsExportApi apiInstance = new PayoutsExportApi();
String appId = "appId_example"; // String | 
Integer bankAccountId = 56; // Integer | 
Integer payoutId = 56; // Integer | 
List<Integer> storeIds = Arrays.asList(56); // List<Integer> | 
try {
    String result = apiInstance.exportPayoutOrders(appId, bankAccountId, payoutId, storeIds);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PayoutsExportApi#exportPayoutOrders");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
bankAccountId Integer
payoutId Integer
storeIds List<Integer> [optional]

Return type

String

Authorization

oauth2

HTTP request headers

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

exportPayoutOtherCharges

String exportPayoutOtherCharges(appId, bankAccountId, payoutId, storeIds)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

PayoutsExportApi apiInstance = new PayoutsExportApi();
String appId = "appId_example"; // String | 
Integer bankAccountId = 56; // Integer | 
Integer payoutId = 56; // Integer | 
List<Integer> storeIds = Arrays.asList(56); // List<Integer> | 
try {
    String result = apiInstance.exportPayoutOtherCharges(appId, bankAccountId, payoutId, storeIds);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PayoutsExportApi#exportPayoutOtherCharges");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
bankAccountId Integer
payoutId Integer
storeIds List<Integer> [optional]

Return type

String

Authorization

oauth2

HTTP request headers

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

exportPayoutRefunds

String exportPayoutRefunds(appId, bankAccountId, payoutId, storeIds)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

PayoutsExportApi apiInstance = new PayoutsExportApi();
String appId = "appId_example"; // String | 
Integer bankAccountId = 56; // Integer | 
Integer payoutId = 56; // Integer | 
List<Integer> storeIds = Arrays.asList(56); // List<Integer> | 
try {
    String result = apiInstance.exportPayoutRefunds(appId, bankAccountId, payoutId, storeIds);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PayoutsExportApi#exportPayoutRefunds");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
bankAccountId Integer
payoutId Integer
storeIds List<Integer> [optional]

Return type

String

Authorization

oauth2

HTTP request headers

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

exportPayoutStores

String exportPayoutStores(appId, bankAccountId, payoutId, storeIds)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

PayoutsExportApi apiInstance = new PayoutsExportApi();
String appId = "appId_example"; // String | 
Integer bankAccountId = 56; // Integer | 
Integer payoutId = 56; // Integer | 
List<Integer> storeIds = Arrays.asList(56); // List<Integer> | 
try {
    String result = apiInstance.exportPayoutStores(appId, bankAccountId, payoutId, storeIds);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PayoutsExportApi#exportPayoutStores");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
bankAccountId Integer
payoutId Integer
storeIds List<Integer> [optional]

Return type

String

Authorization

oauth2

HTTP request headers

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

exportPayouts

String exportPayouts(appId, startDate, endDate, payoutRequestIdsBankAccountIds, payoutRequestIdsStates)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

PayoutsExportApi apiInstance = new PayoutsExportApi();
String appId = "appId_example"; // String | 
OffsetDateTime startDate = OffsetDateTime.now(); // OffsetDateTime | 
OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | 
List<Integer> payoutRequestIdsBankAccountIds = Arrays.asList(56); // List<Integer> | List of bank account ids to search for
List<String> payoutRequestIdsStates = Arrays.asList("payoutRequestIdsStates_example"); // List<String> | List of {Flipdish.PublicModels.V1.Payouts.PayoutStatus} so search for
try {
    String result = apiInstance.exportPayouts(appId, startDate, endDate, payoutRequestIdsBankAccountIds, payoutRequestIdsStates);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PayoutsExportApi#exportPayouts");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
startDate OffsetDateTime [optional]
endDate OffsetDateTime [optional]
payoutRequestIdsBankAccountIds List<Integer> List of bank account ids to search for [optional]
payoutRequestIdsStates List<String> List of {Flipdish.PublicModels.V1.Payouts.PayoutStatus} so search for [optional] [enum: Pending, InTransit, Paid, Failed, Cancelled]

Return type

String

Authorization

oauth2

HTTP request headers

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