# Sweeping status update

Notification that the sweeping status has been updated.

Sweeping represents transactions that return money to the source account. It may be triggered by unmatched incoming transaction or by failed payment run payments.

Endpoint: POST sweepingWatch
Version: v1
Security: 

## Header parameters:

  - `call-ref` (string)
    A call reference generated by the caller and unique to the caller
to provide correlation between the caller and system with a maximum length
of 255

  - `published-timestamp` (integer, required)
    The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.

  - `signature` (string, required)
    The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the published-timestamp using your API key.

  - `signature-v2` (string, required)
    The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the call-ref header, the request body, and the published-timestamp header, all concatenated without spaces, and signed using your API key.

## Request fields (application/json):

  - `type` (string, required)
    Enum: "sweepingWatch"

  - `payload` (object, required)

  - `payload.buyerId` (string, required)
    Buyer id.

  - `payload.sweepingId` (string, required)
    Sweeping id.
    Example: "654cea294f19c7598987cc84"

  - `payload.reference` (string)
    Sweeping transaction reference.

  - `payload.transactionDate` (string, required)
    Date for when sweeping transaction happened
    Example: "2023-09-23T11:34:45Z00"

  - `payload.transactionAmount` (object, required)
    Sweeping transaction amount

  - `payload.transactionAmount.currency` (string, required)
    The currency expressed in ISO-4217 code.
    Enum: "GBP", "EUR"

  - `payload.transactionAmount.amount` (integer, required)
    The monetary amount, scaled to the lowest denomination of the currency.

Example, an amount of 1000 for a GBP currency is actually 1000 pennies or GBP 10.00.
    Example: 454321

  - `payload.status` (string, required)
    The status of the sweeping transaction, as follows:

- SUBMITTED: Sweeping has been initiated.
- REJECTED: Sweeping submitted was rejected.
- APPROVED: Sweeping submission was approved.
- FAILED: There was an issue with the sweeping, and the transaction has failed.
- COMPLETED: The requested funds have been sent.
- RETURNED: Sweeping has been returned to the sender
    Enum: "SUBMITTED", "REJECTED", "APPROVED", "FAILED", "COMPLETED", "RETURNED"

  - `payload.destination` (object, required)
    Sweeping destination bank account details

  - `payload.destination.linkedAccountId` (string, required)
    The unique identifier of the linked account
    Example: "652d25b73541d8084a88a38d"

  - `payload.destination.bankAccountDetails` (any, required)
    Details of the destination bank account, depending on the type of linked account.


## Response 200 fields