Skip to main content
​
v1.1.0
PaymentsChains
Payment lifecycle, Polygon, and richer amount data
Version 1.1.0 completes the payment-request lifecycle — settle, reverse, and adjust — adds Polygon as a supported chain, and returns each amount with its crypto equivalent.New endpoints — payment lifecycle
  • Settle a payment request — POST /payment-requests/{paymentRequestId}/settlements. Moves reserved funds from escrow to the company’s settlement wallet; the settlement amount can equal, fall below, or exceed the authorized amount. Reference
  • Settle by card-provider reference — POST /payment-requests/settlements. Settles a request located by its cardProviderReference and externalId. Reference
  • Reverse a payment request — POST /payment-requests/{paymentRequestId}/reversal. Returns the full reserved amount to the account wallet. Reference
  • Reverse by card-provider reference — POST /payment-requests/reversals. Reverses a request located by its cardProviderReference and externalId. Reference
  • Update a payment request — PATCH /payment-requests/{paymentRequestId}. Sets a new authorized amount; a lower amount releases the difference from escrow, a higher amount reserves more. Reference
New supported chainAmounts now carry fiat and crypto
  • Payment-request amount fields return an object with both sides of the conversion — { "fiat": <number>, "crypto": "<string>" } — across amount, originalAmount, settlementAmount, settledAmount, and shortfallAmount. Update any client that reads these fields to expect the nested object. See Payment requests.
New payment-request fields
  • settlementAmount, settledAmount, shortfallAmount, settledAt, reversalReason, reversalDescription, and reversedAt are now returned, capturing the settlement and reversal lifecycle.
New statuses and execution types
  • Statuses added: SETTLING, SETTLED_WITH_SHORTFALL, REVERSING.
  • Execution types added: SETTLEMENT, SETTLEMENT_OVERAGE, REFUND, REVERSAL, INCREMENTAL_AUTHORIZATION, AUTHORIZATION_ADJUSTMENT.
Non-custodial accounts
  • Self-custody tenants can register an end-customer’s own wallet by passing address when creating an account. See Managed vs. self-custody.
Improvements
  • Idempotency keys now apply across the full payment lifecycle — create, settle, reverse, and update. Retrying with the same key and body returns the original result. See Idempotency.
  • Account-to-account crypto transfers are now supported for Venly-managed accounts.