Skip to main content
POST
Release one exact immutable source-bound payment batch

Authorizations

Authorization
string
header
required

Firebase ID token from an interactive portal session. Required for interactive operations (payroll, company settings, API-key management) and invoice decisions allowed by the member's review permissions.

Path Parameters

batch_id
string
required

Body

application/json

Carries no bank login identifier. The PSU identifier Open Payments requires on every ISO call is derived server-side from the signed-in member's immutable auth subject (an opaque hash, unique per person and company, never a bank credential), recorded with the submission, and reused for every later status read of that submission. A sign-in without a derivable identity is refused after source revalidation and before any marker or bank call.

customer_id
string
required
idempotency_key
string
required
Required string length: 1 - 256

Response

Exact durable release receipt for direct bank delivery. A retry with the same idempotency key replays the receipt with replayed: true; when the delivery already crossed its request boundary for that release, the recorded submission stands, no bank call is made, and message says so.

release
object
required
message
string

Present when a replayed release found its bank delivery already recorded, or when a first delivery could not be confirmed.