/api/Payment

Time	Status	User Agent
Retrieving recent requests…

Body Params

Represent recurring or capture request. For capture request, PreauthTransactionId must be specified.

pspSettingsId

string | null

The identifier of PSP settings to identify a PSP module. Mandatory. Not used now, since part of not ended integration flow with billwerk.

transactionId

string | null

The transaction identifier from billwerk side. Mandatory.

preauthTransactionId

string | null

The identifier of billwerk preauth transaction. Indicate, that this payment request init for capture. Optional.

requestedAmount

double

Payment requested amount. Mandatory. Positive number.

currency

string | null

The currency of payment. Mandatory. ISO-4217 format.

webhookTarget

string | null

The notification URL from Billwerk side. Mandatory. A string containing the entire absolute URL.

paymentMeansReference

object

Represents the payment means ref data. It include needed info for initial preauth request.

transactionInvoiceReferenceText

string | null

The reference text of invoice linked to payment transaction. Optional, experimental one! Can be changed/replaced in future! Includes linked invoice reference code, description and unique reference of transaction.

transactionReferenceText

string | null

The reference text for transaction. Mandatory. Includes Billwerk payment transaction id, description and unique reference of transaction.

payerData

object

Represents a payer data

plannedExecutionDate

date | null

Calculated Direct Debit planned execution date of a payment. It is based on prenotification days count configured in PSP settings, or its default value. Calculation excludes bank holidays. Mandatory for Direct Debit only.

invoiceData

object

Reflection of billwerk invoice model, including line items.

agreementId

string | null

Id which specify agreement between 3-rd party integration and billwerk according payment actions, which initiated by billwerk for specific customer and supported by 3-rd party integration. Mandatory.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

200Success