/api/Preauth

post

https://example.com/api/Preauth

Body Params

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. Format: {yyyyMMdd}-{ObjectId} Mandatory.

requestedAmount

double

Preauth requested amount. Mandatory. Not negative number.

currency

string | null

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

webhookTarget

string | null

The notification URL from billwerk side. Mandatory.

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 preauth transaction. Optional, experimental one! Can be changed/replaced in future! Includes linked invoice reference code, description and unique reference of transaction. Mandatory.

transactionReferenceText

string | null

The reference text for transaction. Includes billwerk preauth transaction id, description and unique reference of transaction. Mandatory.

payerData

object

Represents a payer data

orderData

object

Represents the order related data.

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.

migrationToken

string | null

The data required for migration via technical bearer Used to identify existing agreement/customer on PSP side to migrate contract date to billwerk. Optional

isInitial

boolean

Indicate, if preauth transaction initial or not. Mandatory. WARNING - can be replaced with separate endpoints for initial and non-initial preauth calls.

Response

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success