# Funding Requests ## ***Coming Soon\**** ## Get Funding Request > Retrieve a funding request 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://camsapi-dev.aquanow.com/api","description":"dev"},{"url":"https://camsapi-staging.aquanow.com/api","description":"staging"},{"url":"https://cams.cert.aquanow.com/api","description":"cert"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer"}},"schemas":{"FundingRequest":{"type":"object","required":["customerReference","customerAccountId","feePaidBy","fundingRequestId","fundingInstructions","status","conversionRate","beneficiaryAccountId","beneficiaryCurrency","createdAt"],"properties":{"customerReference":{"type":"string","maxLength":256},"customerAccountId":{"type":"string","format":"uuid"},"feePaidBy":{"$ref":"#/components/schemas/FeePaidBy"},"fundingRequestId":{"type":"string","format":"uuid"},"fundingInstructions":{"$ref":"#/components/schemas/FundingInstructions"},"status":{"$ref":"#/components/schemas/FundingRequestStatus"},"conversionRate":{"type":"string","format":"number"},"beneficiaryAccountId":{"type":"string","format":"uuid"},"beneficiaryCurrency":{"type":"string"},"expiresAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"}}},"FeePaidBy":{"type":"string","enum":["MERCHANT"]},"FundingInstructions":{"type":"object","required":["address","fundingCurrency","network"],"properties":{"address":{"type":"string","description":"The deposit address for funding"},"fundingCurrency":{"type":"string"},"network":{"type":"string","description":"The blockchain network"}}},"FundingRequestStatus":{"type":"string","enum":["ACTIVE","FAILED","EXPIRED","REMOVED"]}},"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/funding-request/{fundingRequestId}":{"get":{"summary":"Get Funding Request","description":"Retrieve a funding request by its ID.","tags":["Funding Requests"],"parameters":[{"name":"fundingRequestId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"The funding request ID"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundingRequest"}}}},"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":"GetFundingRequestById"}}}} ``` ## List Funding Requests > Retrieve a list of funding requests 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://camsapi-dev.aquanow.com/api","description":"dev"},{"url":"https://camsapi-staging.aquanow.com/api","description":"staging"},{"url":"https://cams.cert.aquanow.com/api","description":"cert"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer"}},"schemas":{"FundingRequestStatus":{"type":"string","enum":["ACTIVE","FAILED","EXPIRED","REMOVED"]},"SortDirection":{"type":"string","enum":["ASC","DESC"]},"FundingRequest":{"type":"object","required":["customerReference","customerAccountId","feePaidBy","fundingRequestId","fundingInstructions","status","conversionRate","beneficiaryAccountId","beneficiaryCurrency","createdAt"],"properties":{"customerReference":{"type":"string","maxLength":256},"customerAccountId":{"type":"string","format":"uuid"},"feePaidBy":{"$ref":"#/components/schemas/FeePaidBy"},"fundingRequestId":{"type":"string","format":"uuid"},"fundingInstructions":{"$ref":"#/components/schemas/FundingInstructions"},"status":{"$ref":"#/components/schemas/FundingRequestStatus"},"conversionRate":{"type":"string","format":"number"},"beneficiaryAccountId":{"type":"string","format":"uuid"},"beneficiaryCurrency":{"type":"string"},"expiresAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"}}},"FeePaidBy":{"type":"string","enum":["MERCHANT"]},"FundingInstructions":{"type":"object","required":["address","fundingCurrency","network"],"properties":{"address":{"type":"string","description":"The deposit address for funding"},"fundingCurrency":{"type":"string"},"network":{"type":"string","description":"The blockchain network"}}}},"responses":{"400":{"description":"Validation Error"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient Privileges"},"4XX":{"description":"Client error"},"5XX":{"description":"Server error"}}},"paths":{"/v1/funding-request":{"get":{"summary":"List Funding Requests","description":"Retrieve a list of funding requests with optional filtering and pagination.","tags":["Funding Requests"],"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":"fundingRequestId","in":"query","schema":{"type":"string","format":"uuid"},"description":"Filter by funding request ID"},{"name":"customerAccountId","in":"query","schema":{"type":"string","format":"uuid"},"description":"Filter by customer account ID"},{"name":"beneficiaryAccountId","in":"query","schema":{"type":"string","format":"uuid"},"description":"Filter by beneficiary account ID"},{"name":"beneficiaryCurrency","in":"query","schema":{"type":"string","enum":["AED"]},"description":"Filter by beneficiary currency"},{"name":"fundingCurrency","in":"query","schema":{"type":"string","enum":["USDC","USDT"]},"description":"Filter by funding currency"},{"name":"network","in":"query","schema":{"type":"string"},"description":"Filter by network"},{"name":"status","in":"query","schema":{"$ref":"#/components/schemas/FundingRequestStatus"},"description":"Filter by status"},{"name":"createdAtStart","in":"query","schema":{"type":"string","format":"date-time"},"description":"Filter by creation date lower bound, exclusive"},{"name":"createdAtEnd","in":"query","schema":{"type":"string","format":"date-time"},"description":"Filter by creation date upper bound, inclusive"},{"name":"expiresAtStart","in":"query","schema":{"type":"string","format":"date-time"},"description":"Filter by expiration date lower bound, exclusive"},{"name":"expiresAtEnd","in":"query","schema":{"type":"string","format":"date-time"},"description":"Filter by expiration date upper bound, inclusive"},{"name":"customerReference","in":"query","schema":{"type":"string"},"description":"Filter by customer reference"},{"name":"sortField","in":"query","required":false,"schema":{"type":"string","enum":["status","createdAt"]},"description":"Will sort the returned data using the specified field."},{"name":"sortDirection","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortDirection"},"description":"Specifies the sort direction for the sortField."}],"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/FundingRequest"}}}}}}},"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":"ListFundingRequests"}}}} ``` ## Create Funding Request > Create a new funding request to obtain deposit instructions for funding an account. ```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://camsapi-dev.aquanow.com/api","description":"dev"},{"url":"https://camsapi-staging.aquanow.com/api","description":"staging"},{"url":"https://cams.cert.aquanow.com/api","description":"cert"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer"}},"schemas":{"CreateFundingRequestInput":{"type":"object","required":["customerAccountId","fundingCurrency","network","feePaidBy","beneficiaryAccountId","beneficiaryCurrency","customerReference"],"properties":{"customerAccountId":{"type":"string","format":"uuid"},"fundingCurrency":{"type":"string","enum":["USDC","USDT"]},"network":{"type":"string","maxLength":32,"enum":["ETH","TRX"],"description":"The blockchain network. USDT is supported by both ETH and TRX. USDC is supported by ETH only."},"beneficiaryAccountId":{"type":"string","maxLength":256,"format":"uuid"},"beneficiaryCurrency":{"type":"string","enum":["AED"]},"feePaidBy":{"$ref":"#/components/schemas/FeePaidBy"},"customerReference":{"type":"string","maxLength":256}}},"FeePaidBy":{"type":"string","enum":["MERCHANT"]},"FundingRequest":{"type":"object","required":["customerReference","customerAccountId","feePaidBy","fundingRequestId","fundingInstructions","status","conversionRate","beneficiaryAccountId","beneficiaryCurrency","createdAt"],"properties":{"customerReference":{"type":"string","maxLength":256},"customerAccountId":{"type":"string","format":"uuid"},"feePaidBy":{"$ref":"#/components/schemas/FeePaidBy"},"fundingRequestId":{"type":"string","format":"uuid"},"fundingInstructions":{"$ref":"#/components/schemas/FundingInstructions"},"status":{"$ref":"#/components/schemas/FundingRequestStatus"},"conversionRate":{"type":"string","format":"number"},"beneficiaryAccountId":{"type":"string","format":"uuid"},"beneficiaryCurrency":{"type":"string"},"expiresAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"}}},"FundingInstructions":{"type":"object","required":["address","fundingCurrency","network"],"properties":{"address":{"type":"string","description":"The deposit address for funding"},"fundingCurrency":{"type":"string"},"network":{"type":"string","description":"The blockchain network"}}},"FundingRequestStatus":{"type":"string","enum":["ACTIVE","FAILED","EXPIRED","REMOVED"]}},"responses":{"400":{"description":"Validation Error"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient Privileges"},"4XX":{"description":"Client error"},"5XX":{"description":"Server error"}}},"paths":{"/v1/funding-request":{"post":{"summary":"Create Funding Request","description":"Create a new funding request to obtain deposit instructions for funding an account.","tags":["Funding Requests"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFundingRequestInput"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundingRequest"}}}},"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":"CreateFundingRequest"}}}} ``` ## Remove Funding Request > Remove a funding request 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://camsapi-dev.aquanow.com/api","description":"dev"},{"url":"https://camsapi-staging.aquanow.com/api","description":"staging"},{"url":"https://cams.cert.aquanow.com/api","description":"cert"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer"}},"schemas":{"FundingRequest":{"type":"object","required":["customerReference","customerAccountId","feePaidBy","fundingRequestId","fundingInstructions","status","conversionRate","beneficiaryAccountId","beneficiaryCurrency","createdAt"],"properties":{"customerReference":{"type":"string","maxLength":256},"customerAccountId":{"type":"string","format":"uuid"},"feePaidBy":{"$ref":"#/components/schemas/FeePaidBy"},"fundingRequestId":{"type":"string","format":"uuid"},"fundingInstructions":{"$ref":"#/components/schemas/FundingInstructions"},"status":{"$ref":"#/components/schemas/FundingRequestStatus"},"conversionRate":{"type":"string","format":"number"},"beneficiaryAccountId":{"type":"string","format":"uuid"},"beneficiaryCurrency":{"type":"string"},"expiresAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"}}},"FeePaidBy":{"type":"string","enum":["MERCHANT"]},"FundingInstructions":{"type":"object","required":["address","fundingCurrency","network"],"properties":{"address":{"type":"string","description":"The deposit address for funding"},"fundingCurrency":{"type":"string"},"network":{"type":"string","description":"The blockchain network"}}},"FundingRequestStatus":{"type":"string","enum":["ACTIVE","FAILED","EXPIRED","REMOVED"]}},"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/funding-request/{fundingRequestId}":{"delete":{"summary":"Remove Funding Request","description":"Remove a funding request by its ID.","tags":["Funding Requests"],"parameters":[{"name":"fundingRequestId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"The funding request ID"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundingRequest"}}}},"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":"RemoveFundingRequest"}}}} ```