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, please see Notifications (Webhooks) for more information on the status.

lang

string

ISO 639-1 of shopper language

psp

string

Name of the payment service provider used

pspId

integer

The ID of the payment service provider (see Miscellaneous)

amount
(see 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)

payrexx_fee

integer

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

preAuthorizationId

integer

The ID of the origin pre-authorization transaction (see changelog)

payment

array

Payment mean as array
-brand (lowercase string)
-cardNumber (truncated PAN) (see changelog)
-expiry (format: YY-MM) (see changelog)
-wallet (lowercase string) (see changelog

The brand is a lowercase string

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.

See documentation

subscription

Subscription object

See documentation

invoice

Invoice object

See documentation

contact

Contact object

See documentation

refundable

boolean

Indicates whether refunds are possible
(see changelog)

partiallyRefundable

boolean

Indicates whether partial refunds are possible
(see 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 transaction (POS, E-Commerce)

posSerialNumber

string

Serial number of the pos terminal

posTerminalName

string

Name of the pos terminal

Example

<?php
[
  'id' => 1,
  'uuid' => '82m09f9',
  'time' => '2014-11-18 13:44:53',
  'status' => 'waiting',
  'lang' => 'en',
  'psp' => 'Test',
  'payrexx_fee' => 0,
  'payment' => [
    'brand' => 'VISA',
    'wallet'=> null,
    'purchaseOnInvoiceInformation' => [
      'zip' => '3600',
      'iban' => 'CH7431101111011000246',
      'place' => 'Thun',
      'swift' => 'KLARCH22XXX',
      'address' => 'Burgstrasse 20',
      'company' => 'Payrexx AG',
      'bankName' => 'Klarpay AG',
      'reference' => '287133000000000000000128000'
    ]
  ],
  'metadata' => Metadata,
  'subscription' => Subscription,
  'invoice' => Invoice,
  'contact' => Contact,
  'type' => 'E-Commerce',
  'posSerialNumber' => 'N500W123456',
  'posTerminalName' => 'Cash register 1'
];