Transaction

Content

Key
Type
Description

id

int

Internal transaction ID

uuid

string

  • Public transaction ID

  • 8 - 40 characters long

amount

int

The processed amount

referenceId

string

Custom reference

time

string

Date and time of the transaction creation in the ISO 8601 format (2025-10-01T09:36:07+00:00)

lang

string

ISO 639-1 arrow-up-rightof shopper language

mode

string

TEST or LIVE

type

string

  • Shows which way the transaction was processed

  • One of E-Commerce, POS-Terminal, Tap to Pay

posSerialNumber

string|null

Dependent on the value of type :

  • POS-Terminal : the serial number of the used POS device

  • E-Commerce or Tap to Pay: null

posTerminalName

string|null

Dependent on the value of type :

  • POS-Terminal or Tap to Pay : the name of the used POS device/Tap to Pay Terminal

  • E-Commerce : null

refundable

bool

States if a refund can be performed

partiallyRefundable

bool

States if a partial refund can be performed

instance

Instance

metadata

Metadata

invoice

Invoice

payment

Payment

contact

Contact|null

subscription

Subscription|null

See Subscription for further information

pageUuid

string|null

  • UUID of the page if present

  • 8 - 40 characters long

payrexxFee

int

  • Total fee amount

  • For platform merchants, the key is fee

preAuthorizationId

int

  • If the transaction is a tokenization, its ID is returned

  • If the transaction is a charge of a tokenization, the ID of the tokenization (source) is returned

  • Otherwise, the field is not added to the webhook

originalTransactionId

int

  • Present if this transaction is status refunded or partially-refunded

  • ID of the charged transaction

originalTransactionUuid

int

  • Present if this transaction is status refunded or partially-refunded

  • UUID of the charged transaction

  • 8 - 40 characters long

associatedSourceTransactionUuids

array

  • Only for merchants of marketplaces

  • UUIDs of all associated source transactions

associatedSourceTransactionIds

array

  • Only for merchants of marketplaces

  • IDs of all associated source transactions

sourceTransactionUuid

string|null

  • Only for merchants of marketplaces

  • UUID of the source transaction, null if there is none

sourceTransactionId

string|null

  • Only for merchants of marketplaces

  • ID of the source transaction, null if there is none

payoutUuid

string|null

Returns the UUID of the payout if the transaction is part of a payout. Otherwise, null is returned.

Changelog

chevron-right2025-04-29hashtag

The field time is now formatted in the ISO 8601 format. Example: 2025-10-01T09:36:07+00:00 - previously 2025-10-01 09:36:07.

An update to the payment object.

chevron-right2025-04-08hashtag

An update to the payment object.

chevron-right2025-03-03hashtag

There are new fields regarding POS devices.

type of type string

  • Shows which way the transaction was processed

  • One of E-Commerce, POS-Terminal, Tap to Pay

posSerialNumber of type string

  • null if type is E-Commerce

  • else, the number of the used POS device

posTerminalName of type string

  • null if type is E-Commerce

  • else, the name of the used POS device

chevron-right2024-11-12hashtag

An update to the payment object.

chevron-right2024-08-16hashtag

There is a new field instance of type object that contains information about the merchant, which contains two fields.

name of type string

  • Name of the account

uuid of type string

  • 8-character-long identifier

chevron-right2024-06-01hashtag

An update to the payment object.

chevron-right2023-10-20hashtag

There is a new field payoutUuid that returns the UUID of the payout if the transaction is part of one. If the transaction is not yet part of a payout, null is returned

chevron-right2022-11-29hashtag

An update to the payment object.

chevron-right2022-10-04hashtag

The charged fees are also returned to merchants of the platforms. For them, the key is adjusted from payrexxFee to fee.

There are two new fields regarding refunding a transaction.

refundable of type bool

  • States if a refund can be performed

partiallyRefundable of type bool

  • States if a partial refund can be performed

chevron-right2022-01-18hashtag

The field payrexx_fee is renamed to payrexxFee.

chevron-right2021-10-12hashtag

The field metadata is now returned as an object.

chevron-right2020-06-10hashtag

There is a new field amount of type int.

chevron-right2019-12-19hashtag

Webhooks are now sent for transactions with status refund-pending.

There is an adjustment to the field status. Transactions of status uncaptured are no longer treated as confirmed, but returned as they are.

chevron-right2019-10-15hashtag

There is a new field preAuthorizationId of type int. If the transaction is a tokenization, its ID is returned. If the transaction is a charge of a tokenization, the ID of the tokenization (source) is returned. Otherwise, the field is not added to the webhook.

chevron-right2019-02-13hashtag

There are adjustments to the field status. The exceptional handling of the statuses chargeback, error and partially-refunded is removed. They are returned as they are.

chevron-right2018-08-07hashtag

The first version. Webhooks are not sent for transactions with status refund-pending.

Status Values

Status
Description

waiting

Order has been placed

confirmed

Successful payment

cancelled

Payment aborted by the customer

declined

Failed 3D secure or declined by the issuer bank

authorized

Successful tokenization

reserved

Successful reservation

refunded

Full refund

partially-refunded

Partial refund

refund_pending

Refund is being processed

chargeback

Cardholder returns money

error

An issue occurred during the payment process

disputed

A dispute has been opened for this transaction

expired

Payment aborted due to inactivity

Example

Last updated