Payment

Occurrences

Content

Key
Type
Description

brand

string|null

The used payment method

wallet

string|null

  • The used wallet else null

  • Possible values:

    • apple-pay

    • google-pay

    • samsung-pay

    • visa-click-to-pay

    • mastercard-click-to-pay

cardNumber

string

  • The number of the card

  • Only present if cardNumber and expiry exist.

expiry

string

  • The expiry date of the card

  • Only present if cardNumber and expiry exist.

cardholderName

string

  • The name of the cardholder

  • Only present if cardNumber and expiry exist.

originInstanceUuid

string|null

  • Only for merchants of marketplaces, and if the payment method is account

  • UUID of the instance on which the transaction was performed

originInstanceId

string|null

  • Only for merchants of marketplaces, and if the payment method is account

  • ID of the instance on which the transaction was performed

originInstanceName

string|null

  • Only for merchants of marketplaces, and if the payment method is account

  • Name of the instance on which the transaction was performed

destinationInstanceUuid

string|null

  • Only for merchants of marketplaces, and if the payment method is account

  • UUID of the instance where the money is transferred to

destinationInstanceId

string|null

  • Only for merchants of marketplaces, and if the payment method is account

  • ID of the instance where the money is transferred to

destinationInstanceName

string|null

  • Only for merchants of marketplaces, and if the payment method is account

  • Name of the instance where the money is transferred to

purchaseOnInvoiceInformation

object

  • The data of the recipient for bank transfer payments, otherwise null

  • All values are strings:

    • company

    • address

    • zip

    • place

    • bankName

    • swift

    • iban

    • reference

cardCountry

string

  • The country in which the card was issued

  • Only present if the value is not empty

Example

{
  "brand": "visa",
  "wallet": null,
  "cardNumber": "424242xxxxxx4242",
  "expiry": "2028-11",
  "cardholderName": "Payrexx Test",
  "purchaseOnInvoiceInformation": null,
  "cardCountry": "CH"
}

Changelog

chevron-right2025-04-29hashtag

There are several new fields for marketplace instances:

  • originInstanceUuid

  • originInstanceId

  • originInstanceName

  • destinationInstanceUuid

  • destinationInstanceId

  • destinationInstanceName

They are only returned if the payment method is account.

chevron-right2025-04-08hashtag

There is a new field cardholderName, which stores the name of the cardholder.

chevron-right2024-11-12hashtag

There is a new field cardCountry, which stores the country the card is issued in.

chevron-right2024-06-01hashtag

There is a new field, purchaseOnInvoiceInformation, which stores the data of the recipient for bank transfer payments.

chevron-right2022-11-29hashtag

There is a new field wallet that states which wallet was used for this transaction, if so.

Last updated