Skip to main content

Transaction Event

Webhook

Transaction 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 TransactionEventType (string)

    Possible values: [TransactionDeclined, TransactionCancelled, TransactionCompleted]

    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

    amount numberrequired

    The amount of the transaction. 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 uuid

    The unique id of the customer participating in the transaction.

    merchantId uuid

    The unique id of the merchant participating in the transaction.

    distributorId uuid

    The distributor at which the transaction got created/modified. Available only to merchants which have been configured to receive it.

    type TransactionType (string)required

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

    The type of the transaction, defining which other transaction properties are mandatory, e.g. PassthroughDeposit requires customerId, merchantId, documents, card

    state TransactionState (string)required

    Possible values: [Declined, Completed, Cancelled]

    The current(last) state of the transaction.

    stateDetails

    object

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

    declineReason TransactionDeclineReason (string)

    Possible values: [DistributorNotActive, CustomerPermissionDenied, MissingTransactionProofOfIdentity, InsufficientFunds, LimitAmountThresholdExceeded, LimitTimeThresholdExceeded, OneOrMoreLimitThresholdsExceeded, LimitAccountSetNotFound, DisallowedByConfig]

    Available if state is Declined

    status TransactionStatus (string)required

    Possible values: [BeingProcessed, Succeeded, Failed]

    The overall status/outcome of the transaction.

    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 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 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...