Skip to main content

Interface: Payment

Defined in: type/Payment.ts:6

Object class for Payment

Properties

amount

amount: number

Defined in: type/Payment.ts:18

Payment amount [denomination in cents]


anonymousId?

optional anonymousId?: number

Defined in: type/Payment.ts:12

Guest User ID


createdAt

createdAt: string

Defined in: type/Payment.ts:28

Payment initial creation timestamp


createdBy?

optional createdBy?: string

Defined in: type/Payment.ts:30

Reference to the user that created the payment initially


currency

currency: string

Defined in: type/Payment.ts:20

Payment currency - ISO 4217 currency code => https://www.xe.com/iso4217.php


id

id: string | number

Defined in: type/Payment.ts:8

Payment primary identifier


lastModifiedAt

lastModifiedAt: string

Defined in: type/Payment.ts:32

Payment last update timestamp


lastModifiedBy?

optional lastModifiedBy?: string

Defined in: type/Payment.ts:34

Reference to the user that last modified the payment


method

method: string

Defined in: type/Payment.ts:22

Payment method used by the PSP


orderId

orderId: number

Defined in: type/Payment.ts:16

Unique orderId reference for the Payment


paymentId?

optional paymentId?: string

Defined in: type/Payment.ts:14

Unique paymentId reference for the Payment - provided by the PSP


status

status: PaymentStatuses

Defined in: type/Payment.ts:24

Payment status


transactions?

optional transactions?: Transaction[]

Defined in: type/Payment.ts:26

Transaction(s) related to the specified payment


userId?

optional userId?: number

Defined in: type/Payment.ts:10

Logged in User ID