Skip to main content
POST
Match a bank deposit to invoices and record payment

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Path Parameters

id
string<uuid>
required

Bank transaction (deposit) UUID.

Body

application/json
account_id
string<uuid>
required

Customer account the deposit pays.

applications
object[]
required

Per-invoice application amounts.

route_unapplied
string | null

How to route any unapplied remainder.

reconciliation_id
string<uuid> | null
payment_method
string | null

Response

Deposit matched; payment recorded and posted.

The response is of type object.