NEnewline53
Synthetic Accounts

List Synthetic Accounts

Changed on

Retrieve a list of Synthetic Accounts associated with the specified Customer and Pool. This endpoint supports filtering by account type, category, status, and sorting by balance or name.

get/synthetic_accounts

Request

Query parameters

synthetic_account_type_uidstring
Example:q4mdMxMtjXfdbrjn

Filter by Synthetic Account Type

synthetic_account_category'general' | 'ach_external' | 'wire_external' | 'instant_payment_external'

Filter by Synthetic Account Category

status'initiated' | 'active' | 'archived' | 'failed'

Filter by status. Multiple values are allowed, e.g. status[]=archived&status[]=failed.

Example:active
sort'name_asc' | 'name_desc' | 'net_usd_balance_asc' | 'net_usd_balance_desc' | 'net_usd_pending_balance_asc' | 'net_usd_pending_balance_desc' | 'net_usd_available_balance_asc' | 'net_usd_available_balance_desc'

Parameters

#/paths/~1pools/get/parameters/0 (unresolved $ref)
#/paths/~1transfers/get/parameters/1 (unresolved $ref)
#/paths/~1transfers/get/parameters/2 (unresolved $ref)
#/paths/~1pools/get/parameters/1 (unresolved $ref)
#/paths/~1pools/get/parameters/2 (unresolved $ref)
#/paths/~1custodial_accounts/get/parameters/4 (unresolved $ref)

Changes

  • 54f4fe726d8fRevision changes
    • breaking

      the ////// response's property type changed from no type to string for status

    • info

      added to the //////// response property allOf list for the response status

    • info

      added subschema #2 to the ////// response property allOf list for the response status

    • info

      removed from the //////// response property allOf list for the response status

    • info

      removed from the ////// response property allOf list for the response status

    • info

      the ////// response's property pattern ^\d{10}$ was added for the status