Get a reconciliation

GET /api/reconciliation/reconciliations/{reconciliationID}

Try it

Get a reconciliation

cURL

curl --request GET \
  --url http://localhost/api/reconciliation/reconciliations/{reconciliationID} \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "id": "XXX",
    "policyID": "XXX",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "reconciledAtLedger": "2021-01-01T00:00:00.000Z",
    "reconciledAtPayments": "2021-01-01T00:00:00.000Z",
    "status": "COMPLETED",
    "paymentsBalances": {},
    "ledgerBalances": {},
    "driftBalances": {},
    "error": "<string>"
  }
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

reconciliationID · string · required

The reconciliation ID.

Response

200

application/json

OK

data · object · required

Show child attributes

data. id · string · required

Example:

"XXX"

data. policyID · string · required

Example:

"XXX"

data. createdAt · string<date-time> · required

Example:

"2021-01-01T00:00:00.000Z"

data. reconciledAtLedger · string<date-time> · required

Example:

"2021-01-01T00:00:00.000Z"

data. reconciledAtPayments · string<date-time> · required

Example:

"2021-01-01T00:00:00.000Z"

data. status · string · required

Example:

"COMPLETED"

data. paymentsBalances · object · required

Show child attributes

data.paymentsBalances. {key} · integer<bigint>

data. ledgerBalances · object · required

Show child attributes

data.ledgerBalances. {key} · integer<bigint>

data. driftBalances · object · required

Show child attributes

data.driftBalances. {key} · integer<bigint>

data. error · string