---
updatedAt: 2026-04-20T20:36:45.000Z
agentTools:
projectIndex: https://docs.cybrid.xyz/llms.txt
---
# Get transfers list
Retrieves a listing of transfers. Records are sorted by creation date in descending order.
Required scope: **transfers:read**
# OpenAPI definition
````json
{
"openapi": "3.0.3",
"info": {
"title": "Cybrid Bank API",
"termsOfService": "https://www.cybrid.xyz/tos",
"description": "# Cybrid API documentation\n\nWelcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services.\n\nIn these documents, you'll find details on how our REST API operates and generally how our platform functions.\n\nIf you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app).\n\n💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources.\n\n## Getting Started\n\nThis is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.production.cybrid.app/api/schema/v1/swagger.yaml) for import.\n\nIf you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform:\n\n1. [Introduction](https://docs.cybrid.xyz/docs/introduction)\n2. [Platform Overview](https://docs.cybrid.xyz/docs/platform-overview)\n3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/hosted-demo-app)\n\nIn [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/cybrid-sandbox), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://docs.cybrid.xyz/docs/trade-process), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades.\n\n## Working with the Cybrid Platform\n\nThere are three primary ways you can interact with the Cybrid platform:\n\n1. Directly via our RESTful API (this documentation)\n2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript))\n3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios))\n\nOur complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside.\n\n*The complete set of APIs can be found on the following pages:*\n\n| API | Description |\n|------------------------------------------------------------------|-------------------------------------------------------------|\n| [Organization API](https://organization.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations |\n| [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) |\n| [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities |\n\nFor questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions.\n\n## Authenticating with the API\n\nThe Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.cybrid.app) as well.\n\nAn `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank.\n\nBoth `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication.\n\nA `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui).\n\n**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**\n\nYour `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document.\n\nThe following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications.\n\n```\n# Example request when using Bank credentials\ncurl -X POST https://id.production.cybrid.app/oauth/token -d '{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"scope\": \"banks:read banks:write bank_applications:read accounts:read accounts:write accounts:execute counterparties:read counterparties:pii:read counterparties:write counterparties:execute customers:read customers:pii:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:execute transfers:read transfers:write external_bank_accounts:read external_bank_accounts:pii:read transfers:pii:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:write external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:write deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:pii:read identity_verifications:write identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute\"\n }' -H \"Content-Type: application/json\"\n\n# When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:read banks:read banks:write banks:execute bank_applications:read users:read counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read accounts:write prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:read transfers:write transfers:execute external_bank_accounts:read external_bank_accounts:pii:read transfers:pii:read external_bank_accounts:write external_wallets:read external_wallets:write workflows:read deposit_addresses:read deposit_addresses:write deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read subscription_events:read subscription_events:execute identity_verifications:read identity_verifications:pii:read identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute'\n```\n**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**\n\n## Authentication Scopes\n\nThe Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal.\n\nThe following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource.\n\n| Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) |\n|-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------|\n| Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) |\n| Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) |\n| Bank Application | bank_applications:read (Organization, Bank) | | |\n| Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) |\n| Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties:execute (Bank) |\n| Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) |\n| External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) |\n| External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) |\n| Organization Application | organization_applications:read (Organization) | | |\n| Organization | organizations:read (Organization) | organizations:write (Organization) | |\n| User | users:read (Organization) | | |\n| Price | prices:read (Bank, Customer) | | |\n| Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) |\n| Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) |\n| Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) |\n| Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) |\n| Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) |\n\nAPI keys and organization users are created, updated and deleted only in the Partner Portal, and subscriptions are managed there exclusively. Tokens issued for an organization API key can list and get organization applications, bank applications and users, and tokens issued for a bank API key can list and get bank applications; neither can create, update or delete them, and neither can reach subscriptions at all. Requesting the `organization_applications:write`, `organization_applications:execute`, `bank_applications:write`, `bank_applications:execute`, `users:write`, `users:execute`, `subscriptions:read`, `subscriptions:write` or `subscriptions:execute` scopes alongside other scopes is tolerated: they are dropped and the token is issued with the rest.\n\n## Available Endpoints\n\nThe available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.cybrid.app/api/schema/swagger-ui) API services are listed below:\n\n| API Service | Model | API Endpoint Path | Description |\n|--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------|\n| Identity | Bank | /api/bank_applications | Get and list bank API keys |\n| Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens |\n| Identity | Organization | /api/organization_applications | Get and list organization API keys |\n| Identity | Organization | /api/users | Get and list organization users |\n| Organization | Organization | /api/organizations | APIs to retrieve and update organization name |\n| Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers |\n| Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) |\n| Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc |\n| Bank | Customer | /api/customers | Create and list customers |\n| Bank | Counterparty | /api/counterparties | Create and list counterparties |\n| Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses |\n| Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform |\n| Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform |\n| Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC |\n| Bank | Invoice | /api/invoices | Get and list invoices |\n| Bank | PaymentInstruction | /api/payment_instructions | Get and list payment instructions for invoices |\n| Bank | Price | /api/prices | Get the current prices for assets on the platform |\n| Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades |\n| Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) |\n| Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency |\n| Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) |\n| Bank | Workflow | /api/workflows | Create, get and list workflows |\n\n## Understanding Object Models & Endpoints\n\n**Organizations**\n\nAn `Organization` is meant to represent the organization partnering with Cybrid to use our platform.\n\nAn `Organization` typically does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform.\n\n**Banks**\n\nA `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`.\n\nAn `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes.\n\n**Customers**\n\n`Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers.\n\n`Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified.\n\n`Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.\n",
"version": "v0.129.1304",
"contact": {
"name": "Cybrid Support",
"email": "support@cybrid.app"
},
"license": {
"name": "Apache-2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"paths": {
"/api/transfers": {
"get": {
"summary": "Get transfers list",
"tags": [
"Transfers"
],
"operationId": "listTransfers",
"description": "Retrieves a listing of transfers. Records are sorted by creation date in descending order.\n\nRequired scope: **transfers:read**",
"security": [
{
"BearerAuth": [],
"oauth2": [
"transfers:read"
]
}
],
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/ListRequestPage"
},
"description": "The page index to retrieve."
},
{
"name": "per_page",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/ListRequestPerPage"
},
"description": "The number of entities per page to return."
},
{
"name": "guid",
"in": "query",
"required": false,
"description": "Comma separated transfer_guids to list transfers for.",
"schema": {
"type": "string"
}
},
{
"name": "transfer_type",
"in": "query",
"required": false,
"description": "Comma separated transfer_types to list accounts for.",
"schema": {
"type": "string"
}
},
{
"name": "bank_guid",
"in": "query",
"required": false,
"description": "Comma separated bank_guids to list transfers for.",
"schema": {
"type": "string"
}
},
{
"name": "customer_guid",
"in": "query",
"required": false,
"description": "Comma separated customer_guids to list transfers for.",
"schema": {
"type": "string"
}
},
{
"name": "account_guid",
"in": "query",
"required": false,
"description": "Comma separated account_guids to list transfers for.",
"schema": {
"type": "string"
}
},
{
"name": "state",
"in": "query",
"required": false,
"description": "Comma separated states to list transfers for.",
"schema": {
"type": "string"
}
},
{
"name": "side",
"in": "query",
"required": false,
"description": "Comma separated sides to list transfers for.",
"schema": {
"type": "string"
}
},
{
"name": "label",
"in": "query",
"required": false,
"description": "Comma separated labels to list transfers for.",
"schema": {
"type": "string"
}
},
{
"name": "txn_hash",
"in": "query",
"required": false,
"description": "Comma separated transaction hashes to list transfers for.",
"schema": {
"type": "string"
}
},
{
"name": "created_at_gte",
"in": "query",
"required": false,
"description": "Created at start date-time inclusive lower bound, ISO8601",
"schema": {
"type": "string"
}
},
{
"name": "created_at_lt",
"in": "query",
"required": false,
"description": "Created at end date-time exclusive upper bound, ISO8601.",
"schema": {
"type": "string"
}
},
{
"name": "updated_at_gte",
"in": "query",
"required": false,
"description": "Created at start date-time inclusive lower bound, ISO8601",
"schema": {
"type": "string"
}
},
{
"name": "updated_at_lt",
"in": "query",
"required": false,
"description": "Created at end date-time exclusive upper bound, ISO8601.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "get list of transfers",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransferList"
}
}
}
},
"400": {
"description": "Invalid requests",
"content": {
"application/json": {
"examples": {
"invalid_value": {
"value": {
"status": 400,
"error_message": "Invalid value. comma separated account guids must be at the most 4096 characters long",
"message_code": "invalid_value"
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Authentication failed",
"content": {
"application/json": {
"examples": {
"invalid_subject": {
"value": {
"status": 401,
"error_message": "Invalid Subject type. Required: customer or bank or organization",
"message_code": "invalid_subject"
}
},
"invalid_signature": {
"value": {
"status": 401,
"error_message": "Signature verification raised",
"message_code": "authentication_failed"
}
},
"invalid_audience": {
"value": {
"status": 401,
"error_message": "Invalid audience",
"message_code": "authentication_failed"
}
},
"invalid_issuer": {
"value": {
"status": 401,
"error_message": "Invalid issuer",
"message_code": "authentication_failed"
}
},
"expired_signature": {
"value": {
"status": 401,
"error_message": "Signature has expired",
"message_code": "authentication_failed"
}
},
"malformed_auth_header": {
"value": {
"status": 401,
"error_message": "Authorization header is malformed.",
"message_code": "authentication_malformed"
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Invalid scope",
"content": {
"application/json": {
"examples": {
"invalid_scope": {
"value": {
"status": 403,
"error_message": "Invalid scopes. Required: transfers:read",
"message_code": "invalid_scopes"
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"securitySchemes": {
"oauth2": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "https://id.production.cybrid.app/oauth/token",
"scopes": {
"banks:read": "banks read",
"banks:write": "banks write",
"bank_applications:read": "bank_applications read",
"accounts:read": "accounts read",
"accounts:write": "accounts write",
"accounts:execute": "accounts execute",
"counterparties:read": "counterparties read",
"counterparties:pii:read": "counterparties pii read",
"counterparties:write": "counterparties write",
"counterparties:execute": "counterparties execute",
"customers:read": "customers read",
"customers:pii:read": "customers pii read",
"customers:write": "customers write",
"customers:execute": "customers execute",
"prices:read": "prices read",
"quotes:execute": "quotes execute",
"quotes:read": "quotes read",
"trades:execute": "trades execute",
"trades:read": "trades read",
"transactions:read": "transactions read",
"transfers:execute": "transfers execute",
"transfers:read": "transfers read",
"transfers:write": "transfers write",
"external_bank_accounts:read": "external_bank_accounts read",
"external_bank_accounts:pii:read": "external_bank_accounts pii read",
"transfers:pii:read": "transfers pii read",
"external_bank_accounts:write": "external_bank_accounts write",
"external_bank_accounts:execute": "external_bank_accounts execute",
"external_wallets:read": "external_wallets read",
"external_wallets:write": "external_wallets write",
"external_wallets:execute": "external_wallets execute",
"workflows:read": "workflows read",
"workflows:execute": "workflows execute",
"deposit_addresses:read": "deposit_addresses read",
"deposit_addresses:write": "deposit_addresses write",
"deposit_addresses:execute": "deposit_addresses execute",
"deposit_bank_accounts:read": "deposit_bank_accounts read",
"deposit_bank_accounts:write": "deposit_bank_accounts write",
"deposit_bank_accounts:execute": "deposit_bank_accounts execute",
"invoices:read": "invoices read",
"invoices:write": "invoices write",
"invoices:execute": "invoices execute",
"identity_verifications:read": "identity_verifications read",
"identity_verifications:pii:read": "identity_verifications pii read",
"identity_verifications:write": "identity_verifications write",
"identity_verifications:execute": "identity_verifications execute",
"persona_sessions:execute": "persona_sessions execute",
"sardine_sessions:execute": "sardine_sessions execute",
"plans:execute": "plans execute",
"plans:read": "plans read",
"executions:execute": "executions execute",
"executions:read": "executions read",
"files:read": "files read",
"files:pii:read": "files pii read",
"files:execute": "files execute"
}
}
}
},
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
},
"schemas": {
"FeeDetail": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of fee; one of bank, platform, or network.",
"enum": [
"bank",
"platform",
"network"
]
},
"asset": {
"type": "string",
"description": "The asset the fee is denominated in, e.g., USD."
},
"amount": {
"type": "integer",
"description": "The fee amount in base units of the asset."
}
},
"required": [
"type",
"asset",
"amount"
]
},
"Transfer": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"description": "Auto-generated unique identifier for the transfer.",
"minLength": 32,
"maxLength": 32
},
"transfer_type": {
"description": "The type of transfer; one of funding, book, crypto, instant_funding, funding_return, crypto_return, loss_recovery, inter_account, lightning, instant_funding_return, loss_coverage, or loss_reclaim.",
"type": "string"
},
"bank_guid": {
"type": "string",
"description": "The associated bank's identifier.",
"minLength": 32,
"maxLength": 32,
"nullable": true
},
"customer_guid": {
"type": "string",
"description": "The associated customer's identifier.",
"minLength": 32,
"maxLength": 32,
"nullable": true
},
"quote_guid": {
"type": "string",
"description": "The associated quote's identifier.",
"minLength": 32,
"maxLength": 32
},
"external_bank_account_guid": {
"type": "string",
"description": "The associated external bank account's identifier.",
"minLength": 32,
"maxLength": 32,
"nullable": true
},
"asset": {
"type": "string",
"description": "The asset the transfer is related to, e.g., USD."
},
"side": {
"type": "string",
"description": "The direction of the quote; one of deposit or withdrawal."
},
"state": {
"description": "The state of the transfer; one of storing, pending, holding, reviewing, completed, failed, or cancelling.",
"type": "string"
},
"failure_code": {
"description": "The failure code for failed transfers; one of non_sufficient_funds, refresh_required, party_name_invalid, payment_rail_invalid, compliance_rejection, cancelled, reversed, limit_exceeded, network_fee_too_low, amount_too_low, internal_error, invalid_address, invalid_destination, customer_action_required, external_vendor_error, payment_request_expired, return_risk_exceeded, daily_limit_exceeded, weekly_limit_exceeded, monthly_limit_exceeded, lifetime_limit_exceeded, customer_contact_info_missing, recipient_cancelled, or invalid_security_question.",
"type": "string",
"nullable": true
},
"return_code": {
"description": "The return code for reversed transfers",
"type": "string",
"nullable": true
},
"amount": {
"type": "integer",
"description": "The actual amount in base units of the asset.",
"nullable": true
},
"estimated_amount": {
"type": "integer",
"description": "The estimated amount in base units of the asset."
},
"fee": {
"type": "integer",
"description": "The fee associated with the transfer. Represents the sum of the bank and platform fees."
},
"fee_details": {
"type": "array",
"description": "The fees associated with the transfer.",
"items": {
"$ref": "#/components/schemas/FeeDetail"
}
},
"estimated_network_fee": {
"type": "integer",
"description": "The estimated network fee in base units of network_fee_asset. Only present on `crypto` transfers.",
"nullable": true
},
"network_fee": {
"type": "integer",
"description": "The actual network fee in base units of network_fee_asset. Only present on `crypto` transfers that have successfully completed.",
"nullable": true
},
"network_fee_asset": {
"type": "string",
"minLength": 1,
"maxLength": 16,
"description": "The asset code of the network fee. Only present on `crypto` transfers that have successfully completed.",
"nullable": true
},
"network_fee_liability_amount": {
"type": "integer",
"description": "The equivalent fiat network fee in base units of network_fee_liability_amount_asset. Only present on `crypto` transfers that have successfully completed.",
"nullable": true
},
"network_fee_liability_amount_asset": {
"type": "string",
"description": "The fiat asset the network_fee_liability_amount is denominated in. Only present on `crypto` transfers that have successfully completed.",
"nullable": true
},
"txn_hash": {
"type": "string",
"description": "The hash of the blockchain transaction (deprecated: use identifiers array)",
"nullable": true
},
"identifiers": {
"type": "array",
"description": "Array of identifiers associated with this transfer (transaction hash, wire reference numbers)",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"txn_hash",
"imad",
"omad",
"gateway_url"
],
"description": "Type of identifier (txn_hash, imad, omad, gateway_url)"
},
"value": {
"type": "string",
"description": "The identifier value"
}
}
}
},
"reference_transfer_guid": {
"type": "string",
"description": "The guid of the related transfer. Only present on return type transfers.",
"minLength": 32,
"maxLength": 32,
"nullable": true
},
"source_account": {
"description": "The source account in the transfer. Can be omitted for crypto deposits.",
"type": "object",
"properties": {
"guid": {
"type": "string",
"description": "Auto-generated unique identifier for the transfer account.",
"minLength": 32,
"maxLength": 32
},
"type": {
"type": "string",
"description": "The type of transfer account; one of trading, fiat, external_bank_account, external_wallet, one_time_address, reserve, invoice_operations, fee, gas, or storage."
},
"bank_guid": {
"type": "string",
"description": "The account's identifier.",
"minLength": 32,
"maxLength": 32,
"nullable": true
},
"customer_guid": {
"type": "string",
"description": "The account's identifier.",
"minLength": 32,
"maxLength": 32,
"nullable": true
}
},
"nullable": true
},
"source_participants": {
"type": "array",
"description": "The participants in the source account.",
"items": {
"$ref": "#/components/schemas/TransferParticipant"
},
"nullable": true
},
"destination_account": {
"description": "The destination account in the transfer.",
"type": "object",
"properties": {
"guid": {
"type": "string",
"description": "Auto-generated unique identifier for the transfer account.",
"minLength": 32,
"maxLength": 32
},
"type": {
"type": "string",
"description": "The type of transfer account; one of trading, fiat, external_bank_account, external_wallet, one_time_address, reserve, invoice_operations, fee, gas, or storage."
},
"bank_guid": {
"type": "string",
"description": "The account's identifier.",
"minLength": 32,
"maxLength": 32,
"nullable": true
},
"customer_guid": {
"type": "string",
"description": "The account's identifier.",
"minLength": 32,
"maxLength": 32,
"nullable": true
}
},
"nullable": true
},
"destination_participants": {
"type": "array",
"description": "The participants in the source account.",
"items": {
"$ref": "#/components/schemas/TransferParticipant"
},
"nullable": true
},
"deposit_address_guid": {
"type": "string",
"description": "The guid of the deposit address. Only present on crypto deposits.",
"minLength": 32,
"maxLength": 32,
"nullable": true
},
"created_at": {
"type": "string",
"description": "ISO8601 datetime the record was created at.",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "ISO8601 datetime the record was last updated at.",
"format": "date-time"
},
"hold_details": {
"description": "The hold details if a transfer is or will be placed on a hold.",
"type": "object",
"properties": {
"applicable_types": {
"description": "The list of hold types that are applicable for the transfer; one of administrative or non_administrative.",
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"kind": {
"description": "The kind of hold; one of settlement or dispatch. A settlement hold keeps landed deposit funds unavailable; a dispatch hold keeps withdrawal funds from leaving until it ends. Null until a hold is recorded.",
"type": "string",
"nullable": true
},
"duration": {
"type": "integer",
"description": "The approximate time (in seconds) that the transfer will be held for.",
"nullable": true
},
"started_at": {
"type": "string",
"description": "ISO8601 datetime the transfer hold was started at.",
"format": "date-time",
"nullable": true
}
},
"nullable": true
},
"transfer_details": {
"type": "object",
"description": "The raw details on the transfer from the bank. Returned only by the get transfer endpoint when include_pii is true, which requires the **transfers:pii:read** scope.",
"nullable": true
},
"payment_rail": {
"type": "string",
"description": "The rail the payment was done on. One of: ach, eft, wire, rtp, etransfer",
"nullable": true
},
"labels": {
"type": "array",
"description": "The labels associated with the transfer.",
"items": {
"type": "string"
},
"nullable": true
},
"entries": {
"type": "array",
"description": "Transfer entries associated with the batch transfer",
"items": {
"$ref": "#/components/schemas/TransferEntry"
},
"nullable": true
}
}
},
"TransferEntry": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"description": "The actual amount in base units of the asset.",
"nullable": true
},
"fee": {
"type": "integer",
"description": "The fee associated with the transfer entry."
},
"source_account": {
"description": "The source account in the batch transfer entry.",
"type": "object",
"properties": {
"guid": {
"type": "string",
"description": "Auto-generated unique identifier for the transfer account.",
"minLength": 32,
"maxLength": 32
},
"type": {
"type": "string",
"description": "The type of transfer account; one of external_wallet."
},
"bank_guid": {
"type": "string",
"description": "The account's identifier.",
"minLength": 32,
"maxLength": 32,
"nullable": true
},
"customer_guid": {
"type": "string",
"description": "The account's identifier.",
"minLength": 32,
"maxLength": 32,
"nullable": true
}
},
"nullable": true
},
"destination_account": {
"description": "The destination account entry in the batch transfer.",
"type": "object",
"properties": {
"guid": {
"type": "string",
"description": "Auto-generated unique identifier for the transfer account.",
"minLength": 32,
"maxLength": 32
},
"type": {
"type": "string",
"description": "The type of transfer account; one of trading, fiat, external_bank_account, external_wallet, one_time_address, reserve, invoice_operations, fee, gas, or storage."
},
"bank_guid": {
"type": "string",
"description": "The account's identifier.",
"minLength": 32,
"maxLength": 32,
"nullable": true
},
"customer_guid": {
"type": "string",
"description": "The account's identifier.",
"minLength": 32,
"maxLength": 32,
"nullable": true
}
},
"nullable": true
}
},
"required": [
"amount",
"fee",
"source_account",
"destination_account"
]
},
"TransferParticipant": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of participant; one of unknown, bank, customer, or counterparty."
},
"amount": {
"type": "integer",
"description": "The amount in base units of the asset."
},
"guid": {
"type": "string",
"description": "The participant's identifier.",
"minLength": 32,
"maxLength": 32
}
},
"required": [
"type",
"amount"
]
},
"TransferList": {
"type": "object",
"properties": {
"total": {
"description": "The total number of records available.",
"type": "integer",
"minimum": 0
},
"page": {
"description": "The page index to retrieve.",
"type": "integer",
"minimum": 0
},
"per_page": {
"description": "The number of entities per page to return.",
"type": "integer",
"minimum": 1
},
"objects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Transfer"
}
}
},
"required": [
"total",
"page",
"per_page",
"objects"
]
},
"ListRequestPage": {
"description": "The page index to retrieve.",
"type": "integer",
"minimum": 0
},
"ListRequestPerPage": {
"description": "The number of entities per page to return.",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"ErrorResponse": {
"type": "object",
"properties": {
"status": {
"description": "Status code for Http Request",
"type": "integer"
},
"error_message": {
"description": "Error message",
"type": "string"
},
"message_code": {
"description": "Message code for Error",
"type": "string"
}
},
"required": [
"status",
"error_message",
"message_code"
]
}
}
},
"servers": [
{
"url": "https://bank.sandbox.cybrid.app",
"description": "Sandbox environment is simulated money movement"
},
{
"url": "https://bank.production.cybrid.app",
"description": "Production environment is real money movement"
}
]
}
````