Pular para o conteúdo principal
POST
Criar uma fonte de conciliação

Autorizações

Authorization
string
header
obrigatório

Autenticação por Bearer token (formato: "Bearer {token}")

Cabeçalhos

X-Request-Id
string

A unique identifier for tracing the request across services.

X-Idempotency-Key
string

Chave de idempotência opcional para novas tentativas seguras. Também aceita Idempotency-Key como nome alternativo do cabeçalho. Se a mesma chave for enviada novamente e a requisição original já tiver sido processada, a resposta em cache é retornada com X-Idempotency-Replayed: true.

Consulte Novas tentativas e idempotência para mais detalhes.

Parâmetros de caminho

contextId
string
obrigatório

The unique identifier of the reconciliation context.

Corpo

application/json

Payload de criação da fonte

name
string
obrigatório
Required string length: 1 - 50
Exemplo:

"Primary Bank Account"

type
enum<string>
obrigatório

Categoria de fonte de dados para conciliação

Opções disponíveis:
LEDGER,
BANK,
GATEWAY,
CUSTOM,
FETCHER
Exemplo:

"BANK"

side
enum<string>
obrigatório

Lado da conciliação que esta fonte alimenta

Opções disponíveis:
LEFT,
RIGHT
Exemplo:

"LEFT"

config
object

Resposta

Fonte criada com sucesso.

A resposta inclui o cabeçalho X-Idempotency-Replayed.

Se o valor for false, a requisição acabou de ser processada. Se o valor for true, a resposta é uma reprodução de uma requisição processada anteriormente.

Consulte Retentativas e idempotência para mais detalhes.

id
string
contextId
string
name
string
type
enum<string>

Categoria de fonte de dados para conciliação

Opções disponíveis:
LEDGER,
BANK,
GATEWAY,
CUSTOM,
FETCHER
side
enum<string>

Lado da conciliação que esta fonte alimenta

Opções disponíveis:
LEFT,
RIGHT
config
object
createdAt
string
updatedAt
string