Skip to main content
POST
Match a deposit to a 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

bank_transaction_id
string<uuid>
required

Body

application/json
order_payment_id
string<uuid>
required

UUID of the order_payment to match to this bank transaction

reconciliation_id
string<uuid> | null

Optional active reconciliation session this match belongs to

move_payment_bank
boolean
default:false

Required, and only honoured, when the receipt was deposited directly to ANOTHER bank account (candidate requires_bank_move: true). Moves the receipt to this transaction's bank account and posts one dated reclassification per cash entry of the receipt before matching. Must be the boolean true.

Response

Matched successfully

data
object