action velopayments_get_source_accounts_v3 { label: "Get list of source accounts" description: "List source accounts." provider: velopayments method: GET path: "/v3/sourceAccounts" encoding: json input: { type: "object" properties: { fundingAccountId: { type: "string" format: "uuid" } includeUserDeleted: { type: "string" format: "boolean" } page: { type: "integer" format: "int32" } pageSize: { type: "integer" format: "int32" } payorId: { type: "string" format: "uuid" } physicalAccountId: { type: "string" format: "uuid" } physicalAccountName: { type: "string" } sort: { type: "string" } type: { type: "string" description: "Type of source account. One of the following values: FBO,PRIVATE,WUBS_DECOUPLED" } } additionalProperties: false } output: { type: "object" description: "List Source Accounts Response Object" properties: { content: { type: "array" items: { type: "object" required: ["id", "railsId", "type"] properties: { autoTopUpConfig: { type: "object" required: ["enabled"] properties: { enabled: { type: "boolean" description: "Is auto top-up enabled? automatically trigger funding to top-up the source account balance when the balance falls below the configured minimum level." } fundingAccountId: { type: "string" format: "uuid" description: "Id of funding account from which to pull funds when auto top-up is triggered. Note - if this is not set then auto top-up is effectively disabled." } minBalance: { type: "integer" format: "int64" description: "When the payor balance falls below this level then auto top-up will be triggered. Note - This is in minor units." } targetBalance: { type: "integer" format: "int64" description: "When the payor balance falls below the min balance then auto top-up will request funds bring the balance to this level. Note - this is in minor units." } } } balance: { type: "integer" format: "int64" description: "Decimal implied" } country: { type: "string" description: "Valid ISO 3166 2 character country code. See the ISO specification for details." } currency: { type: "string" description: "Valid ISO 4217 3 letter currency code. See the ISO specification for details." } customerId: { type: "string" } deleted: { type: "boolean" description: "An optional flag for whether the source account has been deleted. Only present in the response if true." } deletedAt: { type: "string" format: "date-time" description: "An optional timestamp when the source account has been deleted. Only present in the response if deleted." } fundingRef: { type: "string" description: "The funding reference (will not be set for DECOUPLED accounts)." } id: { type: "string" format: "uuid" description: "Source Account Id" } name: { type: "string" } notifications: { type: "object" properties: { minimumBalance: { type: "integer" } } } payorId: { type: "string" format: "uuid" } physicalAccountId: { type: "string" format: "uuid" description: "The physical account id (will not be set for DECOUPLED accounts)." } physicalAccountName: { type: "string" description: "The physical account name (will not be set for DECOUPLED accounts)." } pooled: { type: "boolean" description: "The pooled account flag (will not be set for DECOUPLED accounts)." } railsId: { type: "string" } type: { type: "string" } userDeleted: { type: "boolean" description: "An optional flag for whether the source account has been deleted by a user. Only present in the response if true." } } } } links: { type: "array" items: { properties: { href: { type: "string" } rel: { type: "string" } } } } page: { properties: { numberOfElements: { type: "integer" } page: { type: "integer" } pageSize: { type: "integer" } totalElements: { type: "integer" } totalPages: { type: "integer" } } } } } }