Merchants
Read a merchant's book
What was issued under one merchant over a period, and what was taken back, with the period’s totals per currency.
GET
A Loan may name the merchant it financed a purchase at, by your own
A missing, malformed or inverted
merchant_ref on the issuance. This read answers, for that merchant and a period: every sale that bound inside the period — on its anchor, or on its confirmation’s date where it was issued with a hold — with its principal and its state; and every return, cancellation, rescission, void and withdrawal recorded on such a Loan with its date inside the period, with its figure. Beside the entries, the whole period’s totals per currency — on every page.
A hold is no sale until it is confirmed. As a card authorisation is settled only once captured, a Loan issued with a hold enters the book on the day it is confirmed. One that expired or was voided unconfirmed never bound and is on no merchant’s book. A confirmation after a period never reaches back into it, so a period you settled stays settled.
Settlement is your ledger. What you owe the merchant is the principal issued, less the commission your agreement states and that commission’s tax, less what was taken back, plus or minus any subsidy you agreed. The Platform holds no commission, no agreement and no merchant: it serves every figure the settlement starts from, and the subtraction your agreement states is yours.
A retracted fact is off the book. The Platform keeps no register of merchants, so a
merchant_ref no Loan names is an empty book, not a 404.
Path parameters
string
required
The Tenancy asking.
string
required
The merchant, as your Loans name it. Letters, digits, hyphen and underscore, 1 to 64; anything else is
400 invalid_query.Query parameters
string
required
The period’s first day, included. Required and never defaulted — there is no today the Platform can supply.
string
required
The period’s last day, included, on or after
from.integer
default:"50"
How many entries to serve, between 1 and 200.
string
Where to resume, returned verbatim from the previous page.
from or to, and any other parameter, is 400 invalid_query.
Response
string
required
The merchant, echoed.
string
required
The period’s first day.
string
required
The period’s last day.
array
required
The page’s facts, by day and then by the fact’s identifier.
array
required
The whole period, one row per currency, ordered by code. Each row states
issued, returned, cancelled, rescinded, voided and withdrawn as {count, amount} — a kind the period holds none of is a stated zero, so you subtract without checking whether a field is there.string
Present while more entries exist; absent at the end.