v1

latestOpenAPI 3.1.0Proprietary2026-07-24462215.9 KB
Settlement Accounts

List Settlement Accounts

Retrieve a paginated list of the organization's settlement accounts. Optionally filter by settlement account ID, type, or default flag.

get/v3/settlement-account

Query parameters

settlementAccountIdstring
Example:SA-123456789

Filter by a specific settlement account ID

type'crypto' | 'fiat'
Example:fiat

Filter by settlement account type

defaultboolean
Example:true

Filter by whether the account is the default for its type

limitinteger
Example:5

Number of settlement accounts per page

pageinteger
Example:1

Page number for pagination

Headers

MIDstring required
Example:SABCDEF_SCT8YW_NA

Merchant or sub-merchant MID

Response

Settlement accounts listed successfully

statusstring
messagestring