Preview the direct order purge (dry run)

curl --request POST \
  --url https://api.example.com/v1/admin/direct/purge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dryRun": true,
  "limit": 100,
  "reason": "retention-purge",
  "ticket": "PURGE-2026-10"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/admin/direct/purge"

	payload := strings.NewReader("{\n  \"dryRun\": true,\n  \"limit\": 100,\n  \"reason\": \"retention-purge\",\n  \"ticket\": \"PURGE-2026-10\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({dryRun: true, limit: 100, reason: 'retention-purge', ticket: 'PURGE-2026-10'})
};

fetch('https://api.example.com/v1/admin/direct/purge', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/admin/direct/purge"

payload = {
    "dryRun": True,
    "limit": 100,
    "reason": "retention-purge",
    "ticket": "PURGE-2026-10"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "asOf": "2023-11-07T05:31:56Z",
  "dryRun": true,
  "orderIds": [
    "<string>"
  ],
  "truncated": true
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Preview the direct order purge (dry run)

Lists up to limit (at most 100) direct orders eligible for erasure as of now, in the institutions this executor owns, oldest eligibility first; the same predicate as the purge-eligible gauge, the money rule and the parent rule of the erase. A permanent block’s permanentUntil lives only in its sealed body, so the erase may still refuse a listed permanent order (SBJ-0057). The preview is a dry run only: nothing is erased, and each erase is a separate POST …/orders//erase. A human platform-administrator action (direct_order_erasure:purge_preview): 403 SBJ-0044/SBJ-0045 for M2M or tenant-carrying tokens. 422 SBJ-0058: dryRun not true, limit out of range, reason or ticket invalid. 422 SBJ-0059: multi-tenant deployment.

POST

admin

direct

purge

Preview the direct order purge (dry run)

curl --request POST \
  --url https://api.example.com/v1/admin/direct/purge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dryRun": true,
  "limit": 100,
  "reason": "retention-purge",
  "ticket": "PURGE-2026-10"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/admin/direct/purge"

	payload := strings.NewReader("{\n  \"dryRun\": true,\n  \"limit\": 100,\n  \"reason\": \"retention-purge\",\n  \"ticket\": \"PURGE-2026-10\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({dryRun: true, limit: 100, reason: 'retention-purge', ticket: 'PURGE-2026-10'})
};

fetch('https://api.example.com/v1/admin/direct/purge', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/admin/direct/purge"

payload = {
    "dryRun": True,
    "limit": 100,
    "reason": "retention-purge",
    "ticket": "PURGE-2026-10"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "asOf": "2023-11-07T05:31:56Z",
  "dryRun": true,
  "orderIds": [
    "<string>"
  ],
  "truncated": true
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Corpo

application/json

dryRun

boolean

Must be true: the preview only lists the eligible orders; each erase is a separate request.

Exemplo:

true

limit

integer<int64>

Most orders listed, 1 to 100; 0 or absent lists up to 100.

Exemplo:

100

reason

string

Required: retention-purge or lgpd-subject-request.

Exemplo:

"retention-purge"

ticket

string

Required: the request id (at most 64 characters, no personal data).

Exemplo:

"PURGE-2026-10"

Resposta

asOf

string<date-time>

obrigatório

Instant the eligibility was read (UTC).

dryRun

boolean

obrigatório

Always true: nothing was erased.

orderIds

string[] | null

obrigatório

Direct orders eligible for erasure as of asOf, oldest eligibility first.

truncated

boolean

obrigatório

True when the listing stopped at its read bound before it found limit orders or ran out of candidates: more eligible orders may exist. Each listed order is one the erase would accept (eligibility and the money rule).

Instituições e conector Midaz

Canal direto

Administração do canal direto

Ordens que precisam de atenção

Roteamento de ledger

Segurança

Auditoria

Tratamento de erros

Preview the direct order purge (dry run)

Autorizações

Corpo

Resposta