--- updatedAt: 2026-04-22T09:12:42.000Z agentTools: projectIndex: https://dev.fuze.finance/llms.txt --- # Get a transfer Get a transfer for a user. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Digital Assets-as-a-Service", "description": "Digital Assets-as-a-Service (DAaaS) API Documentation", "termsOfService": "https://fuze.finance/", "contact": { "email": "engineering@fuze.finance" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "0.0.7", "x-logo": { "url": "https://fuze.finance/logo.png", "backgroundColor": "white", "altText": "Fuze HQ" } }, "servers": [ { "url": "https://preprod-api.fuze.finance", "description": "Sandbox Server for testing" } ], "paths": { "/api/v1/ol/transfer/get": { "post": { "tags": [ "Transfer", "public" ], "summary": "Get a transfer", "description": "Get a transfer for a user.", "operationId": "OpenLoopGetTransfer", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "X-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-TIMESTAMP", "in": "header", "required": true, "schema": { "type": "number" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenLoopGetTransferRequest" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenLoopGetTransferResponse" }, "examples": { "200": { "$ref": "#/components/examples/OpenLoopGetTransferResponseExample200" } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "400": { "$ref": "#/components/examples/InvalidRequestResponseExample" } } } } }, "401": { "description": "Unauthorised.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "401": { "$ref": "#/components/examples/UnauthorisedResponseExample" } } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "403": { "$ref": "#/components/examples/ForbiddenResponseExample" } } } } }, "404": { "description": "Not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "404": { "$ref": "#/components/examples/NotFoundResponseExample" } } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "500": { "$ref": "#/components/examples/InternalServerErrorResponseExample" } } } } } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-KEY" }, "JWT": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "examples": { "InvalidRequestResponseExample": { "value": { "code": 400, "error": "INVALID_REQUEST", "data": null } }, "UnauthorisedResponseExample": { "value": { "code": 401, "error": "UNAUTHENTICATED", "data": null } }, "ForbiddenResponseExample": { "value": { "code": 403, "error": "FORBIDDEN", "data": null } }, "NotFoundResponseExample": { "value": { "code": 404, "error": "NOT_FOUND", "data": null } }, "InternalServerErrorResponseExample": { "value": { "code": 500, "error": "INTERNAL_SERVER_ERROR", "data": null } }, "OpenLoopGetTransferResponseExample200": { "value": { "code": 200, "error": null, "data": { "from": { "orgUserId": "sherlock_holmes", "currency": "USD", "amount": 1000 }, "to": { "counterPartyId": "john_watson", "accountId": "123e4567-ea9b-12d3-a456-426614174000", "currency": "USD", "amount": 1000, "finalAmount": 1000 }, "transferId": "123e4567-ea9b-12d3-a456-426614174000", "referenceId": "REF-123456789", "status": "COMPLETED", "subStatus": "COMPLETED", "type": "WITHDRAWAL", "createdAt": "2023-10-01T00:00:00Z", "updatedAt": "2023-10-01T00:00:00Z" } } } }, "schemas": { "ErrorResponse": { "type": "object", "properties": { "code": { "type": "number", "description": "HTTP status code for the error (e.g. 400, 401, 404, 500).", "example": 400 }, "error": { "type": "string", "nullable": true, "description": "Machine-readable error code. Clients should branch on this rather than parsing the message.", "example": "INVALID_REQUEST" }, "data": { "type": "object", "nullable": true, "description": "Always null for error responses. Included for shape parity with success responses.", "example": null } }, "required": [ "code", "error", "data" ] }, "OpenLoopTransfer": { "type": "object", "anyOf": [ { "type": "object", "title": "Fiat Deposit", "properties": { "from": { "type": "object", "properties": { "counterPartyId": { "type": "string", "description": "Counterparty ID of the funds sender. The counterparty must be linked to an external fiat account.", "example": "123e4567-ea9b-12d3-a456-426614174000" }, "accountId": { "type": "string", "description": "External account ID the funds are being sent from.", "example": "b2c9a4e8-1f34-4b51-9d7e-8a5c02e14a77" }, "currency": { "type": "string", "description": "Fiat currency of the incoming deposit. The source account must support this currency.", "example": "USD" }, "amount": { "type": "number", "description": "Amount leaving the source. Provide either from.amount or to.amount, never both — the other is computed via the conversion.", "example": 1000 }, "finalAmount": { "type": "number", "description": "Amount that actually settled on the source side after any fees.", "example": 1000 } }, "required": [ "counterPartyId", "accountId", "currency", "amount", "finalAmount" ] }, "to": { "type": "object", "properties": { "orgUserId": { "type": "string", "description": "User in your organization receiving the credited balance.", "example": "sherlock_holmes" }, "currency": { "type": "string", "description": "Currency credited on the destination side. Equals from.currency when no conversion takes place.", "example": "USDT" }, "amount": { "type": "number", "description": "Amount credited on the destination. Provide either from.amount or to.amount, never both.", "example": 1000 } }, "required": [ "orgUserId", "currency", "amount" ] }, "transferId": { "type": "string", "format": "uuid", "description": "Idempotency key for the transfer. If omitted, Fuze generates one. Reuse the same UUID to safely retry a request.", "example": "123e4567-ea9b-12d3-a456-426614174000" }, "status": { "type": "string", "description": "Transfer lifecycle state. Typical values are PENDING, COMPLETED, REJECTED, and CANCELLED.", "example": "COMPLETED" }, "subStatus": { "type": "string", "nullable": true, "description": "Finer-grained state within status, explaining what the transfer is waiting on or why it ended where it did. Null when no sub-state applies.", "enum": [ "COMPLIANCE_REVIEW", "MAKER_CHECKER_APPROVAL", "FINANCE_APPROVAL", "FINANCE_TRANSFER" ], "example": "FINANCE_APPROVAL" }, "type": { "type": "string", "description": "Direction of the transfer relative to the user. DEPOSIT credits the user; WITHDRAWAL debits the user.", "enum": [ "DEPOSIT", "WITHDRAWAL" ], "example": "DEPOSIT" }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp the transfer was initiated, in ISO 8601 UTC.", "example": "2025-03-10T14:30:00Z" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Timestamp of the most recent status change, in ISO 8601 UTC.", "example": "2025-03-10T14:45:12Z" }, "referenceId": { "type": "string", "description": "End-to-end reference ID. Use this value as the bank reference when initiating the wire from the external bank so Fuze can reconcile automatically.", "example": "REF-123456789" } }, "required": [ "from", "to", "transferId", "status", "type", "createdAt", "updatedAt", "referenceId" ] }, { "type": "object", "title": "Fiat Withdrawal", "properties": { "from": { "type": "object", "properties": { "orgUserId": { "type": "string", "description": "User in your organization whose balance funds the withdrawal.", "example": "sherlock_holmes" }, "currency": { "type": "string", "description": "Currency debited from the user's balance. Equals to.currency when no conversion takes place.", "example": "USDT" }, "amount": { "type": "number", "description": "Amount debited from the user. Provide either from.amount or to.amount, never both.", "example": 1000 } }, "required": [ "orgUserId", "currency", "amount" ] }, "to": { "type": "object", "properties": { "counterPartyId": { "type": "string", "description": "Counterparty ID of the funds recipient. The counterparty must be linked to an external fiat account.", "example": "123e4567-ea9b-12d3-a456-426614174000" }, "accountId": { "type": "string", "description": "External account ID the funds are being sent to.", "example": "b2c9a4e8-1f34-4b51-9d7e-8a5c02e14a77" }, "currency": { "type": "string", "description": "Fiat currency credited to the destination account. The account must support this currency.", "example": "USD" }, "amount": { "type": "number", "description": "Amount credited on the destination. Provide either from.amount or to.amount, never both.", "example": 1000 }, "finalAmount": { "type": "number", "description": "Amount that actually settled on the destination side after fees.", "example": 998.5 } }, "required": [ "counterPartyId", "accountId", "currency", "amount", "finalAmount" ] }, "transferId": { "type": "string", "format": "uuid", "description": "Idempotency key for the transfer. If omitted, Fuze generates one. Reuse the same UUID to safely retry a request.", "example": "123e4567-ea9b-12d3-a456-426614174000" }, "status": { "type": "string", "description": "Transfer lifecycle state. Typical values are PENDING, COMPLETED, REJECTED, and CANCELLED.", "example": "COMPLETED" }, "subStatus": { "type": "string", "nullable": true, "description": "Finer-grained state within status, explaining what the transfer is waiting on or why it ended where it did. Null when no sub-state applies.", "enum": [ "COMPLIANCE_REVIEW", "MAKER_CHECKER_APPROVAL", "FINANCE_APPROVAL", "FINANCE_TRANSFER" ], "example": "FINANCE_APPROVAL" }, "type": { "type": "string", "description": "Direction of the transfer relative to the user. DEPOSIT credits the user; WITHDRAWAL debits the user.", "enum": [ "DEPOSIT", "WITHDRAWAL" ], "example": "WITHDRAWAL" }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp the transfer was initiated, in ISO 8601 UTC.", "example": "2025-03-10T14:30:00Z" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Timestamp of the most recent status change, in ISO 8601 UTC.", "example": "2025-03-10T14:45:12Z" }, "referenceId": { "type": "string", "description": "End-to-end reference ID propagated on the bank leg. Use this to reconcile against the external bank statement.", "example": "REF-123456789" } }, "required": [ "from", "to", "transferId", "status", "type", "createdAt", "updatedAt", "referenceId" ] }, { "type": "object", "title": "Crypto Deposit", "properties": { "from": { "type": "object", "properties": { "counterPartyId": { "type": "string", "description": "Counterparty ID of the sender. The counterparty must be linked to an external (whitelisted) crypto wallet.", "example": "123e4567-ea9b-12d3-a456-426614174000" }, "walletId": { "type": "string", "description": "External wallet ID the funds are being sent from.", "example": "b2c9a4e8-1f34-4b51-9d7e-8a5c02e14a77" }, "currency": { "type": "string", "description": "Crypto asset being deposited. The source wallet must support this currency.", "example": "USDT" }, "amount": { "type": "number", "description": "Amount leaving the source wallet. Provide either from.amount or to.amount, never both.", "example": 1000 }, "finalAmount": { "type": "number", "description": "Amount that actually settled on the source side after any network deductions.", "example": 1000 } }, "required": [ "counterPartyId", "walletId", "currency", "amount", "finalAmount" ] }, "to": { "type": "object", "properties": { "orgUserId": { "type": "string", "description": "User in your organization whose balance will be credited.", "example": "sherlock_holmes" }, "currency": { "type": "string", "description": "Currency credited on the destination side. Equals from.currency when no conversion takes place.", "example": "USDT" }, "amount": { "type": "number", "description": "Amount credited on the destination. Provide either from.amount or to.amount, never both.", "example": 1000 } }, "required": [ "orgUserId", "currency", "amount" ] }, "transferId": { "type": "string", "format": "uuid", "description": "Idempotency key for the transfer. If omitted, Fuze generates one. Reuse the same UUID to safely retry a request.", "example": "123e4567-ea9b-12d3-a456-426614174000" }, "status": { "type": "string", "description": "Transfer lifecycle state. Typical values are PENDING, COMPLETED, REJECTED, and CANCELLED.", "example": "COMPLETED" }, "type": { "type": "string", "description": "Direction of the transfer relative to the user. DEPOSIT credits the user; WITHDRAWAL debits the user.", "enum": [ "DEPOSIT", "WITHDRAWAL" ], "example": "DEPOSIT" }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp the transfer was initiated, in ISO 8601 UTC.", "example": "2025-03-10T14:30:00Z" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Timestamp of the most recent status change, in ISO 8601 UTC.", "example": "2025-03-10T14:45:12Z" }, "txnHash": { "type": "string", "description": "On-chain transaction hash for the deposit.", "example": "0x767ebd2ca82dcaae8b7fe4fbbe4f154230d18ec93c8294caeebccfe29d4ce030" }, "chain": { "type": "string", "description": "Blockchain the transaction was broadcast on (e.g. ETHEREUM, TRON, POLYGON, SOLANA).", "example": "ETHEREUM" } }, "required": [ "from", "to", "transferId", "status", "type", "createdAt", "updatedAt", "txnHash", "chain" ] }, { "type": "object", "title": "Crypto Withdrawal", "properties": { "from": { "type": "object", "properties": { "orgUserId": { "type": "string", "description": "User in your organization whose balance funds the withdrawal.", "example": "sherlock_holmes" }, "currency": { "type": "string", "description": "Currency debited from the user's balance. Equals to.currency when no conversion takes place.", "example": "USDT" }, "amount": { "type": "number", "description": "Amount debited from the user. Provide either from.amount or to.amount, never both.", "example": 1000 } }, "required": [ "orgUserId", "currency", "amount" ] }, "to": { "type": "object", "properties": { "counterPartyId": { "type": "string", "description": "Counterparty ID of the recipient. The counterparty must be linked to an external (whitelisted) crypto wallet.", "example": "123e4567-ea9b-12d3-a456-426614174000" }, "walletId": { "type": "string", "description": "External wallet ID the funds are being sent to.", "example": "b2c9a4e8-1f34-4b51-9d7e-8a5c02e14a77" }, "currency": { "type": "string", "description": "Crypto asset credited to the destination wallet. The wallet must support this currency.", "example": "USDT" }, "amount": { "type": "number", "description": "Amount credited on the destination. Provide either from.amount or to.amount, never both.", "example": 1000 }, "finalAmount": { "type": "number", "description": "Amount that actually arrived at the destination wallet after network and processing fees.", "example": 998.5 } }, "required": [ "counterPartyId", "walletId", "currency", "amount", "finalAmount" ] }, "transferId": { "type": "string", "format": "uuid", "description": "Idempotency key for the transfer. If omitted, Fuze generates one. Reuse the same UUID to safely retry a request.", "example": "123e4567-ea9b-12d3-a456-426614174000" }, "status": { "type": "string", "description": "Transfer lifecycle state. Typical values are PENDING, COMPLETED, REJECTED, and CANCELLED.", "example": "COMPLETED" }, "type": { "type": "string", "description": "Direction of the transfer relative to the user. DEPOSIT credits the user; WITHDRAWAL debits the user.", "enum": [ "DEPOSIT", "WITHDRAWAL" ], "example": "WITHDRAWAL" }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp the transfer was initiated, in ISO 8601 UTC.", "example": "2025-03-10T14:30:00Z" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Timestamp of the most recent status change, in ISO 8601 UTC.", "example": "2025-03-10T14:45:12Z" }, "txnHash": { "type": "string", "description": "On-chain transaction hash once the withdrawal has been broadcast.", "example": "0x767ebd2ca82dcaae8b7fe4fbbe4f154230d18ec93c8294caeebccfe29d4ce030" }, "chain": { "type": "string", "description": "Blockchain the transaction was broadcast on (e.g. ETHEREUM, TRON, POLYGON, SOLANA).", "example": "ETHEREUM" }, "gasFee": { "type": "number", "nullable": true, "description": "Gas/network fee charged for the on-chain transaction, denominated in the withdrawn asset. Null if not yet computed.", "example": 0.001 } }, "required": [ "from", "to", "transferId", "status", "type", "createdAt", "updatedAt", "txnHash", "chain" ] } ] }, "OpenLoopGetTransferRequest": { "xml": { "name": "OpenLoopGetTransferRequest" }, "type": "object", "properties": { "orgUserId": { "type": "string", "description": "User in your organization who owns the transfer.", "example": "sherlock_holmes" }, "transferId": { "type": "string", "description": "Fuze-assigned UUID of the transfer to fetch.", "example": "123e4567-ea9b-12d3-a456-426614174000" } }, "required": [ "orgUserId", "transferId" ] }, "OpenLoopGetTransferResponse": { "xml": { "name": "OpenLoopGetTransferResponse" }, "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 200 }, "error": { "type": "string", "nullable": true, "example": null }, "data": { "$ref": "#/components/schemas/OpenLoopTransfer" } }, "required": [ "code", "error", "data" ] } } }, "security": [ { "JWT": [] } ] } ```