--- title: "Retrieve the breakdown of a payout" method: GET path: "/payouts/{payoutId}/items" tags: ["Payouts"] --- # Retrieve the breakdown of a payout `GET /payouts/{payoutId}/items` Returns the items that make up the payout. The item amounts sum to the payout total amount. ## Path parameters - `payoutId` string, uuid, required — The id of the payout ## Query parameters - `page` integer — Which page to return, counting from one. - `size` integer — How many items to return per page. A request for more than the maximum is refused. - `sort` 'creationTime,desc' | 'creationTime,asc' — How to order the page. ## Response `200` The requested page of the breakdown. - PayoutItemsResponse — A page of the items that make up a payout - `items` PayoutItemResponse[], required — The items that make up the payout - `id` string, uuid, required — The id of the item - `type` 'PAYMENT' | 'PAYOUT', required — The type of the item - `status` 'SUCCESS' | 'FAILURE', required — The status of the item - `amount` number, required — The amount of the item - `currencyCode` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SPL' | 'SRD' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWD', required — The currency of the item - `paymentMethod` 'CARD' | 'APPLE_PAY' | 'GOOGLE_PAY' | 'AMEX' | 'OPEN_BANKING' | 'DIRECT_DEBIT' | 'BANK_TRANSFER' | 'EXTERNAL_BANK_ACCOUNT' | 'IMPORTED' — The method the payment was collected with. Set for PAYMENT items. - `customer` CustomerDetails — Customer details - `id` string, required — The ID of the customer - `name` string — The name of the customer - `paymentRequests` PaymentRequestDetails[] — The payment requests the payment was applied to. Set for PAYMENT items. - `id` string — The internal id of the payment request - `paymentRequestNo` string — The payment request number - `description` string — Short description of the payment request - `totalAmount` number — The payment request amount - `principalAmount` number — The principal amount of the payment request (excluding fees and discounts) - `paidAmount` number — The total amount that is paid - `currencyCode` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SPL' | 'SRD' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWD' — The currency in which the payment request is raised - `fees` FeeResponse[] — The active (non-waived) fees on this payment request. - `id` string, uuid — The fee id - `amount` number — The total fee amount - `dueAmount` number — The outstanding fee amount - `type` 'LATE_FEE' — The fee type - `effectiveDate` string, date-time — The date when the fee becomes effective - `items` FeeItemResponse[] — The fee item breakdown - `id` string, uuid — The fee item id - `type` 'DAILY_INTEREST' | 'FIXED_FEE' | 'WAIVER' — The fee item type - `description` string — The fee item description - `amount` number — The fee item amount - `dueAmount` number — The outstanding amount for this fee item - `payByDate` string, date-time — The (optional) date until when user recommended the payer to pay - `creationTime` string, date-time — The date the payment request was created - `lastNotificationSentTime` string, date-time — The date the payment request was last sent to the customer - `lastUpdatedTime` string, date-time — The date the payment request was last updated - `paidTime` string, date-time — The date the payment request paid - `paymentInitiationDate` string, date-time — The date when payment is initiated for this payment request (only for Direct Debit) - `chargeDate` string, date-time — The date on which the customer will have their account debited - `payoutDate` string, date-time — The date on which the biller will get paid out for the payment - `distributionTime` string, date-time — The date when the payment request was distributed - `status` 'DRAFT' | 'UNPAID' | 'OVERDUE' | 'SCHEDULED' | 'SUBMITTED' | 'PAID' | 'VOID' | 'SETTLED' — The payment request status - `statusReasonCode` 'MISSING_PAYER_CONTACT_DETAILS' | 'PENDING_ACTIVATION' | 'PENDING_DD_MANDATE' | 'PENDING_DD_CAPABILITY' | 'MARKED_AS_PAID' | 'WORKFLOW_COMPLETED' | 'NOTIFICATION_DELIVERY_FAILED' | 'BULK_PRUNE' | 'STALE_DRAFT_CLEANUP' | 'OTHER' | 'DIRECT_DEBIT_MANDATE_BANK_ACCOUNT_CHANGED' — The reason as predefined code why the payment request is in a certain status - `statusReason` string — Custom details on why the payment request is in a certain status - `reference` string — The payment request reference - `payments` PaymentAllocationResponse[] — The payments made as part of this payment request - `id` string, required — The ID of the payment allocation - `paymentId` string, required — The ID of the payment - `paymentRequestId` string, required — The ID of the payment request - `creationTime` string, date-time, required — The date when the payment was initiated - `lastUpdatedTime` string, date-time — The last time when the payment was updated - `advance` Advance — Advance details for a payment without existing payment requests - `customerId` string, required — The ID of the customer - `amount` number, required — The amount to be paid - `currencyCode` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SPL' | 'SRD' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWD', required — The currency code - `prAllocations` PrAllocation[] — Per-payment-request allocations for this payment - `prId` string, uuid - `amount` number - `currencyCode` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SPL' | 'SRD' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWD' — The default currency of the biller. - `splitDetails` SplitDetails - `billerAmount` number - `surchargeAmount` number - `fixedLateFeeAmount` number - `amount` number, required — The paid amount - `feeDetails` FeeDetails — Fee details applied to a payment - `amount` number — The amount of the fee - `applicationMethod` 'SURCHARGE' | 'LATE_FEE' — The fee application method - `items` FeeItemDetail[] — The fee item breakdown - `amount` number — The amount allocated to this fee item - `type` 'DAILY_INTEREST' | 'FIXED_FEE' | 'WAIVER' — The fee item type (e.g. DAILY_INTEREST, FIXED_FEE) - `fees` FeeDetails[] — Details about the applied fees - `amount` number — The amount of the fee - `applicationMethod` 'SURCHARGE' | 'LATE_FEE' — The fee application method - `items` FeeItemDetail[] — The fee item breakdown - `amount` number — The amount allocated to this fee item - `type` 'DAILY_INTEREST' | 'FIXED_FEE' | 'WAIVER' — The fee item type (e.g. DAILY_INTEREST, FIXED_FEE) - `status` 'PENDING' | 'SUBMITTED' | 'SENT' | 'SUCCESS' | 'CANCELLED' | 'FAILED' | 'SETTLED', required — The current payment status - `receiptNo` string — The current payment receipt number - `paymentMethod` 'BANK_PAYMENT' | 'CARD' | 'APPLE_PAY' | 'GOOGLE_PAY' | 'DIRECT_DEBIT' | 'IMPORTED' | 'MANUAL_BANK_TRANSFER' | 'BANK_TRANSFER' | 'AMEX', required — The method used for making the payment - `channelPaymentId` string, required — Unique identifier for the payment in the payment provider's system - `channelPaymentUrl` string — The URL generated by the payment provider to perform the payment - `channelReferenceId` string — The remittance reference ID for bank payments - `externalData` PaymentExternalData[] — References about this payment from external platforms Adfin integrates with - `connectorType` 'XERO' | 'QUICKBOOKS' | 'PLATFORM' — The name of the platform for which this data is stored for. - `id` string — ID of the payment in the external platform - `paymentSource` 'PAYMENT_LINK' | 'GENERIC_PAYMENT_LINK' | 'PAYMENT_OVER_PHONE' — How the payment was initiated. - `cardOnFileId` string, uuid — The ID of the card on file the payment was taken from - `metadata` unknown - `discounts` DiscountDetails[] — The discounts applied to this payment request - `totalAmount` number — The discounted amount - `expirationDate` string, date-time — The date until when the discount is valid - `paymentLink` PaymentLinkDetails — Payment link details. - `url` string — The payment URL. - `lastSeenTime` string, date-time — The date when the payment link was seen for the last time - `distribution` DistributionDetails — Information about how a payment request is distributed and collected. - `collectionMethod` 'ONE_TIME_PAYMENT' | 'DIRECT_DEBIT_PAYMENT' | 'NONE' — How the payment is expected to be collected for this payment request. - `customMessage` string — An optional message that will be sent to the customer when the payment request is distributed. - `templateId` string — The schedule template id used for sending the payment request to customer. - `cancelCollectionOnFailure` boolean — Whether collection should be cancelled if the payment fails - `workflowType` 'AUTO_COLLECT' | 'ON_DEMAND' | 'NONE' — The workflow type of the payment request - `customFields` CustomField[] — The list of custom fields that are applied to the payment request - `fieldId` string — The ID of the field definition. - `fieldValueId` string — The ID of the specific field value. - `receiptNo` string — The receipt number - `creationTime` string, date-time, required — The time the item was created - `pagination` Pagination, required — Contains pagination information for a set of results - `page` integer — The current page number One-based page index (1..N). - `size` integer — The size of the page, i.e., the number of elements per page. - `totalPages` integer — The total number of pages available. - `totalElements` integer — The total number of elements across all pages. - `numberOfElements` integer — The number of elements in the current page. - `sort` string — Sorting criteria in the format: property,(asc|desc). ## Other responses - `400` — payoutId is not a UUID, sort names anything but creationTime, or page or size falls outside its documented range. - `401` — The request carried no valid access token. - `404` — There is no payout with that id. A payout that belongs to another biller answers the same way. - `500` — The server could not process the request. ## Changes - **2026-08-31** `15c1340dcb72` — 2 info - the endpoint scheme security `Biller Access Token (Production)` was added to the API - the endpoint scheme security `Biller Access Token (Staging)` was added to the API - **2026-08-29** `53d29f0850e0` — 1 info - endpoint added [Change history](https://skmtc.dev/adfin/apis/adfin-api/changes/payouts/:payoutId/items/get.md) --- [API](https://skmtc.dev/adfin/apis/adfin-api.md) · [All operations](https://skmtc.dev/adfin/apis/adfin-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/adfin/adfin-api/revisions/53d29f0850e0/schema)