Instant settlement

Create an instant settlement request

Creates an instant settlement request over the selected transactions. The request is created in PENDING status and is then reviewed by Kashier: approval moves it to PROCESSING and deducts the early-payout amount from your balance, and the payout itself moves it to TRANSFERRED. A request that will not be processed becomes DECLINED with a declineReason.

Every transaction is re-validated against the eligibility rules at creation time, and the request is rejected whole if any of them is no longer eligible — no partial request is created. Your per-request and daily caps are enforced here as well.

Requires the instant_settlement_request feature flag and the instant_settlements.all.create_instant_settlement permission.

post/v3/payment/instant-settlements/instant-requests

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v3/payment/instant-settlements/instant-requests
  • Auth: API key in header Authorization

Request body

transactionIdsstring[] required

Transaction ids. Must be a non-empty array, and every id must still be eligible.

Response

The request was created and is PENDING.

messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.