Set Conta-PI auto-transfer configuration

Prerequisite: the rail must be ready before a submit — an active certificate (see rotateCertificate, activateCertificate), a READY readiness report (see getReadiness), and a passing connectivity test (see createConnectivityTest). Declares the STR’s automatic-transfer policy per account class (the platform emits wire code LPI0005): for EACH class (RB/CL and CCME) set exactly ONE of — a value of ‘0’/‘0.00’ disables auto-transfer for that class. ‘Last message wins’: a new config fully replaces the prior one. Persists the last-sent config frame and returns the derived wire code, the submit status, and the NUOp. This means dispatch was accepted, not BACEN confirmation; the STR acknowledges asynchronously (LPI0005R1) and later reports each automatic transfer it performs (LPI0006). Lerian SPB forwards the config values verbatim; it performs NO arithmetic. Idempotent — replaying the same X-Idempotency key with the same parsed request (member order and whitespace do not count; any other difference, such as number spelling, null for an absent field, or an unknown member, is another request) returns the cached response.

POST /v1/str/operations/auto-transfer-config

Set Conta-PI auto-transfer configuration

cURL

curl --request POST \
  --url https://api.example.com/v1/str/operations/auto-transfer-config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "ccmePercent": "25",
  "ccmeValue": "300.00",
  "rbClPercent": "50",
  "rbClValue": "1500.25"
}
'

202

{
  "correlationId": "req-7a3f9c2e",
  "status": "SUBMITTED",
  "wireCode": "LPI0005",
  "nuOp": "12345678202606190000005"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency · string · requerido

Idempotency key. Required on every mutation.

X-TTL · string

Seconds the cached response is kept; it may only shorten IDEMPOTENCY_DEFAULT_TTL_SEC. The key itself lives with the message.

Cuerpo

application/json

ccmePercent · string

CCME class: percentage of the CCME balance to auto-transfer, a decimal of up to 3 integer and 2 fractional digits (e.g. 40.5). Set exactly one of ccmePercent or ccmeValue. '0' disables auto-transfer for this class.

Ejemplo:

"25"

ccmeValue · string

CCME class: fixed amount in reais to auto-transfer, a decimal of up to 17 integer and 2 fractional digits. Set exactly one of ccmePercent or ccmeValue. '0.00' disables auto-transfer for this class.

Ejemplo:

"300.00"

rbClPercent · string

RB/CL class: percentage of the reserve/settlement balance to auto-transfer, a decimal of up to 3 integer and 2 fractional digits (e.g. 40.5). Set exactly one of rbClPercent or rbClValue. '0' disables auto-transfer for this class.

Ejemplo:

"50"

rbClValue · string

RB/CL class: fixed amount in reais to auto-transfer, a decimal of up to 17 integer and 2 fractional digits. Set exactly one of rbClPercent or rbClValue. '0.00' disables auto-transfer for this class.

Ejemplo:

"1500.25"

Respuesta

202

application/json

Accepted

correlationId · string · requerido

Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace.

Ejemplo:

"req-7a3f9c2e"

status · string · requerido

Submit status: dispatch was accepted (the STR ACK arrives asynchronously as LPI0005R1).

Ejemplo:

"SUBMITTED"

wireCode · enum<string> · requerido

LPI wire code of the auto-transfer config-set (always LPI0005).

Opciones disponibles: LPI0005

Ejemplo:

"LPI0005"

nuOp · string

SFN operation number stamped on the transmitted LPI0005 frame; the LPI0005R1 ACK correlates back to it.

Pattern: ^[0-9A-Z]{8}[0-9]{15}$

Ejemplo:

"12345678202606190000005"