credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services based on the cardholder's promise to the card issuer to pay them for the amounts so paid plus the other agreed charges. The card issuer (usually a bank) creates a revolving account and grants a line of credit to the cardholder, from which the cardholder can borrow money for payment to a merchant or as a cash advance. In other words, credit cards combine payment services with extensions of credit. See more

To Use credit cards transaction your contract needs to be activated for this.

You can only cancel this payment transaction, no delete is possible. Update the payment transaction is very restricted only to some special fields. 

Using the secuconnect API one can:

  • create a new credit card transaction;
  • read the credit card transaction data;
  • cancel the credit card transaction.

API uses following data structures:

PaymentSecupayCreditcardsApi

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

Method HTTP request Description
paymentSecupayCreditcardsCancelById POST Payment/Secupaycreditcards/{hash}/cancel POST Payment/Secupaycreditcards/{id}/cancel
paymentSecupayCreditcardsGetById GET Payment/Secupaycreditcards/{hash} GET Payment/Secupaycreditcards/{id}
paymentSecupaycreditcardsPost POST Payment/Secupaycreditcards POST Payment/Secupaycreditcards

paymentSecupayCreditcardsCancelById

Object paymentSecupayCreditcardsCancelById(hash)

POST Payment/Secupaycreditcards/{id}/cancel

Function to cancel the transaction

Example

// Import classes:
//import io.secuconnect.client.ApiClient;
//import io.secuconnect.client.ApiException;
//import io.secuconnect.client.Configuration;
//import io.secuconnect.client.auth.*;
//import io.secuconnect.client.api.PaymentSecupayCreditcardsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth_token
OAuth oauth_token = (OAuth) defaultClient.getAuthentication("oauth_token");
oauth_token.setAccessToken("YOUR ACCESS TOKEN");

PaymentSecupayCreditcardsApi apiInstance = new PaymentSecupayCreditcardsApi();
String hash = "hash_example"; // String | Transaction hash
try {
    Object result = apiInstance.paymentSecupayCreditcardsCancelById(hash);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PaymentSecupayCreditcardsApi#paymentSecupayCreditcardsCancelById");
    e.printStackTrace();
}

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

paymentSecupayCreditcardsGetById

SecupayTransactionProductModel paymentSecupayCreditcardsGetById(hash)

GET Payment/Secupaycreditcards/{id}

Get the details of a payment transaction

Example

// Import classes:
//import io.secuconnect.client.ApiClient;
//import io.secuconnect.client.ApiException;
//import io.secuconnect.client.Configuration;
//import io.secuconnect.client.auth.*;
//import io.secuconnect.client.api.PaymentSecupayCreditcardsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth_token
OAuth oauth_token = (OAuth) defaultClient.getAuthentication("oauth_token");
oauth_token.setAccessToken("YOUR ACCESS TOKEN");

PaymentSecupayCreditcardsApi apiInstance = new PaymentSecupayCreditcardsApi();
String hash = "hash_example"; // String | Payment transaction ID
try {
    SecupayTransactionProductModel result = apiInstance.paymentSecupayCreditcardsGetById(hash);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PaymentSecupayCreditcardsApi#paymentSecupayCreditcardsGetById");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
hash String Payment transaction ID

Return type

SecupayTransactionProductModel

Properties

Name Type Description Notes
object String Product name [optional]
id String ID of instance [optional]
transId Integer Transaction identifier [optional]
status String Transaction status [optional]
amount Integer 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 List<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

paymentSecupaycreditcardsPost

SecupayTransactionProductModel paymentSecupaycreditcardsPost(body)

POST Payment/Secupaycreditcards

Start a credit card payment transaction

Example

// Import classes:
//import io.secuconnect.client.ApiClient;
//import io.secuconnect.client.ApiException;
//import io.secuconnect.client.Configuration;
//import io.secuconnect.client.auth.*;
//import io.secuconnect.client.api.PaymentSecupayCreditcardsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth_token
OAuth oauth_token = (OAuth) defaultClient.getAuthentication("oauth_token");
oauth_token.setAccessToken("YOUR ACCESS TOKEN");

PaymentSecupayCreditcardsApi apiInstance = new PaymentSecupayCreditcardsApi();
SecupayTransactionProductDTO body = new SecupayTransactionProductDTO(); // SecupayTransactionProductDTO | Credit card payment transaction input properties
try {
    SecupayTransactionProductModel result = apiInstance.paymentSecupaycreditcardsPost(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PaymentSecupayCreditcardsApi#paymentSecupaycreditcardsPost");
    e.printStackTrace();
}

Parameters

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

Return type

SecupayTransactionProductModel

Properties

Name Type Description Notes
object String Product name [optional]
id String ID of instance [optional]
transId Integer Transaction identifier [optional]
status String Transaction status [optional]
amount Integer 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 List<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