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.

submittedAsyncboolean

Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:

true: The request is queued and will be executed when the providing service is available in the order in which the requests are received.
false: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.

Changes

Changed in 12 of the 21 revisions of this API.241147

Apr 12, 2023v145a1cea670d3121See the full diff
- ▲
  the exchangeMessages/items/ response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ●
  removed the optional property exchangeMessages/items/messageCode from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property exchangeMessages/items/messageDescription from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property exchangeMessages/items/ExchangeMessage to the response with the 200 status
  response-optional-property-added
Mar 22, 2023v1006529adfbf81111See the full diff
- ▲
  the request's body type/format changed from / to object/
  request-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 200
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 400
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 401
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 403
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 422
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 500
  response-body-type-changed
- ▲
  the response property eventTypes became optional for the status 200
  response-property-became-optional
- ▲
  the response property exchangeMessages became optional for the status 200
  response-property-became-optional
- ▲
  the response property okMessages became optional for the status 200
  response-property-became-optional
- ▲
  the exchangeMessages/items/ response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ●
  added the new FUNDS_MIGRATED enum value to the eventTypes/items/ response property for the response status 200
  response-property-enum-value-added
- ○
  added the new FUNDS_MIGRATED enum value to the request property eventTypes/items/
  request-property-enum-value-added
Oct 6, 2022v10def803273ac11See the full diff
- ●
  added the new ACCOUNT_HOLDER_MIGRATED enum value to the eventTypes/items/ response property for the response status 200
  response-property-enum-value-added
- ○
  added the new ACCOUNT_HOLDER_MIGRATED enum value to the request property eventTypes/items/
  request-property-enum-value-added
Jun 2, 2022v1f0b24ad6104322See the full diff
- ●
  added the new PENDING_CREDIT enum value to the eventTypes/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new SCORE_SIGNAL_TRIGGERED enum value to the eventTypes/items/ response property for the response status 200
  response-property-enum-value-added
- ○
  added the new PENDING_CREDIT enum value to the request property eventTypes/items/
  request-property-enum-value-added
- ○
  added the new SCORE_SIGNAL_TRIGGERED enum value to the request property eventTypes/items/
  request-property-enum-value-added
Aug 7, 2021v1c8ceb47d7b761See the full diff
- ○
  api tag General added
  api-tag-added
Jul 9, 2021v14184946e3e8d2See the full diff
- ○
  the endpoint scheme security ApiKeyAuth was added to the API
  api-security-added
- ○
  the endpoint scheme security BasicAuth was added to the API
  api-security-added
Apr 24, 2021v164ced2e5823411See the full diff
- ●
  added the new TRANSFER_NOT_PAIDOUT_TRANSFERS enum value to the eventTypes/items/ response property for the response status 200
  response-property-enum-value-added
- ○
  added the new TRANSFER_NOT_PAIDOUT_TRANSFERS enum value to the request property eventTypes/items/
  request-property-enum-value-added
Apr 10, 2021v1fa01a51bf28a5See the full diff
- ○
  added the optional property status to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 500 status
  response-optional-property-added
Mar 26, 2021v1988c95b5257a5See the full diff
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 403
  response-non-success-status-added
- ○
  added the non-success response with the status 422
  response-non-success-status-added
- ○
  added the non-success response with the status 500
  response-non-success-status-added
Mar 5, 2021v1f3953c93f7d911See the full diff
- ●
  added the new ACCOUNT_FUNDS_BELOW_THRESHOLD enum value to the eventTypes/items/ response property for the response status 200
  response-property-enum-value-added
- ○
  added the new ACCOUNT_FUNDS_BELOW_THRESHOLD enum value to the request property eventTypes/items/
  request-property-enum-value-added

Full history (12 revisions)