Configuration webhooks v1 - Sweep deleted

Notification parameters

Required Optional

data object Required

Contains event details.

Show children

accountId string

The unique identifier of the balance account for which the sweep was configured.

balancePlatform string

The unique identifier of the balance platform.

sweep object

Contains information about the sweep resource that triggered the event.

Show children

counterparty object Required

The destination or the source of the funds, depending on the type.

Either a balanceAccountId, transferInstrumentId, or merchantAccount is required.

Show children

currency string Required

The three-character ISO currency code in uppercase. For example, EUR.

The sweep currency must match any of the balances currencies.

description string

The message that will be used in the sweep transfer's description body with a maximum length of 140 characters.

If the message is longer after replacing placeholders, the message will be cut off at 140 characters.

id string Required

The unique identifier of the sweep.

reason string

The reason for disabling the sweep.

schedule Required

The schedule when the triggerAmount is evaluated. If the balance meets the threshold, funds are pushed out of or pulled in to the balance account.

status string

The status of the sweep. If not provided, by default, this is set to active.

Possible values:

active: the sweep is enabled and funds will be pulled in or pushed out based on the defined configuration.
inactive: the sweep is disabled and cannot be triggered.

sweepAmount object

The amount that must be pushed out or pulled in. You can configure either sweepAmount or targetAmount, not both.

Show children

targetAmount object

The amount that must be available in the balance account after the sweep. You can configure either sweepAmount or targetAmount, not both.

Show children

triggerAmount object

The threshold amount that triggers the sweep. If not provided, by default, the amount is set to zero. The triggerAmount is evaluated according to the specified schedule.type.

For type pull, if the balance is less than or equal to the triggerAmount, funds are pulled in to the balance account.
For type push, if the balance is more than or equal to the triggerAmount, funds are pushed out of the balance account.

Show children

type string

The direction of sweep, whether pushing out or pulling in funds to the balance account. If not provided, by default, this is set to push.

Possible values:

push: push out funds to a destination balance account or transfer instrument.
pull: pull in funds from a source merchant account, transfer instrument, or balance account.

environment string Required

The environment from which the webhook originated.

Possible values: test, live.

type string Required

Type of notification.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK

The request has succeeded.
Show more Show less
notificationResponse string

Respond with HTTP 200 OK and [accepted] in the response body to accept the webhook.

Sweep deleted

Endpoint destination URL

Notification parameters

Response parameters

HTTP Responses

200 - OK