Skip to main content
Use this endpoint for charge history, reconciliation workflows, and operational monitoring when you need paginated payin state in one call.

​
Prerequisites

  • Use a valid API key. See Authentication Overview.
  • If you need details for a single charge, use Get Payin after selecting an items[].id value from this response.

​
Request

​
Method & Path

​
Required Headers

​
Query Parameters

​
integer
Page size. Default 50. Minimum 1, maximum 100.
​
integer
Number of rows to skip before returning results. Default 0.
​
string
Exact charge status filter. Supported values: created, processing, succeeded, accepted, failed, expired, cancelled, refunded, partially_refunded, auto_refunded, underpaid, overpaid.

​
Request Example

​
Response

​
200 - Success

​
Response Fields

​
object
Pagination state for this page. See Pagination for the full field reference.
​
array
Current page of payin records based on limit and offset.
​
string|null
Checkout reference linked to this charge, if the payin originated from a checkout with a stored reference.
​
string
Charge ID you can pass to Get Payin.
​
string
Current charge status for this payin record.
​
boolean|null
Whether a refund can be created against this payin right now. It accounts for the charge’s own eligibility and for whether refunds are currently available at all, so false here means a refund would be rejected. See Issue a refund.
​
string
Requested payment amount in items[].currency.
​
string
Customer full name captured during checkout. Empty string when unavailable.
​
string
Customer email captured during checkout. Empty string when unavailable.
​
string
Amount received so far for this payin.
​
string
Remaining amount expected before full settlement. Returns 0.00 when fully paid or overpaid.
​
string
Settlement-side amount captured for this payin.
​
string|null
Settlement currency code for items[].settlement_amount.
​
string|null
Bachs’s processing fee on this payin, in items[].currency. null until the charge has a fee to report.
​
string|null
Reserved field for list-view VAT output. May be null.
​
string
Payment currency code.
​
string|null
On a destination charge stated fee-first, the platform’s cut of this sale. null on every other payin, including one whose split was stated share-first.
​
string|null
On a destination charge stated share-first, the amount the connected account receives. null on every other payin, including one whose split was stated fee-first.
​
string|null
Who Bachs’s processing fee actually came from: merchant or platform. null until the charge settles, because the answer is not fixed until then. See Processing fees.
​
object|null
Public metadata attached to the payin when available.
​
string|null
ISO 8601 timestamp when the payin record was created.
​
string|null
ISO 8601 timestamp when this payin reached a successful terminal state (succeeded or accepted).

​
Error Responses

Cause: API key is missing, invalid, or revoked.Resolution: Send a valid key in the Authorization header.