Add an event to a subscription

post

https://www.bankingcircleconnect.com/api/v1/notificationselfservice/subscriptionEvent

Body Params

subscriptionId

uuid

required

Id of subscription to attach event to

targetIds

array of uuids | null

Account id, company id, or company group id

targetIds

eventType

string

enum

required

The type of event that will trigger the subscription.

1 = IncomingPaymentProcessed 2 = OutgoingPaymentRejected 3 = OutgoingPaymentProcessed 4 = MissingFunding 5 = Reversed 6 = OutgoingPaymentBooked 7 = PaymentRouting 8 = IncomingPaymentBooked 9 = AccountHolderVerification 10 = OutgoingDirectDebitPendingProcessing 11 = CaseEvents 12 = AgencyBankingWhitelistResult

targetType

int32

enum

required

Type of target

0 = Account 1 = Company 2 = CompanyGroup

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

500

Internal Server Error. Something unexpected happened on BC Connect side.

Language

Credentials

Bearer

Loading…

Response

Choose an example:

text/plain

application/json

text/json

200OK

400Bad request. Request is not correctly formulated or validation of input failed. Check the error description.

401Unauthorized. The server understood the request, but access is not allowed, i.e. calling user does not have access.