invoice billing 

German: Rechnungskauf

Invoice billing is a → . The goods are delivered against an invoice to be paid later. This means more risk and should only be provided to trusted buyers.

Invoice billing must not be mixed up with the invoice itself.

So this payment  is a forms of trade credit which specify that the net amount (the total outstanding on the invoice) is expected to be paid in full and received by the seller within 10 days after the goods are dispatched or service is completed so the payer can transfer the money after he has received the product or the service. 


To use this payment method your contract needs to be activated for this payment method.

Using the secuconnect API one can:

  • create a new invoice transaction;
  • ;
  • .

API uses following data structures:

SecuConnectApi.PaymentSecupayInvoicesApi

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

Method HTTP request Description
paymentSecupayInvoicesCancelById POST Payment/Secupayinvoices/{hash}/cancel POST Payment/Secupayinvoices/{id}/cancel
paymentSecupayInvoicesGetById GET Payment/Secupayinvoices/{hash} GET Payment/Secupayinvoices/{id}
paymentSecupayinvoicesPost POST Payment/Secupayinvoices POST Payment/Secupayinvoices

paymentSecupayInvoicesCancelById

Object paymentSecupayInvoicesCancelById(hash)

POST Payment/Secupayinvoices/{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.PaymentSecupayInvoicesApi();

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

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

paymentSecupayInvoicesGetById

SecupayTransactionProductModel paymentSecupayInvoicesGetById(hash)

GET Payment/Secupayinvoices/{id}

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

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

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

paymentSecupayinvoicesPost

SecupayTransactionProductModel paymentSecupayinvoicesPost(opts)

POST Payment/Secupayinvoices

Start a invoice 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.PaymentSecupayInvoicesApi();

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

Parameters

Name Type Description Notes
body SecupayTransactionProductDTO Invoice 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