Payment

Payment object fields.

Occurrences

Content

KeyTypeDescription
brandstring|nullThe used payment method
walletstring|null
  • The used wallet else null
  • Possible values:

    • apple-pay
    • google-pay
    • samsung-pay
    • visa-click-to-pay
    • mastercard-click-to-pay
cardNumberstring
  • The number of the card
  • Only present if cardNumber and expiry exist.
expirystring
  • The expiry date of the card
  • Only present if cardNumber and expiry exist.
cardholderNamestring
  • The name of the cardholder
  • Only present if cardNumber and expiry exist.
originInstanceUuidstring|null
  • Only for merchants of marketplaces, and if the payment method is account
  • UUID of the instance on which the transaction was performed
originInstanceIdstring|null
  • Only for merchants of marketplaces, and if the payment method is account
  • ID of the instance on which the transaction was performed
originInstanceNamestring|null
  • Only for merchants of marketplaces, and if the payment method is account
  • Name of the instance on which the transaction was performed
destinationInstanceUuidstring|null
  • Only for merchants of marketplaces, and if the payment method is account
  • UUID of the instance where the money is transferred to
destinationInstanceIdstring|null
  • Only for merchants of marketplaces, and if the payment method is account
  • ID of the instance where the money is transferred to
destinationInstanceNamestring|null
  • Only for merchants of marketplaces, and if the payment method is account
  • Name of the instance where the money is transferred to
purchaseOnInvoiceInformationobject
  • The data of the recipient for bank transfer payments, otherwise null
  • All values are strings:

    • company
    • address
    • zip
    • place
    • bankName
    • swift
    • iban
    • reference
cardCountrystring
  • 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": "zahls.ch Test",
  "purchaseOnInvoiceInformation": null,
  "cardCountry": "CH"
}

Changelog

2025-04-29

There are several new fields for marketplace instances:

  • originInstanceUuid
  • originInstanceId
  • originInstanceName
  • destinationInstanceUuid
  • destinationInstanceId
  • destinationInstanceName

They are only returned if the payment method is account.

2025-04-08

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

2024-11-12

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

2024-06-01

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

2022-11-29

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