Skip to main content
POST
/
v1
/
transfers
/
ted-in
/
poll
Trigger TED IN Poller
curl --request POST \
  --url https://plugin-br-bank-transfer.sandbox.lerian.net/v1/transfers/ted-in/poll \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Idempotency: <x-idempotency>'
{
  "outcome": "success",
  "processed": 3
}

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. The tenantId is derived from the bearer token or authenticated request context and is not supplied through X-Organization-Id.

Headers

X-Idempotency
string
required

Required idempotency key for safe retries. Use a UUID v4 or unique business identifier. If the same key is sent again and the original request was already processed, the cached response is returned.

See Retries and idempotency for details.

Maximum string length: 255

Response

Indicates that the poll cycle completed. The outcome field reports the cycle result: success, empty, skipped_outside_window, skipped_busy, cancelled, or error.

outcome
enum<string>
required

Cycle outcome label. success and empty are terminal happy paths; skipped_* indicates the cycle did not run; cancelled and error indicate aborted work.

Available options:
success,
empty,
skipped_outside_window,
skipped_busy,
cancelled,
error
Example:

"success"

processed
integer
required

Number of inbound messages drained and processed during this cycle.

Required range: x >= 0
Example:

3