A payment container is an object to store a payment instrument of a customer. Currently you can only store bank account data. But in general it is open for all types of payment instruments, f. e. like credit card or a paypal account.

The advantage of this payment container is, that it’s allow you to store sensitive data and then use only the id of the container to create new payment transactions (without storing the details on your side). Depending on your access rights and on the sensibility of the data (f.e for credit card data) you are maybe only allowed to receive the masked data of the payment instrument.

When you transmit the customer id to this container, you are only allowed to store the same payment instrument once for this customer. Otherwise you will get an error. (But you are able to store this data to another customer when needed).

Using the secuconnect API one can:

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

Every API user who is able to access the payment service can create or update a Payment Container but To delete a Payment Container you need additional access rights, so for the most of the api users it is not allowed.

API uses following data structures:

SecuConnectApi.PaymentContainersApi

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

Method HTTP request Description
paymentContainersGet GET Payment/Containers GET Payment/Containers
paymentContainersGetById GET Payment/Containers/{id} GET Payment/Containers/{id}
paymentContainersIdAssignSecondaryIdDelete DELETE Payment/Containers/{id}/assign/{secondary-id} DELETE Payment/Containers/{id}/assign/{secondary-id}
paymentContainersIdAssignSecondaryIdPost POST Payment/Containers/{id}/assign/{secondary-id} POST Payment/Containers/{id}/assign/{secondary-id}
paymentContainersIdDelete DELETE Payment/Containers/{id} DELETE Payment/Containers/{id}
paymentContainersIdPut PUT Payment/Containers/{id} PUT Payment/Containers/{id}
paymentContainersPost POST Payment/Containers POST Payment/Containers

paymentContainersGet

PaymentContainersList paymentContainersGet(opts)

GET Payment/Containers

Get a list of payment containers

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.PaymentContainersApi();

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.paymentContainersGet(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.PaymentContainersList

Properties

Name Type Description Notes
count Number Number of existing payment containers [optional]
data [PaymentContainersProductModel] GET Payment/Containers [optional]

Authorization

oauth_token

HTTP request headers

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

paymentContainersGetById

PaymentContainersProductModel paymentContainersGetById(id)

GET Payment/Containers/{id}

Get all payment containers

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.PaymentContainersApi();

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

apiInstance.paymentContainersGetById(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

PaymentContainersProductModel

Authorization

oauth_token

HTTP request headers

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

paymentContainersIdAssignSecondaryIdDelete

[PaymentContainersProductModel] paymentContainersIdAssignSecondaryIdDelete(id, secondaryId)

DELETE Payment/Containers/{id}/assign/{secondary-id}

Removes an existing payment container assignment

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.PaymentContainersApi();

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

let secondaryId = "secondaryId_example"; // String | Id for which container is currently assigned to

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

Parameters

Name Type Description Notes
id String Payment container id
secondaryId String Id for which container is currently assigned to

Return type

[PaymentContainersProductModel]

Authorization

oauth_token

HTTP request headers

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

paymentContainersIdAssignSecondaryIdPost

PaymentContainersProductModel paymentContainersIdAssignSecondaryIdPost(id, secondaryId)

POST Payment/Containers/{id}/assign/{secondary-id}

Assign an existing payment container to ...

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.PaymentContainersApi();

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

let secondaryId = "secondaryId_example"; // String | Id to which container will be assigned

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

Parameters

Name Type Description Notes
id String Payment container id
secondaryId String Id to which container will be assigned

Return type

PaymentContainersProductModel

Authorization

oauth_token

HTTP request headers

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

paymentContainersIdDelete

[PaymentContainersProductModel] paymentContainersIdDelete(id)

DELETE Payment/Containers/{id}

Delete payment container

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.PaymentContainersApi();

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

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

Parameters

Name Type Description Notes
id String Payment container id

Return type

[PaymentContainersProductModel]

Authorization

oauth_token

HTTP request headers

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

paymentContainersIdPut

PaymentContainersProductModel paymentContainersIdPut(id, body)

PUT Payment/Containers/{id}

Update payment container

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.PaymentContainersApi();

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

let body = new SecuConnectApi.PaymentContainersDTO(); // PaymentContainersDTO | Payment container properties

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

Parameters

Name Type Description Notes
id String Payment container id
body PaymentContainersDTO Payment container properties

Return type

PaymentContainersProductModel

Authorization

oauth_token

HTTP request headers

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

paymentContainersPost

PaymentContainersProductModel paymentContainersPost(body)

POST Payment/Containers

Add new containers

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.PaymentContainersApi();

let body = new SecuConnectApi.PaymentContainersDTO(); // PaymentContainersDTO | Payment container properties

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

Parameters

Name Type Description Notes
body PaymentContainersDTO Payment container properties

Return type

PaymentContainersProductModel

Authorization

oauth_token

HTTP request headers

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