The customer is the customer of the merchant. There is an object created with the payment transaction. So in most cases "Customer" is the person who will pay the created payment transaction.

Customer is a collection of personal data and address.

Every time a new customer (payer) registered on the platform and wants to make a payment for the first time, it is necessary to transfer the customer data to the secuconnect-API. The created Customer-ID can then be reused for each future payment transaction payment

Possible actions :

  • create a new customer;
  • read the customers data;
  • update an existing customer;
  • delete a customer;
  • read a list of all existing customers.

Every API user who is able to access the payment service can create a new customer, read his data, update it, delete it and get a list of all existing customers.

API uses following data structures:

  • PaymentCustomerDTO

The following parameter SHOULD be transmitted on every update or create:

  • forename
  • surname
  • companyname (only in case of a company)
  • email
  • address
    • street
    • street_number
    • postal_code
    • city
    • country

SecuConnectApi.PaymentCustomersApi

All URIs are relative to https://connect-testing.secupay-ag.de/api/v2/

Method HTTP request Description
paymentCustomersGet GET Payment/Customers GET Payment/Customers
paymentCustomersGetById GET Payment/Customers/{id} GET Payment/Customers/{id}
paymentCustomersIdDelete DELETE Payment/Customers/{id} DELETE Payment/Customers/{id}
paymentCustomersIdPut PUT Payment/Customers/{id} PUT Payment/Customers/{id}
paymentCustomersPost POST Payment/Customers POST Payment/Customers

paymentCustomersGet

PaymentCustomersList paymentCustomersGet(opts)

GET Payment/Customers

Get a list of payment customers

Example

import SecuConnectApi from 'secu_connect_api';
let defaultClient = SecuConnectApi.ApiClient.instance;

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

let apiInstance = new SecuConnectApi.PaymentCustomersApi();

let opts = { 
  'count': 56, // Number | The number of items to return.
  'offset': 56, // Number | The position within the whole result set to start returning items (First element is at 0).
  'fields': "fields_example", // String | List of fields to include in the result. Nested properties can be accessed with this notation: prop1.prop2  Example: prop3,prop1.prop2
  'q': "q_example", // String | A query string to restrict the returned items to given conditions. The query string must consist of any combination of single expressions in the form property:condition.  *                  A condition may contain:  *                      - wildcard \"*\" for any number of characters  *                      - wildcard \"?\" for one character  *                      - ranges in the form [value TO value]  *  *                  Single expressions may combined by 'AND', 'OR', 'NOT' operators and parenthesis '(', ')' for grouping.  *                  Property names can be nested like \"prop1.prop2\".  *                  Example: (NOT customer.name:meier*) AND (customer.age:[30 TO 40] OR customer.age:[50 TO 60])  *                  
  'sort': "sort_example" // String | String with comma separated pairs of field:order (e.g. contact.surname:asc,contact.comapnyname:desc). Result set will be sorted by included fields, in ascending 'asc', or descending 'dsc' order.
};
apiInstance.paymentCustomersGet(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
count Number The number of items to return. [optional]
offset Number The position within the whole result set to start returning items (First element is at 0). [optional]
fields String List of fields to include in the result. Nested properties can be accessed with this notation: prop1.prop2 Example: prop3,prop1.prop2 [optional]
q String A query string to restrict the returned items to given conditions. The query string must consist of any combination of single expressions in the form property:condition. A condition may contain: - wildcard \"\" for any number of characters - wildcard \"?\" for one character - ranges in the form [value TO value] Single expressions may combined by 'AND', 'OR', 'NOT' operators and parenthesis '(', ')' for grouping. Property names can be nested like \"prop1.prop2\". Example: (NOT customer.name:meier) AND (customer.age:[30 TO 40] OR customer.age:[50 TO 60]) * [optional]
sort String String with comma separated pairs of field:order (e.g. contact.surname:asc,contact.comapnyname:desc). Result set will be sorted by included fields, in ascending 'asc', or descending 'dsc' order. [optional]

Return type

SwaggerJsClient.PaymentCustomersList

Properties

Name Type Description Notes
count Number Number of existing payment customers [optional]
data [PaymentCustomersProductModel] GET Payment/Customers [optional]

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

paymentCustomersGetById

PaymentCustomersProductModel paymentCustomersGetById(id)

GET Payment/Customers/{id}

Get all payment customers

Example

import SecuConnectApi from 'secu_connect_api';
let defaultClient = SecuConnectApi.ApiClient.instance;

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

let apiInstance = new SecuConnectApi.PaymentCustomersApi();

let id = "id_example"; // String | Search one by provided id

apiInstance.paymentCustomersGetById(id).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id String Search one by provided id

Return type

PaymentCustomersProductModel

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

paymentCustomersIdDelete

[PaymentCustomersProductModel] paymentCustomersIdDelete(id)

DELETE Payment/Customers/{id}

Delete payment customer

Example

import SecuConnectApi from 'secu_connect_api';
let defaultClient = SecuConnectApi.ApiClient.instance;

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

let apiInstance = new SecuConnectApi.PaymentCustomersApi();

let id = "id_example"; // String | Payment customer id

apiInstance.paymentCustomersIdDelete(id).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id String Payment customer id

Return type

[PaymentCustomersProductModel]

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

paymentCustomersIdPut

PaymentCustomersProductModel paymentCustomersIdPut(id, body)

PUT Payment/Customers/{id}

Update payment customer

Example

import SecuConnectApi from 'secu_connect_api';
let defaultClient = SecuConnectApi.ApiClient.instance;

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

let apiInstance = new SecuConnectApi.PaymentCustomersApi();

let id = "id_example"; // String | Payment customer id

let body = new SecuConnectApi.PaymentCustomersDTO(); // PaymentCustomersDTO | Payment customer properties

apiInstance.paymentCustomersIdPut(id, body).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id String Payment customer id
body PaymentCustomersDTO Payment customer properties

Return type

PaymentCustomersProductModel

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

paymentCustomersPost

PaymentCustomersProductModel paymentCustomersPost(body)

POST Payment/Customers

Add new customer

Example

import SecuConnectApi from 'secu_connect_api';
let defaultClient = SecuConnectApi.ApiClient.instance;

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

let apiInstance = new SecuConnectApi.PaymentCustomersApi();

let body = new SecuConnectApi.PaymentCustomersDTO(); // PaymentCustomersDTO | Payment customer properties

apiInstance.paymentCustomersPost(body).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
body PaymentCustomersDTO Payment customer properties

Return type

PaymentCustomersProductModel

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined