# Transfers ## ***Coming Soon\**** ## Transfers > Retrieve a list of transfers with optional filtering and pagination. ```json {"openapi":"3.0.3","info":{"title":"Aquanow CAMS REST API","version":"1.0"},"servers":[{"url":"https://cams.aquanow.com/api","description":"production"},{"url":"http://localhost:3001/api","description":"local"},{"url":"https://cams.dev.aquanow.com/api","description":"dev"},{"url":"https://cams.staging.aquanow.com/api","description":"staging"},{"url":"https://cams.cert.aquanow.com/api","description":"cert"},{"url":"https://marketdata.aquanow.com","description":"production market data"},{"url":"https://marketdata.staging.aquanow.com","description":"staging market data"},{"url":"https://marketdata.dev.aquanow.com","description":"dev market data"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer"}},"schemas":{"TransferStatus":{"type":"string","enum":["PROCESSING","COMPLETED","FAILED"]},"TransferRequest":{"type":"object","required":["sourceAccountId","sourceCustomerId","beneficiaryAccountId","beneficiaryCustomerId","transferQuantity","transferCurrency","status","requestedAt"],"properties":{"sourceAccountId":{"type":"string","maxLength":256},"sourceCustomerId":{"type":"string","format":"uuid"},"beneficiaryAccountId":{"type":"string","format":"uuid"},"beneficiaryCustomerId":{"type":"string","format":"uuid"},"transferQuantity":{"type":"string","format":"number"},"transferCurrency":{"type":"string"},"status":{"$ref":"#/components/schemas/TransferStatus"},"requestedAt":{"type":"string","format":"date-time"}}}},"responses":{"400":{"description":"Validation Error"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient Privileges"},"4XX":{"description":"Client error"},"5XX":{"description":"Server error"}}},"paths":{"/v1/transfers":{"get":{"summary":"Transfers","description":"Retrieve a list of transfers with optional filtering and pagination.","tags":["Transfers"],"parameters":[{"name":"after","in":"query","required":false,"schema":{"type":"string"},"description":"When provided, specifies the last item returned in previous page, used to fetch the next page. Fetches the first page when omitted."},{"name":"limit","in":"query","required":false,"schema":{"type":"string","format":"integer"},"description":"When provided, specifies the number of items to return in the page. Uses default page size of 10 when omitted."},{"name":"transferId","in":"query","schema":{"type":"string","format":"uuid"},"description":"Filter by transfer ID"},{"name":"sourceAccountId","in":"query","schema":{"type":"string","format":"uuid"},"description":"Filter by source account ID"},{"name":"sourceCustomerId","in":"query","schema":{"type":"string","format":"uuid"},"description":"Filter by source customer ID"},{"name":"beneficiaryAccountId","in":"query","schema":{"type":"string","format":"uuid"},"description":"Filter by destination account id"},{"name":"beneficiaryCustomerId","in":"query","schema":{"type":"string","format":"uuid"},"description":"Filter by destination customer id"},{"name":"transferCurrency","in":"query","schema":{"type":"string"},"description":"Filter by transfer currency"},{"name":"status","in":"query","schema":{"$ref":"#/components/schemas/TransferStatus"},"description":"Filter by status"},{"name":"requestedAt","in":"query","schema":{"type":"string","format":"date-time"},"description":"Filter by request date lower bound, exclusive"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"after":{"type":"string","description":"The token of the last item in the response","nullable":true},"totalCount":{"type":"string","format":"integer","description":"The total number of items in the entire filtered data set"},"items":{"type":"array","items":{"$ref":"#/components/schemas/TransferRequest"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"4XX":{"$ref":"#/components/responses/4XX"},"5XX":{"$ref":"#/components/responses/5XX"}},"operationId":"ListTransfers"}}}} ``` ## Get transfer > Retrieve a transfer by its ID. ```json {"openapi":"3.0.3","info":{"title":"Aquanow CAMS REST API","version":"1.0"},"servers":[{"url":"https://cams.aquanow.com/api","description":"production"},{"url":"http://localhost:3001/api","description":"local"},{"url":"https://cams.dev.aquanow.com/api","description":"dev"},{"url":"https://cams.staging.aquanow.com/api","description":"staging"},{"url":"https://cams.cert.aquanow.com/api","description":"cert"},{"url":"https://marketdata.aquanow.com","description":"production market data"},{"url":"https://marketdata.staging.aquanow.com","description":"staging market data"},{"url":"https://marketdata.dev.aquanow.com","description":"dev market data"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer"}},"schemas":{"TransferRequest":{"type":"object","required":["sourceAccountId","sourceCustomerId","beneficiaryAccountId","beneficiaryCustomerId","transferQuantity","transferCurrency","status","requestedAt"],"properties":{"sourceAccountId":{"type":"string","maxLength":256},"sourceCustomerId":{"type":"string","format":"uuid"},"beneficiaryAccountId":{"type":"string","format":"uuid"},"beneficiaryCustomerId":{"type":"string","format":"uuid"},"transferQuantity":{"type":"string","format":"number"},"transferCurrency":{"type":"string"},"status":{"$ref":"#/components/schemas/TransferStatus"},"requestedAt":{"type":"string","format":"date-time"}}},"TransferStatus":{"type":"string","enum":["PROCESSING","COMPLETED","FAILED"]}},"responses":{"400":{"description":"Validation Error"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient Privileges"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"properties":{"id":{"type":"string"}}}}}},"4XX":{"description":"Client error"},"5XX":{"description":"Server error"}}},"paths":{"/v1/transfers/{transferId}":{"get":{"summary":"Get transfer","description":"Retrieve a transfer by its ID.","tags":["Transfers"],"parameters":[{"name":"transferId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"The transfer ID"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferRequest"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"4XX":{"$ref":"#/components/responses/4XX"},"5XX":{"$ref":"#/components/responses/5XX"}},"operationId":"GetRansferById"}}}} ``` ## Create Transfer > Transfer funds between accounts. ```json {"openapi":"3.0.3","info":{"title":"Aquanow CAMS REST API","version":"1.0"},"servers":[{"url":"https://cams.aquanow.com/api","description":"production"},{"url":"http://localhost:3001/api","description":"local"},{"url":"https://cams.dev.aquanow.com/api","description":"dev"},{"url":"https://cams.staging.aquanow.com/api","description":"staging"},{"url":"https://cams.cert.aquanow.com/api","description":"cert"},{"url":"https://marketdata.aquanow.com","description":"production market data"},{"url":"https://marketdata.staging.aquanow.com","description":"staging market data"},{"url":"https://marketdata.dev.aquanow.com","description":"dev market data"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer"}},"schemas":{"CreateTransferInput":{"type":"object","required":["sourceAccountId","sourceCustomerId","beneficiaryAccountId","beneficiaryCustomerId","transferQuantity","transferCurrency"],"properties":{"sourceAccountId":{"type":"string","maxLength":256},"sourceCustomerId":{"type":"string","format":"uuid"},"beneficiaryAccountId":{"type":"string","format":"uuid"},"beneficiaryId":{"type":"string","format":"uuid"},"transferQuantity":{"type":"string","format":"number"},"transferCurrency":{"type":"string"}}},"TransferRequest":{"type":"object","required":["sourceAccountId","sourceCustomerId","beneficiaryAccountId","beneficiaryCustomerId","transferQuantity","transferCurrency","status","requestedAt"],"properties":{"sourceAccountId":{"type":"string","maxLength":256},"sourceCustomerId":{"type":"string","format":"uuid"},"beneficiaryAccountId":{"type":"string","format":"uuid"},"beneficiaryCustomerId":{"type":"string","format":"uuid"},"transferQuantity":{"type":"string","format":"number"},"transferCurrency":{"type":"string"},"status":{"$ref":"#/components/schemas/TransferStatus"},"requestedAt":{"type":"string","format":"date-time"}}},"TransferStatus":{"type":"string","enum":["PROCESSING","COMPLETED","FAILED"]}},"responses":{"400":{"description":"Validation Error"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient Privileges"},"4XX":{"description":"Client error"},"5XX":{"description":"Server error"}}},"paths":{"/v1/transfers":{"post":{"summary":"Create Transfer","description":"Transfer funds between accounts.","tags":["Transfers"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTransferInput"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferRequest"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"4XX":{"$ref":"#/components/responses/4XX"},"5XX":{"$ref":"#/components/responses/5XX"}},"operationId":"CreateTransfer"}}}} ```