Skip to content

Latest commit

 

History

History
123 lines (92 loc) · 4.6 KB

PayoutsApi.md

File metadata and controls

123 lines (92 loc) · 4.6 KB
Raw

SumUpRestApi.PayoutsApi

All URIs are relative to https://api.sumup.com/{version}

Method HTTP request Description
meFinancialsPayoutsGet GET /me/financials/payouts List payouts
meFinancialsTransactionsGet GET /me/financials/transactions List transactions

meFinancialsPayoutsGet

FinancialPayouts meFinancialsPayoutsGet(startDate, endDate, opts)

List payouts

Lists ordered payouts for the merchant account.

Example

import {SumUpRestApi} from 'sumup-rest-api';
let defaultClient = SumUpRestApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: accessToken
let accessToken = defaultClient.authentications['accessToken'];
accessToken.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new SumUpRestApi.PayoutsApi();
let startDate = new Date("2013-10-20"); // Date | Start date (in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener\">ISO8601</a> format).
let endDate = new Date("2013-10-20"); // Date | End date (in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener\">ISO8601</a> format).
let opts = { 
  'format': "format_example", // String | 
  'limit': 56, // Number | 
  'order': "order_example" // String | 
};
apiInstance.meFinancialsPayoutsGet(startDate, endDate, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
startDate Date Start date (in <a href=&quot;https://en.wikipedia.org/wiki/ISO_8601\" target=&quot;_blank&quot; rel=&quot;noopener&quot;>ISO8601</a> format).
endDate Date End date (in <a href=&quot;https://en.wikipedia.org/wiki/ISO_8601\" target=&quot;_blank&quot; rel=&quot;noopener&quot;>ISO8601</a> format).
format String [optional]
limit Number [optional]
order String [optional]

Return type

FinancialPayouts

Authorization

accessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

meFinancialsTransactionsGet

FinancialTransactions meFinancialsTransactionsGet(startDate, endDate, opts)

List transactions

Lists a less detailed history of all transactions associated with the merchant account.

Example

import {SumUpRestApi} from 'sumup-rest-api';
let defaultClient = SumUpRestApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: accessToken
let accessToken = defaultClient.authentications['accessToken'];
accessToken.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new SumUpRestApi.PayoutsApi();
let startDate = new Date("2013-10-20"); // Date | Start date (in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener\">ISO8601</a> format).
let endDate = new Date("2013-10-20"); // Date | End date (in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener\">ISO8601</a> format).
let opts = { 
  'format': "format_example", // String | 
  'limit': 56, // Number | 
  'order': "order_example" // String | 
};
apiInstance.meFinancialsTransactionsGet(startDate, endDate, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
startDate Date Start date (in <a href=&quot;https://en.wikipedia.org/wiki/ISO_8601\" target=&quot;_blank&quot; rel=&quot;noopener&quot;>ISO8601</a> format).
endDate Date End date (in <a href=&quot;https://en.wikipedia.org/wiki/ISO_8601\" target=&quot;_blank&quot; rel=&quot;noopener&quot;>ISO8601</a> format).
format String [optional]
limit Number [optional]
order String [optional]

Return type

FinancialTransactions

Authorization

accessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json