Skip to main content

Transaction Intent Event

Webhook

Transaction Intent Event

Request​

Body

    specversion stringrequired

    The version of the CloudEvents specification which the event uses. This enables the interpretation of the context. Compliant event producers MUST use a value of 1.0 when referring to this version of the specification.

    id uuidrequired

    The unique id of the event.

    source stringrequired

    Identifies the context in which an event happened

    time date-time

    Timestamp of when the occurrence happened.

    datacontenttype string

    Content type of data value

    type TransactionIntentEventType (string)

    Possible values: [TransactionIntentDeclined, TransactionIntentCancelled, TransactionIntentExpired, TransactionIntentFinalized]

    The type of the event, defining also the attributes of which entity are to be found in the data property

    data

    object

    id uuidrequired

    The id of the transaction intent

    amount numberrequired

    The amount of the transaction intent. For deposits the maximum is 10.000,00

    currency stringrequired

    Possible values: [EUR]

    The currency code as ISO 4217 3-digit code (https://en.wikipedia.org/wiki/ISO_4217).

    customerId uuidrequired

    The unique id of the customer participating in the transaction intent.

    merchantId uuidrequired

    The unique id of the merchant participating in the transaction intent.

    type TransactionIntentType (string)required

    Possible values: [PassthroughDeposit, PassthroughWithdrawal, CustomerToMerchantPassthrough, MerchantToCustomerPassthrough]

    The type of the transaction intent, this corresponds to the type of the transaction created from the intent

    state TransactionIntentState (string)required

    Possible values: [Created, PendingApproval, Declined, Pending, Expired, Cancelled, Finalized]

    The current(last) state of the transaction intent.

    stateDetails

    object

    State-specific additional attributes, e.g. declineReason for Declined state

    declineReason TransactionIntentDeclineReason (string)

    Possible values: [MaxApprovalAttemptsReached, CustomerPermissionDenied, LimitAmountThresholdExceeded, LimitTimeThresholdExceeded, OneOrMoreLimitThresholdsExceeded, LimitAccountSetNotFound, MerchantNotFound]

    Available if state is Declined

    finalizeReason TransactionIntentFinalizeReason (string)

    Possible values: [TransactionCompleted, TransactionDeclined, TransactionCancelled]

    Available if state is Finalized

    externalReference ExternalReference (string)

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[\d\p{L}]([\d\p{L}\-\. ]{0,48}[\d\p{L}])$

    A reference to a transaction in an external system e.g. bank transfer.

    createdOn date-timerequired

    The server-generated timestamp of the initial creation of the transaction intent record, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time

    lastModifiedOn date-time

    The server-generated timestamp of the last update to the transaction intent record, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time

Responses​

Return a 204 status to indicate that the data was received successfully

Loading...