Skip to main content
GET
List payout bank accounts
Requires scope: manage:pay-outs — see Required scopes. Returns a paginated list of the party’s allow-listed bank accounts. Account numbers are masked to the last 4 digits. Only accounts with status: ACTIVE can back a payout route.

Authorizations

Path Parameters

partyId
string<uuid>
required

Unique party identifier

Query Parameters

page
integer<int32>
default:1

Page number (1-based indexing)

Required range: x >= 1
size
integer<int32>
default:100

Number of items per page

Required range: x >= 1
sortOn
string
default:createdAt

Field to sort by

sortOrder
enum<string>
default:ASC

Sort direction

Available options:
ASC,
DESC

Response

List of payout bank accounts (masked)

success
boolean

Indicates whether the request was successful

result
object[]
pagination
object

Pagination metadata (top-level sibling of result)