v21

latestOpenAPI 3.1.0raw.githubusercontent.com2024-03-2161661.1 KB

General

Test a notification configuration

Tests an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.

post/testNotificationConfiguration

Request body

eventTypesstring[]

The event types to test. If left blank, then all of the configured event types will be tested.

Permitted values: ACCOUNT_HOLDER_CREATED, ACCOUNT_CREATED, ACCOUNT_UPDATED, ACCOUNT_HOLDER_UPDATED, ACCOUNT_HOLDER_STATUS_CHANGE, ACCOUNT_HOLDER_STORE_STATUS_CHANGE ACCOUNT_HOLDER_VERIFICATION, ACCOUNT_HOLDER_LIMIT_REACHED, ACCOUNT_HOLDER_PAYOUT, PAYMENT_FAILURE, SCHEDULED_REFUNDS, REPORT_AVAILABLE, TRANSFER_FUNDS, BENEFICIARY_SETUP, COMPENSATE_NEGATIVE_BALANCE.

notificationIdinteger required

The ID of the notification subscription configuration to be tested.

Response

OK - the request has succeeded.

errorMessagesstring[]

Any error messages encountered.

eventTypesstring[]

The event types that were tested.

Permitted values: ACCOUNT_HOLDER_CREATED, ACCOUNT_CREATED, ACCOUNT_UPDATED, ACCOUNT_HOLDER_UPDATED, ACCOUNT_HOLDER_STATUS_CHANGE, ACCOUNT_HOLDER_STORE_STATUS_CHANGE ACCOUNT_HOLDER_VERIFICATION, ACCOUNT_HOLDER_LIMIT_REACHED, ACCOUNT_HOLDER_PAYOUT, PAYMENT_FAILURE, SCHEDULED_REFUNDS, REPORT_AVAILABLE, TRANSFER_FUNDS, BENEFICIARY_SETUP, COMPENSATE_NEGATIVE_BALANCE.

notificationIdinteger required

The ID of the notification subscription configuration.

okMessagesstring[]

A list of messages describing the testing steps.

pspReferencestring

The reference of a request. Can be used to uniquely identify the request.

resultCodestring

The result code.