Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Payment

Defines a payment on bunq.

Hierarchy

Index

Properties

amount

amount: number

Payment amount.

Optional currency

currency: string

Payment currency, default is EUR.

date

date: Date

Date and time of payment.

description

description: string

Payment description, only valid ASCII characters.

Optional draft

draft: boolean

Set to true to make a draft payment (request) instead of regular (automatic).

Optional error

error: string

Error string if any, if successful this should be null.

Optional fromAlias

fromAlias: number | string

The source account alias can be an email or phone.

Optional hash

hash: string

The hash generated based on reference or payment data.

id

id: number

ID of the payment.

Optional notes

notes: string | string[]

Extra notes to be added to the payment.

Optional reference

reference: string

A unique reference to the payment, to avoid duplicates.

Optional requestPayerEmail

requestPayerEmail: boolean

Optional requestPayerName

requestPayerName: boolean

Optional requestPayerPhone

requestPayerPhone: boolean

Optional requestShipping

requestShipping: boolean

Optional reverseId

reverseId: number

If payment was reversed, the reverse payment ID is set here.

Optional shippingType

shippingType: string

toAlias

toAlias: number | string

Target account alias can be an email, phone or IBAN.

Optional toName

toName: string

Mandatory counterparty name when paying to a IBAN.

Generated using TypeDoc