Transaction

Key

Type

Description

id

integer

Internal transaction ID

uuid

string|integer

Public transaction ID

time

datetime (YYYY-MM-DD HH:MM:SS)

Date and time of transaction creation

status

string

The status of the transaction - Notifications (Webhooks)

lang

string

ISO 639-1

of shopper language

psp

string

The name of the payment service provider

pspId

integer

The ID of the

payment service provider

amount -

changelog

integer

The amount of the transaction in the smallest unit of the transaction currency (for refunds it is the amount of the refund transaction)

payrexxFee

integer

The transaction fee charged by Payrexx (does not include fees from acquiring or interchange fees). The fee is provided in the smallest unit of the currency.

preAuthorizationId

integer

The ID of the origin pre-authorization transaction - changelog


payment

object

referenceId

string

The reference which has been passed when creating a Gateway / Invoice. OR: The referenceId which has been passed along with a charge on a pre-authorization.

metadata

array|Metadata object (version < 2021-10-12)

  • Metadata object (version >= 2021-10-12)

Note version < 2021-10-12: empty object was transferred as empty array.

Documentation

subscription

Subscription

object

Documentation

invoice

Invoice

object

Documentation

contact

Contact

object

Documentation

refundable

boolean

Indicates whether refunds are possible -

changelog

partiallyRefundable

boolean

Indicates whether partial refunds are possible -

changelog

purchaseOnInvoiceInformation

Introduced in version 2024.06.01

changelog

Information on where to transfer the money for bank transfer payments.

instanceName

string

Name of Instance

instanceUuid

string

UUID of Instance

type

string

Type of the transaction (POS, E-Commerce)

posSerialNumber

string

Serial number of the POS terminal

posTerminalName

string

Name of the POS terminal

Example

{
  "id": 1,
  "uuid": "82m09f9",
  "time": "2014-11-18 13:44:53",
  "status": "waiting",
  "lang": "en",
  "psp": "Native_PSP",
	"pspId": 44,
  "payrexxFee": 0,
  "payment": {
    "brand": "visa",
    "wallet": null,
    "cardholderName": "Erika Mustermann",
    "purchaseOnInvoiceInformation": {
      "zip": "3600",
      "iban": "CH7431101111011000246",
      "place": "Thun",
      "swift": "KLARCH22XXX",
      "address": "Burgstrasse 20",
      "company": "Payrexx AG",
      "bankName": "Klarpay AG",
      "reference": "287133000000000000000128000"
    }
  },
	"metadata": { /* Metadata object */ },
	"invoice": { /* Invoice object */ },
	"contact": { /* Contact object */ },
  "type": "E-Commerce",
  "posSerialNumber": "N500W123456",
  "posTerminalName": "Cash register 1"
}