# Crypto Addresses ## ***Coming Soon\**** ## Retrieve a customer's crypto address > Retrieve a customer's crypto address by ID and customer 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":{"WhitelistCryptoAddress":{"type":"object","required":["cryptoAddressId","clientId","customerId","status","currency","network","address","createdAt","updatedAt","sourceWalletType"],"properties":{"cryptoAddressId":{"type":"string","format":"uuid"},"clientId":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/WhitelistCryptoAddressStatus"},"currency":{"type":"string","nullable":true},"network":{"type":"string"},"address":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"vaspId":{"type":"string","format":"uuid","nullable":true},"vaspName":{"type":"string","nullable":true},"vaspWebsite":{"type":"string","format":"uri","nullable":true},"sourceWalletType":{"$ref":"#/components/schemas/SourceWalletType"},"customerReference":{"type":"string","nullable":true,"maxLength":256}}},"WhitelistCryptoAddressStatus":{"type":"string","enum":["ACTIVE","INACTIVE","REMOVED"]},"SourceWalletType":{"type":"string","enum":["VASP","SELF_HOSTED","OTHER_VASP"]}}},"paths":{"/v1/customers/{customerId}/crypto-addresses/{cryptoAddressId}":{"get":{"summary":"Retrieve a customer's crypto address","description":"Retrieve a customer's crypto address by ID and customer ID","tags":["Customers"],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"The ID of the customer"},{"name":"cryptoAddressId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"The ID of the crypto address to retrieve"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhitelistCryptoAddress"}}}}}}}}} ``` ## List customer's crypto addresses > List crypto addresses for a customer by customer ID and optional filters ```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":{"WhitelistCryptoAddressStatus":{"type":"string","enum":["ACTIVE","INACTIVE","REMOVED"]},"SortDirection":{"type":"string","enum":["ASC","DESC"]},"PaginatedWhitelistedCryptoAddresses":{"type":"object","required":["items","totalCount","after"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/WhitelistCryptoAddress"}},"after":{"type":"string","nullable":true,"format":"uuid","description":"The token of the last item in the response"},"totalCount":{"type":"string","format":"integer","description":"The total number of items in the entire filtered data set"}}},"WhitelistCryptoAddress":{"type":"object","required":["cryptoAddressId","clientId","customerId","status","currency","network","address","createdAt","updatedAt","sourceWalletType"],"properties":{"cryptoAddressId":{"type":"string","format":"uuid"},"clientId":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/WhitelistCryptoAddressStatus"},"currency":{"type":"string","nullable":true},"network":{"type":"string"},"address":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"vaspId":{"type":"string","format":"uuid","nullable":true},"vaspName":{"type":"string","nullable":true},"vaspWebsite":{"type":"string","format":"uri","nullable":true},"sourceWalletType":{"$ref":"#/components/schemas/SourceWalletType"},"customerReference":{"type":"string","nullable":true,"maxLength":256}}},"SourceWalletType":{"type":"string","enum":["VASP","SELF_HOSTED","OTHER_VASP"]}}},"paths":{"/v1/customers/{customerId}/crypto-addresses":{"get":{"summary":"List customer's crypto addresses","description":"List crypto addresses for a customer by customer ID and optional filters","tags":["Customers"],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"The ID of the customer"},{"name":"currency","in":"query","required":false,"schema":{"type":"string"},"description":"Filter by currency"},{"name":"network","in":"query","required":false,"schema":{"type":"string"},"description":"Filter by network"},{"name":"address","in":"query","required":false,"schema":{"type":"string"},"description":"Filter by address"},{"name":"customerReference","in":"query","required":false,"schema":{"type":"string"},"description":"Filter by customer reference"},{"name":"status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WhitelistCryptoAddressStatus"},"description":"Filter by status"},{"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":"sortField","in":"query","required":false,"schema":{"type":"string","enum":["createdAt","status"]},"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":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedWhitelistedCryptoAddresses"}}}}}}}}} ``` ## Add a crypto address for a customer > Add a crypto address for a customer ```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":{"SourceWalletType":{"type":"string","enum":["VASP","SELF_HOSTED","OTHER_VASP"]},"WhitelistCryptoAddressStatus":{"type":"string","enum":["ACTIVE","INACTIVE","REMOVED"]}},"responses":{"400":{"description":"Validation Error"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient Privileges"},"4XX":{"description":"Client error"},"5XX":{"description":"Server error"}}},"paths":{"/v1/customers/{customerId}/crypto-addresses":{"post":{"summary":"Add a crypto address for a customer","description":"Add a crypto address for a customer","tags":["Customers"],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"The customer ID of the customer"}],"requestBody":{"content":{"application/json":{"schema":{"required":["network","address","sourceWalletType"],"type":"object","properties":{"currency":{"type":"string","description":"Crypto currency (e.g. \"BTC\"). If omitted, the address applies to all currencies supported on the specified network."},"network":{"type":"string"},"address":{"type":"string"},"vaspId":{"type":"string","format":"uuid","description":"Required if sourceWalletType is VASP. Needs to be a valid vaspId from the following API https://docs.aquanow.io/pay/api-endpoints/wallet-types-api"},"vaspName":{"type":"string","description":"Required if sourceWalletType is OTHER_VASP, otherwise must be omitted"},"vaspWebsite":{"type":"string","format":"uri","description":"Optional if sourceWalletType is OTHER_VASP, otherwise must be omitted"},"sourceWalletType":{"$ref":"#/components/schemas/SourceWalletType"},"customerReference":{"type":"string","maxLength":256}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["cryptoAddressId","customerId","status"],"properties":{"cryptoAddressId":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/WhitelistCryptoAddressStatus"}}}}}},"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":"WhitelistCryptoAddress"}}}} ``` ## Remove a customer's crypto address > Remove a customer's crypto address by 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"}}},"paths":{"/v1/customers/{customerId}/crypto-addresses/{cryptoAddressId}":{"delete":{"summary":"Remove a customer's crypto address","description":"Remove a customer's crypto address by ID","tags":["Customers"],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"The ID of the customer"},{"name":"cryptoAddressId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"The ID of the crypto address to remove"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["cryptoAddressId","customerId","status"],"properties":{"cryptoAddressId":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["REMOVED"]}}}}}}}}}}} ```