MerchantAccountApi.md

SumUpRestApi.MerchantAccountApi

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

Method	HTTP request	Description
meMerchantProfileBankAccountsGet	GET /me/merchant-profile/bank-accounts	List bank accounts
meMerchantProfileDoingBusinessAsGet	GET /me/merchant-profile/doing-business-as	Retrieve DBA
meMerchantProfileGet	GET /me/merchant-profile	Retrieve a profile
meMerchantProfileSettingsGet	GET /me/merchant-profile/settings	List settings

meMerchantProfileBankAccountsGet

[BankAccount] meMerchantProfileBankAccountsGet(opts)

List bank accounts

Retrives bank accounts of the merchant.

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.MerchantAccountApi();
let opts = { 
  'primary': true // Boolean | The true value will return only the primary bank account (the one used for settlements).
};
apiInstance.meMerchantProfileBankAccountsGet(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
primary	Boolean	The true value will return only the primary bank account (the one used for settlements).	[optional]

Return type

[BankAccount]

Authorization

accessToken

HTTP request headers

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

meMerchantProfileDoingBusinessAsGet

DoingBusinessAs meMerchantProfileDoingBusinessAsGet()

Retrieve DBA

Retrieves Doing Business As profile.

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.MerchantAccountApi();
apiInstance.meMerchantProfileDoingBusinessAsGet((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

DoingBusinessAs

Authorization

accessToken

HTTP request headers

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

meMerchantProfileGet

MerchantProfile meMerchantProfileGet()

Retrieve a profile

Retrieves merchant profile data.

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.MerchantAccountApi();
apiInstance.meMerchantProfileGet((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

MerchantProfile

Authorization

accessToken

HTTP request headers

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

meMerchantProfileSettingsGet

MerchantSettings meMerchantProfileSettingsGet()

List settings

Retrieves merchant settings.

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.MerchantAccountApi();
apiInstance.meMerchantProfileSettingsGet((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

MerchantSettings

Authorization

accessToken

HTTP request headers

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