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

Request

Base URL
https://sandbox-api.transfi.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/transfi/apis/transfi-single-integrated-api/docs/v3/settlement-account/get.ts
A function with typed inputs. Its response is checked against the schema.

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

MIDstring required

Example:SABCDEF_SCT8YW_NA

Merchant or sub-merchant MID

Settlement accounts listed successfully

statusstring

messagestring

No recorded changes to this operation across all 2 revisions of this API.