payments_read
Arguments
ID!
required
Opaque payout id, from
payouts or from paymentTransactions → payout.id.Returns
One payout plus every order line that makes it up, and how many provider transactions sit behind those lines.
Show fields
Show fields
required
Every order line in this payout, in provider order. The list is the whole payout, not a page.
Show fields
Show fields
String
Customer name on the order, when it was collected.
String
The merchant’s own reference for the order, when one was recorded.
Gross amount of the whole order, before fees. This is the order’s figure, not this payout’s share, and the same amount repeats on every line for that order (for example a refund in a later payout). Null when it was not reported.
Letter-of-medical-necessity fee on the whole order. This is the order’s figure, not this payout’s share, and the same amount repeats on every line for that order (for example a refund in a later payout). Null when it was not reported.
Redo’s platform commission on the whole order (excludes the LMN fee). Card-processing costs are not charged to the merchant. This is the order’s figure, not this payout’s share, and the same amount repeats on every line for that order (for example a refund in a later payout). Null when it was not reported.
String
Order reference, or null when the line could not be matched to an order.
Platform fee plus LMN fee for the whole order. This is the order’s figure, not this payout’s share, and the same amount repeats on every line for that order (for example a refund in a later payout). Null when it was not reported.
required
How this line contributed. A line that both captured and refunded lists both.
The payout these lines settle.
Show fields
Show fields
When the payout report confirmed this payout, as a UTC instant. Null until the report lands.
Banking value date of the payout (YYYY-MM-DD): the date the deposit is valued, not the order date.
ID!
required
Opaque id of the payout. Pass it to
payoutBreakdown for the per-order lines.required
Settlement status of the payout.
required
Whether this row is a deposit or a reversal.
Int!
required
Number of provider transaction rows combined into
lines.Example
query {
payoutBreakdown(payoutId: "...") {
transactionCount
}
}