Skip to main content
GET
Suggest payment matches for a deposit

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

UUID of the inbound bank transaction to score candidates for

Query Parameters

Optional. Also return receipts that match this text, whatever their amount or date: the check number, the external reference, the memo, the invoice or order number, the customer name, or the journal entry number. Scoped to your own entity. Shorter than the minimum length, or longer than the maximum, is ignored rather than rejected; % and _ match themselves.

window_days
integer

Optional. Widen the date window from the 7-day default. Clamped to the server ceiling; a value that is not a number is ignored and the default applies.

Required range: x >= 0
amount_tolerance
number

Optional. Widen the amount tolerance from the $0.05 default. Clamped to the server ceiling; a value that is not a number is ignored and the default applies.

Required range: x >= 0

Response

Candidate list (may be empty)

data
object