Sign in

v1

latestOpenAPI 3.1.02026-07-2496304466.3 KB
Money + Positions

Get Balance Sweep

get/accounts/{account_id}/sweeps/{sweep_id}

Path parameters

sweep_idstring required
account_idstring required

Headers

LMG-Data-Privacy-Access-Principalstring required
LMG-Data-Privacy-Access-Justificationstring required

Response

Successful Response

idstring required

A unique value identifying this sweep.

status'canceled' | 'created' | 'processed' | 'rejected' | 'started' required

A category describing the status of a balance sweep:

<ul> <li><code>canceled</code> <li><code>created</code> <li><code>processed</code> <li><code>rejected</code> <li><code>started</code> </ul>
amountstring required

The amount of money to be withdrawn during the balance sweep.

currencystring required

An ISO 4217 three-letter currency code. Its value represents the currency for the amount listed here. The only currently available currency is "EUR".

Example response

{
  "history": [
    {
      "timestamp": "2023-06-23T07:29:55.465000+00:00"
    }
  ]
}