Skip to main content
GET
Suggest marketplace payout matches

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

entity_id
string<uuid>
required

Query Parameters

bank_transaction_id
string<uuid>
required

The inbound bank transaction to find marketplace-payout candidates for.

Optional. Also return payouts that match this text, whatever their amount or date: the processor payout id, the platform 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

Scored candidate payouts for the bank transaction.

bank_transaction
object

The bank transaction the candidates were scored against.

marketplace_payouts
object[]

Up to 25 scored candidate payouts (highest score first).

top_candidate
object | null

The highest-scored candidate (or null when none qualify).