TestCompanyWebhookRequest class abstract

TestCompanyWebhookRequest

Properties:

  • merchantIds - List of merchantId values for which test webhooks will be sent. The list can have a maximum of 20 merchantId values. If not specified, we send sample notifications to all the merchant accounts that the webhook is configured for. If this is more than 20 merchant accounts, use this list to specify a subset of the merchant accounts for which to send test notifications.
  • notification - Custom test notification object. Required when the types list contains CUSTOM.
  • types - List of event codes for which to send test notifications. Only the webhook types below are supported. Possible values if webhook type: standard: * AUTHORISATION * CHARGEBACK_REVERSED * ORDER_CLOSED * ORDER_OPENED * PAIDOUT_REVERSED * PAYOUT_THIRDPARTY * REFUNDED_REVERSED * REFUND_WITH_DATA * REPORT_AVAILABLE * CUSTOM - set your custom notification fields in the notification object. Possible values if webhook type: banktransfer-notification: * PENDING Possible values if webhook type: report-notification: * REPORT_AVAILABLE Possible values if webhook type: ideal-notification: * AUTHORISATION Possible values if webhook type: pending-notification: * PENDING
Annotations
  • @BuiltValue.new()

Constructors

TestCompanyWebhookRequest([void updates(TestCompanyWebhookRequestBuilder b)])
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
merchantIds → BuiltList<String>?
List of merchantId values for which test webhooks will be sent. The list can have a maximum of 20 merchantId values. If not specified, we send sample notifications to all the merchant accounts that the webhook is configured for. If this is more than 20 merchant accounts, use this list to specify a subset of the merchant accounts for which to send test notifications.
no setter
notification → CustomNotification?
Custom test notification object. Required when the types list contains CUSTOM.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
types → BuiltList<String>?
List of event codes for which to send test notifications. Only the webhook types below are supported. Possible values if webhook type: standard: * AUTHORISATION * CHARGEBACK_REVERSED * ORDER_CLOSED * ORDER_OPENED * PAIDOUT_REVERSED * PAYOUT_THIRDPARTY * REFUNDED_REVERSED * REFUND_WITH_DATA * REPORT_AVAILABLE * CUSTOM - set your custom notification fields in the notification object. Possible values if webhook type: banktransfer-notification: * PENDING Possible values if webhook type: report-notification: * REPORT_AVAILABLE Possible values if webhook type: ideal-notification: * AUTHORISATION Possible values if webhook type: pending-notification: * PENDING
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(TestCompanyWebhookRequestBuilder)) → TestCompanyWebhookRequest
Rebuilds the instance.
inherited
toBuilder() → TestCompanyWebhookRequestBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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

Static Properties

serializer → Serializer<TestCompanyWebhookRequest>
no setter