Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PayObject

export
interface

PayObject

Hierarchy

  • PayObject

Index

Properties

amount

amount: number

Amount to transfer

memberof

PayObject

Optional currency_id

currency_id: Currency

Currency id of amount, e.g. 'EUR'

memberof

PayObject

id

id: string

Transaction id

memberof

PayObject

Optional merchant_id

merchant_id: undefined | string

Data will be returned unchanged

memberof

PayObject

Optional metadata

metadata: any

Custom data will be returned unchanged. If no data was submitted, this field will be null

memberof

PayObject

object

object: string

Object type, in this case a xs2a_payment

memberof

PayObject

payment_status

payment_status: PaymentStatus

Payment status of the transaction, values NONE, RECEIVED, LOSS

memberof

PayObject

purpose

purpose: string

Purpose of transfer

memberof

PayObject

Optional recipient_bank_name

recipient_bank_name: undefined | string

Name of the recipient bank

memberof

PayObject

Optional recipient_bic

recipient_bic: undefined | string

BIC of the recipient account

memberof

PayObject

Optional recipient_country_id

recipient_country_id: Country

Two letter country code id, e.g. AT, CH, DE or the recipient account

memberof

PayObject

Optional recipient_holder

recipient_holder: undefined | string

Account holder of the recipient account

memberof

PayObject

Optional recipient_iban

recipient_iban: undefined | string

IBAN of the recipient account

memberof

PayObject

Optional sender_bank_name

sender_bank_name: undefined | string

Name of the sender bank

memberof

PayObject

Optional sender_bic

sender_bic: undefined | string

BIC of the sender account

memberof

PayObject

Optional sender_country_id

sender_country_id: Country

Two letter country code id, e.g. AT, CH, DE or the sender account

memberof

PayObject

Optional sender_holder

sender_holder: undefined | string

Account holder of the sender account

memberof

PayObject

Optional sender_iban

sender_iban: undefined | string

IBAN of the sender account

memberof

PayObject

testmode

testmode: string

Indicates whether or not it is a test transaction

memberof

PayObject

transaction

transaction: string

Internal XS2A transaction id. This id will be the same for the whole transaction

memberof

PayObject

Generated using TypeDoc