direct debit or direct withdrawal is a financial transaction in which one person withdraws funds from another person's bank account. Formally, the person who directly draws the funds ("the payee") instructs his or her bank to collect (i.e., debit) an amount directly from another's ("the payer's") bank account designated by the payer and pay those funds into a bank account designated by the payee. Before the payer's banker will allow the transaction to take place, the payer must have advised the bank that he or she has authorized the payee to directly draw the funds.

See more

To use payment secupay debits transaction your contract needs to be activated for this.

You can only cancel a payment transaction, no delete it's not possible.

Using the secuconnect API one can:

  • create a new debit transaction;
  • read the debit transaction data;
  • cancel the debit transaction.

API uses following data structures:

SecuConnectApi.PaymentSecupayDebitsApi

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

Method HTTP request Description
paymentSecupayDebitsCancelById POST Payment/Secupaydebits/{hash}/cancel
paymentSecupayDebitsGetById GET Payment/Secupaydebits/{hash}
paymentSecupaydebitsPost POST Payment/Secupaydebits

paymentSecupayDebitsCancelById

Object paymentSecupayDebitsCancelById(hash)

POST Payment/Secupaydebits/{id}/cancel

Function to cancel the transaction

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

let hash = "hash_example"; // String | Transaction hash

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

Parameters

Name Type Description Notes
hash String Transaction hash

Return type

Object

Authorization

oauth_token

HTTP request headers

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

paymentSecupayDebitsGetById

SecupayTransactionProductModel paymentSecupayDebitsGetById(hash)

Get the details of a payment transaction

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

let hash = "hash_example"; // String | Payment transaction ID

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

Parameters

Name Type Description Notes
hash String Payment transaction ID

Return type

SecuConnectApi.SecupayTransactionProductModel

Properties

Name Type Description Notes
_object String Product name [optional]
id String ID of instance [optional]
transId Number Transaction identifier [optional]
status String Transaction status [optional]
amount Number Total amount of payment in cents (or the smallest cash unit of the relevant currency) [optional]
currency String ISO 4217 code of currency, eg EUR for Euro. [optional]
purpose String The purpose of the payment. This is the later assignment of the payment is for example on the account statement of the buyer. [optional]
orderId String Specifying an order number. Depending on the contract setting, this must be unique for each payment. [optional]
basket [SecupayBasketItem] A list of items that are being purchased. [optional]
transactionStatus String Transaction status (number) [optional]
accrual Boolean Indicates whether the payment is locked for pay-out (TRUE) or not (FALSE). Standard value here is FALSE. [optional]
paymentAction String Specifies whether a pre-authorization (\"authorization\") or instant payment ( \"sale\") is to be performed. Standard value here is \"sale\". The collection of the pre-authorized payment is made with the \"capture\" command. [optional]
transferPurpose String The purpose the payer needs to use for his transfer [optional]
transferAccount SecupayTransactionProductModelTransferAccount [optional]
customer PaymentCustomersProductModel The customer object [optional]
usedPaymentInstrument SecupayTransactionProductModelUsedPaymentInstrument [optional]
redirectUrl SecupayTransactionProductModelRedirectUrl [optional]
iframeUrl String The url of the payment checkout iframe [optional]
container PaymentContainersProductModel The container object [optional]

Authorization

oauth_token

HTTP request headers

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

paymentSecupaydebitsPost

SecupayTransactionProductModel paymentSecupaydebitsPost(opts)

POST Payment/Secupaydebits

Start a debit payment transaction

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

let opts = { 
  'body': new SecuConnectApi.SecupayTransactionProductDTO() // SecupayTransactionProductDTO | Debit payment transaction input properties
};
apiInstance.paymentSecupaydebitsPost(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
body SecupayTransactionProductDTO Debit payment transaction input properties [optional]

Return type

SecuConnectApi.SecupayTransactionProductModel

Properties

Name Type Description Notes
_object String Product name [optional]
id String ID of instance [optional]
transId Number Transaction identifier [optional]
status String Transaction status [optional]
amount Number Total amount of payment in cents (or the smallest cash unit of the relevant currency) [optional]
currency String ISO 4217 code of currency, eg EUR for Euro. [optional]
purpose String The purpose of the payment. This is the later assignment of the payment is for example on the account statement of the buyer. [optional]
orderId String Specifying an order number. Depending on the contract setting, this must be unique for each payment. [optional]
basket [SecupayBasketItem] A list of items that are being purchased. [optional]
transactionStatus String Transaction status (number) [optional]
accrual Boolean Indicates whether the payment is locked for pay-out (TRUE) or not (FALSE). Standard value here is FALSE. [optional]
paymentAction String Specifies whether a pre-authorization (\"authorization\") or instant payment ( \"sale\") is to be performed. Standard value here is \"sale\". The collection of the pre-authorized payment is made with the \"capture\" command. [optional]
transferPurpose String The purpose the payer needs to use for his transfer [optional]
transferAccount SecupayTransactionProductModelTransferAccount [optional]
customer PaymentCustomersProductModel The customer object [optional]
usedPaymentInstrument SecupayTransactionProductModelUsedPaymentInstrument [optional]
redirectUrl SecupayTransactionProductModelRedirectUrl [optional]
iframeUrl String The url of the payment checkout iframe [optional]
container PaymentContainersProductModel The container object [optional]

Authorization

oauth_token

HTTP request headers

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