Skip to main content
POST
Create a reconciliation source

Authorizations

Authorization
string
header
required

Bearer token authentication (format: "Bearer {token}")

Headers

X-Request-Id
string

A unique identifier for tracing the request across services.

X-Idempotency-Key
string

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

Path Parameters

contextId
string
required

The unique identifier of the reconciliation context.

Body

application/json

Source creation payload

name
string
required
Required string length: 1 - 50
Example:

"Primary Bank Account"

type
enum<string>
required

Category of data source for reconciliation

Available options:
LEDGER,
BANK,
GATEWAY,
CUSTOM,
FETCHER
Example:

"BANK"

side
enum<string>
required

Side of the reconciliation this source feeds

Available options:
LEFT,
RIGHT
Example:

"LEFT"

config
object

Response

Successfully created source.

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

id
string
contextId
string
name
string
type
enum<string>

Category of data source for reconciliation

Available options:
LEDGER,
BANK,
GATEWAY,
CUSTOM,
FETCHER
side
enum<string>

Side of the reconciliation this source feeds

Available options:
LEFT,
RIGHT
config
object
createdAt
string
updatedAt
string
archivedAt
string<date-time>

RFC 3339 timestamp when the source was archived; absent when the source is live