Close a reconciliation finding

curl --request POST \
  --url https://api.example.com/v1/assurance/findings/{findingId}/close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "expectedUpdatedAt": "2023-11-07T05:31:56Z",
  "note": "<string>"
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/assurance/findings/{findingId}/close"

	payload := strings.NewReader("{\n  \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\",\n  \"note\": \"<string>\"\n}")

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({expectedUpdatedAt: '2023-11-07T05:31:56Z', note: '<string>'})
};

fetch('https://api.example.com/v1/assurance/findings/{findingId}/close', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/assurance/findings/{findingId}/close"

payload = {
    "expectedUpdatedAt": "2023-11-07T05:31:56Z",
    "note": "<string>"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "channelId": "spb",
  "detail": "<string>",
  "detectedAt": "2023-11-07T05:31:56Z",
  "engineIds": [
    "<string>"
  ],
  "findingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subjectReference": "<string>",
  "type": "COUNT_DIVERGENCE",
  "updatedAt": "2023-11-07T05:31:56Z",
  "closed": {
    "closedAt": "2023-11-07T05:31:56Z",
    "closedBy": "<string>",
    "note": "<string>"
  }
}

{
  "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>",
  "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>",
  "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>",
  "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"
  }
}

Close a reconciliation finding

An operator who investigated and settled a finding closes it with a mandatory note and the finding’s updatedAt as read. The Courier records who closed it, when and the note; the finding stays in history. A cycle that re-raised the finding after it was read answers 409 JDC-0008: re-read it, so no window is closed unread. A finding already closed answers 200 with its first closure, never overwritten. A later cycle that sees a new divergence opens a new finding. Idempotent per X-Idempotency: the same key with another body is 409 JDC-0003.

POST

assurance

findings

{findingId}

Close a reconciliation finding

curl --request POST \
  --url https://api.example.com/v1/assurance/findings/{findingId}/close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "expectedUpdatedAt": "2023-11-07T05:31:56Z",
  "note": "<string>"
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/assurance/findings/{findingId}/close"

	payload := strings.NewReader("{\n  \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\",\n  \"note\": \"<string>\"\n}")

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({expectedUpdatedAt: '2023-11-07T05:31:56Z', note: '<string>'})
};

fetch('https://api.example.com/v1/assurance/findings/{findingId}/close', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/assurance/findings/{findingId}/close"

payload = {
    "expectedUpdatedAt": "2023-11-07T05:31:56Z",
    "note": "<string>"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "channelId": "spb",
  "detail": "<string>",
  "detectedAt": "2023-11-07T05:31:56Z",
  "engineIds": [
    "<string>"
  ],
  "findingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subjectReference": "<string>",
  "type": "COUNT_DIVERGENCE",
  "updatedAt": "2023-11-07T05:31:56Z",
  "closed": {
    "closedAt": "2023-11-07T05:31:56Z",
    "closedBy": "<string>",
    "note": "<string>"
  }
}

{
  "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>",
  "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>",
  "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>",
  "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"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency

string

requerido

Idempotency key; a retry with the same key and body replays the first answer.

Parámetros de ruta

findingId

string

requerido

The finding, from the reconciliation report's openFindings. Another tenant's finding is a 404.

Cuerpo

application/json

expectedUpdatedAt

string<date-time>

requerido

The finding's updatedAt as read. A cycle that re-raised it since answers 409: re-read it.

note

string

requerido

What the operator checked and settled. 10 to 500 characters after trimming.

Respuesta

channelId

enum<string>

requerido

Opciones disponibles:

spb,

pix

detail

string

requerido

For COUNT_DIVERGENCE, the first line is the first detection and the latest: line the most recent cycle that still saw it.

detectedAt

string<date-time>

requerido

engineIds

string[]

requerido

The engines involved; empty on a divergence.

findingId

string<uuid>

requerido

subjectReference

string

requerido

The send's control identifier for MISSING_RETURN_LEG; reconciliation: for COUNT_DIVERGENCE.

type

enum<string>

requerido

What pages: a cycle whose E = C + T + R did not hold, or a send with no captured return leg.

Opciones disponibles:

COUNT_DIVERGENCE,

MISSING_RETURN_LEG

updatedAt

string<date-time>

requerido

Moves each time a cycle re-raises the finding. Send it back as expectedUpdatedAt to close.

closed

object

The operator's close; absent while the finding is open and pages.

Show child attributes

Motores

Mapa de titularidad

API de los motores

Canales

Mensajes

Registro de envíos

Conciliación

Manejo de errores

Close a reconciliation finding

Autorizaciones

Encabezados

Parámetros de ruta

Cuerpo

Respuesta