Create REST discovery connection

Use this endpoint to create a REST connection to a payment provider: PagBank, Stripe, or Pix BCB. The credential fields each connector type requires are listed as requiredFields on GET /v1/discovery/connector-types. An optional baseURL replaces the default provider address for this connection. After you create it, the connection appears in GET /v1/discovery/connections; an update to a REST connection accepts only configName.

POST /v1/discovery/rest-connections

Create REST discovery connection

cURL

curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/discovery/rest-connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "configName": "pagbank-prod",
  "connectorType": "PAGBANK",
  "apiKey": "<string>",
  "baseURL": "https://sandbox.provider.example",
  "clientCert": "<string>",
  "clientID": "<string>",
  "clientKey": "<string>",
  "clientSecret": "<string>",
  "ediToken": "<string>",
  "establishmentID": "<string>"
}
'

201

Example

{
  "configName": "prod-ledger-db",
  "databaseName": "ledger",
  "databaseType": "POSTGRESQL",
  "host": "db.internal.example.com",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "lastSeenAt": "2026-06-17T14:32:05Z",
  "port": 5432,
  "schemaDiscovered": true,
  "status": "available",
  "userName": "matcher_ro",
  "baseURL": "https://sandbox.provider.example",
  "schema": "public"
}

Autorizaciones

Authorization · string · header · requerido

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

Cuerpo

application/json

configName · string · requerido

Unique connection config name (tenant-scoped)

Required string length: 1 - 255

Ejemplo:

"pagbank-prod"

connectorType · enum<string> · requerido

REST connector type this connection serves

Opciones disponibles: PAGBANK, STRIPE, PIX_BCB

Minimum string length: 1

Ejemplo:

"PAGBANK"

apiKey · string

Stripe restricted API key

Maximum string length: 512

baseURL · string<uri>

Optional per-connection API base URL (http/https); when omitted the deployment default for the connector type is used

Maximum string length: 2048

Ejemplo:

"https://sandbox.provider.example"

clientCert · string

PEM-encoded Pix client certificate

Maximum string length: 8192

clientID · string

Pix OAuth2 client id

Maximum string length: 512

clientKey · string

PEM-encoded Pix client private key

Maximum string length: 8192

clientSecret · string

Pix OAuth2 client secret

Maximum string length: 512

ediToken · string

PagBank EDI token

Maximum string length: 512

establishmentID · string

PagBank establishment id

Maximum string length: 512

Respuesta

201

application/json

Created

configName · string · requerido

Connection configuration name

Ejemplo:

"prod-ledger-db"

databaseName · string · requerido

Database name

Ejemplo:

"ledger"

databaseType · string · requerido

Database engine type (canonical engine token as stored)

Ejemplo:

"POSTGRESQL"

host · string · requerido

Database host; empty for REST connector connections, whose service address is reported as baseURL

Ejemplo:

"db.internal.example.com"

id · string · requerido

Internal Matcher connection identifier

Ejemplo:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

lastSeenAt · string<date-time> · requerido

Timestamp the connection was last observed healthy (RFC 3339)

Ejemplo:

"2026-06-17T14:32:05Z"

port · integer<int64> · requerido

Database port

Ejemplo:

5432

schemaDiscovered · boolean · requerido

Whether table schemas have been discovered for this connection

status · string · requerido

Current lifecycle status of the connection as reported by the extraction engine

Ejemplo:

"available"

userName · string · requerido

Database user name the connection authenticates as

Ejemplo:

"matcher_ro"

baseURL · string<uri>

Per-connection API base URL of a REST connector connection; absent when the deployment default applies and for database connectors

Ejemplo:

"https://sandbox.provider.example"

schema · string

Schema/namespace within the database, when set

Ejemplo:

"public"