Changelog
Back to All
Improved

Documentation accuracy pass for v2026-04-14

23 days ago by ReadMe API

What's new — Sweep of doc corrections to align the published reference with actual API behavior. No API behavior changed; only the documentation. Highlights:

Reference / Errors

  • The Error Handling guide is now reachable from navigation.
  • Error reference now lists 403 Forbidden, 422 Unprocessable Entity, and 503 Service Unavailable.
  • Idempotency-key reuse correctly documented as 409 Conflict with idempotency_key_reused (the previously-listed 400 validation_error for VA creation was doc drift).
  • POST /v1/liquidation-address added to the list of endpoints that require idempotency-key.

Users & Status enums

  • User status enum documented in full: CREATED, VERIFYING, VERIFIED, REJECTED, REVIEW, plus the legacy ACTIVE, INACTIVE, SUSPENDED values still emitted for older records.
  • Product comparison table splits Virtual Accounts into Portage and ACT columns rather than collapsing both into one.

Recipients

  • Field tables added for previously-undocumented account types: INSTANT_PAY (FedNow / RTP), USD, CRC, GTQ, PAUSD, PYG, SVUSD.
  • WALLET network combinations table now lists the COPm token on Polygon.

PayIns

  • Status table corrected: CREATED, PENDING, PROCESSING, COMPLETED, FAILED, REFUNDED (previously listed invented values).
  • Webhook events corrected: only payin.created, payin.pending, payin.processing, payin.completed, payin.failed, payin.refunded are emitted.
  • SPEI response account_details fields named explicitly: clabe, bank_name, beneficiary_name.
  • idempotency-key (UUID) header documented as required on POST /v1/payins.

Quotations

  • USDT supported networks corrected to tron, polygon (Solana not supported for USDT).

Payment Link

  • link_type request field corrected from previous link-type (kebab-case) typo in Use Cases examples.

New guide

  • API Versioning page added under Getting Started, explaining the X-Api-Version header model — two versions today (2025-01-01 default for existing clients, 2026-04-14 "latest"), the schema deltas between them, and how to pin requests.

Misc

  • Several response examples updated to match the actual wire format (string-encoded fee fields rather than numeric; permanent inbound address shapes).
  • Typos: Embebed → Embedded; EEUU → USA.

Impact — None for callers; documentation now matches what the API has been doing.