CreateQrCodePayload class

the model for 'Create a QR Code' API to see: https://developer.paypay.ne.jp/products/docs/webpayment

Annotations
  • @freezed

Constructors

CreateQrCodePayload({required String merchantPaymentId, required Amount amount, @Default.new('ORDER_QR') String codeType, String? orderDescription, List<OrderItem>? orderItems, Map<String, dynamic>? metadata, String? storeInfo, String? storeId, String? productType, String? terminalId, int? requestedAt, bool? isAuthorization, int? authorizationExpiry, String? redirectUrl, String? redirectType, String? userAgent})
factory
CreateQrCodePayload.fromJson(Map<String, dynamic> json)
factory

Properties

amount → Amount
Required Amount the user has to Pay
no setterinherited
authorizationExpiry → int?
Epoch timestamp in seconds. The expiry duration must be less than the expiry granted to the merchant.
no setterinherited
codeType → String
Required Please pass the fixed value 'ORDER_QR'
no setterinherited
copyWith → $CreateQrCodePayloadCopyWith<CreateQrCodePayload>
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isAuthorization → bool?
By default it will be false, please set true if the amount will be captured later (preauth and capture payment)
no setterinherited
merchantPaymentId → String
Required The unique payment transaction id provided by merchant string <= 64 characters
no setterinherited
metadata → Map<String, dynamic>?
Extra information the merchant wants to add
no setterinherited
orderDescription → String?
Description of the Order, to see the link to check how it will show up https://www.paypay.ne.jp/opa/doc/jp/v1.0/files/OPA%20PayPay%E3%82%A2%E3%83%97%E3%83%AA%E3%81%A7%E3%81%AE%E8%A1%A8%E7%A4%BA.pdf#page=4 string <= 255 characters
no setterinherited
orderItems → List<OrderItem>?
The user agent of the web browser from where transaction is originating
no setterinherited
productType → String?
The product type in PayPay system. Generally, this request parameter is optional.
no setterinherited
redirectType → String?
This can either be 'WEB_LINK' if the payment is happening on web browser or 'APP_DEEP_LINK' if the payment is happening on your app
no setterinherited
redirectUrl → String?
The url of the page/app to open after the payment is complete, this can be a Web URL or a Deep link to your app
no setterinherited
requestedAt → int?
Request timestamp(Unix epoch but not Unix millisecond epoch)
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
storeId → String?
Id to identify store under merchant string <= 255 characters
no setterinherited
storeInfo → String?
Store info for the merchant string <= 255 characters
no setterinherited
terminalId → String?
Id to identify terminal device under store string <= 255 characters
no setterinherited
userAgent → String?
The user agent of the web browser from where transaction is originating
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited