API Reference Synctera v#1.0.0

Copy Markdown View Source

Modules

An unofficial, production-grade Elixir client for the Synctera Banking-as-a-Service API.

Synctera 'ACH' endpoints.

Synctera 'Accounts' endpoints.

Synctera 'Applications' endpoints.

Synctera 'Businesses' endpoints.

Synctera 'Card Transaction Simulations' endpoints.

Synctera 'Card Webhook Simulations' endpoints.

Synctera 'Cards' endpoints.

Holds configuration for talking to the Synctera API. Construct one with new/1 and pass it as the first argument to every Synctera.* resource function, per Elixir convention (cf. Ecto.Repo, Req.Request).

Synctera 'Customers' endpoints.

Synctera expects a Customer-Device-Info header (JSON-encoded) on requests made "on behalf of" an end customer, or for internal batch operations (docs: "Need to Know" -> Customer Device Fingerprinting). customer_id must match the customer/business id referenced elsewhere in the request.

Synctera 'Digital Wallet Tokens' endpoints.

Synctera 'Disclosures' endpoints.

Synctera 'Documents (alpha)' endpoints.

Raised/returned for non-2xx responses from the Synctera API.

Synctera 'External Accounts' endpoints.

Synctera 'External Cards (alpha)' endpoints.

Low-level request executor built on Erlang/OTP's built-in :httpc (part of :inets) — no third-party HTTP client dependency required. Handles auth, idempotency key resolution, device-info headers, retries with backoff, and error mapping.

Synctera has two distinct idempotency behaviors (docs: "Need to Know" -> Idempotency)

Synctera 'Internal Accounts' endpoints.

A small, dependency-free JSON encoder/decoder.

Synctera 'KYC/KYB Verifications' endpoints.

Synctera 'KYC Verification' endpoints.

Synctera 'Monitoring' endpoints.

Cursor-pagination helpers built on Stream.resource/3 for lazy, idiomatic-Elixir iteration over Synctera list endpoints, which return next_page_token and accept it back as page_token.

Synctera 'PaymentSchedules' endpoints.

Synctera 'Persons' endpoints.

Synctera 'Reconciliations' endpoints.

Synctera 'Relationships' endpoints.

Synctera 'Remote Check Deposit (beta)' endpoints.

Retry policy for 429 and 5xx responses — the only statuses Synctera's docs confirm are never served from their idempotency cache, and so are always safe to retry without risking a duplicate side effect.

Synctera 'Sandbox Wipe (alpha)' endpoints.

Synctera 'Statements' endpoints.

Synctera 'Transactions' endpoints.

Raised for client-side programmer errors (e.g. missing a required idempotency key on a ledger endpoint) — it never reaches the network.

Synctera 'Watchlist' endpoints.

Verifies Synctera webhook deliveries, signed with HMAC-SHA256 over "#{timestamp}.#{body}" (docs: Webhooks guide). Supports two signatures during secret rotation and a configurable replay window.

Raised by Synctera.Webhook.verify!/1 when a webhook delivery's signature is missing, malformed, expired, or does not match.

Synctera 'Webhooks' endpoints.

Synctera 'Wires (alpha)' endpoints.