Skip to main content
GET
List payins

Authorizations

Authorization
string
header
required

Session JWT (from register/login) or API key (pk_...). X-API-Key: <token> is accepted as an alternative header.

Query Parameters

page
integer
default:1
Required range: x >= 1
page_size
integer
default:50
Required range: x <= 200
status
enum<string>
Available options:
pending,
credited,
unassigned,
expired,
failed
country
string

Filter by origin country (ISO 3166-1 alpha-2, e.g. BO, MX, VE).

method
string

Filter by rail method (bank_transfer, qr, card...). Values come from GET /v1/payins/methods.

kind
enum<string>

Filter by payin kind.

Available options:
push,
qr,
card,
collect,
checkout,
pos
refund_status
enum<string>

Filter by derived refund degree.

Available options:
none,
partial,
full

Case-insensitive partial match against payin_id, reference or idempotency_key.

instrument_id
string<uuid>

Filter by the dedicated deposit instrument UUID. Invalid UUID returns 400 invalid_request.

from
string<date>

Filter from this date (YYYY-MM-DD, organization timezone, inclusive).

to
string<date>

Filter up to this date (YYYY-MM-DD, organization timezone, inclusive).

format
enum<string>

Export the same rows as a file: csv or xlsx (accounting-grade download, up to 10,000 rows; same filters and date range). Omit for the JSON view.

Available options:
csv,
xlsx

Response

Paged payins.

page
integer
page_size
integer
payins
object[]