Searches your settlements, with filters, sorting and paging.
A settlement is one day's settlement from your payment processor: the charges, refunds, fees, chargebacks and adjustments
it settled on settlementDate. Payment Labs reads the processor's settlement files, links each line (a settlement item)
to your checkouts and subscription payments, and totals them in summary. Use settlements to reconcile what you were
paid against what you sold.
processingStatus says whether Payment Labs has finished reading the files (SUCCESS) or hit errors (ERROR; see List
Settlement Errors). settlementStatus is OPEN while the processor can still change the settlement and FINAL once it
is closed. If settlement reporting is not set up for your account, the search returns no records.
Filterable and sortable fields: id, merchantId, merchantName, settlementDate, totalItems, processedItems,
processingErrorItems, totalFiles, filesProcessed, processingStatus, settlementStatus, auditInfo.createdAt,
auditInfo.updatedAt.
Permission: Merchant Read.
Errors
400 VALIDATION_ERROR: a filter or sort names a field that is not listed above, or paging is out of range.400 INVALID_REQUEST: the search could not be run, for example because a value does not match the field type.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||