{"openapi":"3.1.0","info":{"title":"Deposit API","description":"Facilitates the transfer (on-ramp) of funds into the CFX network.","termsOfService":"http://cfxlabs.com/terms/","contact":{"name":"API Owner","url":"api.cfxlabs.net","email":"api@cfxlabs.com"},"license":{"name":"Licence tbd","url":"http://tbd.html"},"version":"@VERSION@","summary":"CFX Deposit API"},"components":{"securitySchemes":{"ApiKeyAuth":{"name":"x-api-key","type":"apiKey","in":"header"},"ApiSecretAuth":{"name":"x-api-secret","type":"apiKey","in":"header"}},"schemas":{}},"paths":{"/v1/deposit/cash/retailer":{"get":{"summary":"Get Cash Deposit Retailers","tags":["Cash"],"description":"Retrieve the list of retailers within the CFX Network that will accept cash deposits.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["results"],"properties":{"results":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"Unique identifier for a CFX Network retailer","example":"10831"},"name":{"type":"string","description":"Name of the CFX Network retailer","example":"Walgreens"},"enabled":{"type":"boolean","description":"Flag indicating whether the retailer is currently enabled"},"slug":{"type":"string","description":"URL slug for the CFX Network retailer","example":"walmart"},"providerName":{"type":"string","description":"Short name associated with the CFX Network retailer"},"providerDescription":{"type":"string","description":"Description of the CFX Network retailer"}}}}}}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/deposit/cash/location":{"get":{"summary":"Search Cash Deposit Locations","tags":["Cash"],"description":"Search for nearest cash deposit locations based on a provided zipcode or latitude and longitude pair.\n\nThis endpoint will expect either a single zipcode query parameter or both the latitude and longitude parameters to be populated.","parameters":[{"schema":{"type":"string"},"example":"43212","in":"query","name":"zipcode","required":true,"description":"Zipcode for a physical CFX Network location"},{"schema":{"type":"string"},"example":"39.98814300","in":"query","name":"latitude","required":true,"description":"Latitude of the retailer location"},{"schema":{"type":"string"},"example":"-83.04643600","in":"query","name":"longitude","required":true,"description":"Longitude of the retailer location"},{"schema":{"type":"number"},"example":1,"in":"query","name":"page","required":false,"description":"Page Number, (defaults to 1)"},{"schema":{"type":"number"},"example":50,"in":"query","name":"pageSize","required":false,"description":"Page Size, (defaults to the max of 50)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["page","pageSize","results"],"properties":{"page":{"type":"number"},"pageSize":{"type":"number"},"results":{"type":"array","items":{"type":"object","required":["zipcode","latitude","longitude","city","state","address","phone","retailerName","retailerId","locationId"],"properties":{"zipcode":{"type":"string","description":"Zipcode for a physical CFX Network location","example":"43212"},"latitude":{"type":"string","description":"Latitude of the retailer location","example":"39.98814300"},"longitude":{"type":"string","description":"Longitude of the retailer location","example":"-83.04643600"},"city":{"type":"string","description":"City of the retailer location","example":"Columbus"},"state":{"type":"string","description":"State of the retailer","example":"OH"},"address":{"type":"string","description":"Address of the retailer","example":"1495 W 5th Ave"},"phone":{"type":"string","description":"Phone number of the retailer","example":"+1144867159"},"retailerName":{"type":"string","description":"Retailer name","example":"CVS"},"retailerId":{"type":"string","description":"Unique ID for the retailer","example":"10831"},"locationId":{"type":"string","description":"Unique ID for the retailer location","example":"CVS6147"}}}}}}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/deposit/cash":{"get":{"summary":"Search Cash Deposit Request","tags":["Cash"],"description":"Search cash deposits requests for a given `identityId`.\nThe `identityId` query parameter is mandatory. Deposits can be further filtered by populating the `status` and `reference` parameters.\n\nNote that cash deposits requests will result in the creation of a Deposit once the user has presented the barcode and successfully made payment at a retailer.","parameters":[{"schema":{"type":"string"},"example":"id_VfsdSMtd8UdgxCgTnz0tm","in":"query","name":"identityId","required":true,"description":"Filter by Identity ID"},{"schema":{"type":"string"},"in":"query","name":"reference","required":false,"description":"Filter by reference"},{"schema":{"type":"string"},"examples":{"CREATED":{"value":"CREATED"},"CREATED,PENDING":{"value":"CREATED,PENDING"}},"in":"query","name":"status","required":false,"description":"Filter by status"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["results"],"properties":{"results":{"type":"array","items":{"type":"object","required":["reference","wallet","updatedAt","createdAt","identityId","expiresAt","barcodeNumber","retailerId","retailerName","status","id"],"properties":{"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","example":"DR-123456789"},"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"depositId":{"type":"string","description":"Unique identifier of the associated Deposit"},"deviceIpAddress":{"type":"string","description":"IP address of the device creating the deposit request","example":"123.123.123.123"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","enum":["ip"],"example":"ip"},"lat":{"type":"number","description":"Latitude of the device","example":37.851},"long":{"type":"number","description":"Longitude of the device","example":-96.822}},"description":"Location of the device submitting transacting with the CFX network"},"updatedAt":{"type":"string","description":"Datetime the deposit request was last updated","example":"2023-10-23T06:20:04.366+00:00"},"createdAt":{"type":"string","description":"Datetime the deposit request was created","example":"2023-10-23T06:20:04.366+00:00"},"identityId":{"type":"string","description":"Identity ID associated with the deposit request","example":"id_VfsdSMtd8UdgxCgTnz0tm"},"quote":{"type":"object","required":["amountIn","amountOut","fees"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}},"description":"Quote for the deposit"},"expiresAt":{"type":"string","description":"Datetime the cash deposit barcode will expire","example":"2023-10-23T06:20:04.366+00:00"},"barcodeNumber":{"type":"string","description":"Barcode number for the cash deposit","example":"830324006611181360006329048375"},"retailerId":{"type":"string","description":"Unique ID for the retailer","example":"10831"},"retailerName":{"type":"string","description":"Name of the cash deposit retailer","example":"Walgreens"},"status":{"type":"string","enum":["CREATED","PENDING","EXPIRED","CANCELLED","CONSUMED","VOIDED","DECLINED"]},"metadata":{"type":"object","additionalProperties":{}},"id":{"type":"string","description":"Unique identifier for a deposit request, can be either the request id or the deposit id","example":"dprq_FiZcY1MGfgB4XjIWsKgtT"}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_STATUS"]},"message":{"type":"string"}},"title":"INVALID_STATUS","description":"An invalid status value was provided as a query parameter"}]}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}},"post":{"summary":"Create Cash Deposit Request","tags":["Cash"],"description":"Create a cash deposit request to enable a nominated identity to subsequently deposit cash at a specified retailer.\n\nThis endpoint triggers a workflow which orchestrates the deposit of funds at a nominated retailer. To initiate the workflow this endpoint requires:\n\n- `retailerId` of the retailer where the deposit will be made.\n- `identityId` of the end user making the deposit.\n- A `wallet` specifying the blockchain address where deposited funds will be transferred.\n- A `deviceLocation` with the user's latitude and longitude coordinates.\n\nOptionally, an `amount` (source currency) or `amountOut` (target currency) can be specified to lock the deposit to a specific value. If neither is provided, the POS will accept any amount. Only one of `amount` or `amountOut` may be specified.\n\nA `targetCurrency` can also be provided to select the desired output currency (defaults to MOVEUSD).\n\nThe endpoint will return generated deposit request details with a `barcodeNumber` which can then be rendered and presented by the user at the retailer. This barcode will allow the retailer to correlate the user's visit with the registered cash deposit. When notification of a successful payment arrives from the retailer, a Deposit entry is created within our systems.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["identityId","user","reference","wallet","deviceLocation","retailerId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","example":"id_VfsdSMtd8UdgxCgTnz0tm"},"user":{"allOf":[{"type":"object","required":["firstName","lastName"],"properties":{"firstName":{"type":"string","description":"Identity first name","examples":["Robert"]},"lastName":{"type":"string","description":"Identity last name","examples":["Smith"]},"address":{"type":"string"}}},{"type":"object","properties":{"zipcode":{"type":"string"}}}]},"amount":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","description":"Amount of the nominated currency","enum":["USD"]}},"description":"Amount of the deposit. If this is specified the POS will reject any amount that does not match this value, if not specified the POS will accept any amount, and the amount will be resolved at the time of deposit"},"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"The amount out of the deposit. If this is specified then the quote returned will factor in all fees and the amount out will be the amount the user receives. The same considerations for the amount field apply here"},"targetCurrency":{"type":"string","enum":["MOVEUSD","USDC"],"default":"MOVEUSD","description":"The desired currency to receive in the provided wallet"},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","example":"DR-123456789"},"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"deviceIpAddress":{"type":"string","description":"IP address of the device creating the deposit request","example":"123.123.123.123"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","enum":["ip"],"example":"ip"},"lat":{"type":"number","description":"Latitude of the device","example":37.851},"long":{"type":"number","description":"Longitude of the device","example":-96.822}}},"retailerId":{"type":"string","description":"Unique ID for the retailer","example":"10831"},"metadata":{"type":"object","additionalProperties":{}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Idempotency-Key","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["reference","wallet","updatedAt","createdAt","identityId","expiresAt","barcodeNumber","retailerId","retailerName","status","id"],"properties":{"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","example":"DR-123456789"},"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"depositId":{"type":"string","description":"Unique identifier of the associated Deposit"},"deviceIpAddress":{"type":"string","description":"IP address of the device creating the deposit request","example":"123.123.123.123"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","enum":["ip"],"example":"ip"},"lat":{"type":"number","description":"Latitude of the device","example":37.851},"long":{"type":"number","description":"Longitude of the device","example":-96.822}},"description":"Location of the device submitting transacting with the CFX network"},"updatedAt":{"type":"string","description":"Datetime the deposit request was last updated","example":"2023-10-23T06:20:04.366+00:00"},"createdAt":{"type":"string","description":"Datetime the deposit request was created","example":"2023-10-23T06:20:04.366+00:00"},"identityId":{"type":"string","description":"Identity ID associated with the deposit request","example":"id_VfsdSMtd8UdgxCgTnz0tm"},"quote":{"type":"object","required":["amountIn","amountOut","fees"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}},"description":"Quote for the deposit"},"expiresAt":{"type":"string","description":"Datetime the cash deposit barcode will expire","example":"2023-10-23T06:20:04.366+00:00"},"barcodeNumber":{"type":"string","description":"Barcode number for the cash deposit","example":"830324006611181360006329048375"},"retailerId":{"type":"string","description":"Unique ID for the retailer","example":"10831"},"retailerName":{"type":"string","description":"Name of the cash deposit retailer","example":"Walgreens"},"status":{"type":"string","enum":["CREATED","PENDING","EXPIRED","CANCELLED","CONSUMED","VOIDED","DECLINED"]},"metadata":{"type":"object","additionalProperties":{}},"id":{"type":"string","description":"Unique identifier for a deposit request, can be either the request id or the deposit id","example":"dprq_FiZcY1MGfgB4XjIWsKgtT"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["MISSING_IDEMPOTENCY_KEY"]},"message":{"type":"string"}},"title":"MISSING_IDEMPOTENCY_KEY","description":"Missing required idempotency key header"},{"anyOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_AMOUNT"]},"message":{"type":"string"}},"title":"INVALID_AMOUNT","description":"Only one of amount or amountOut can be provided, not both"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_LOCATION"]},"message":{"type":"string"}},"title":"INVALID_LOCATION","description":"Could not determine zipcode from the provided deviceLocation, or the resolved location is outside the US"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_ENTITY_ID"]},"message":{"type":"string"}},"title":"INVALID_ENTITY_ID","description":"Active Identity not found for the provided entity ID"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNSUPPORTED_PHONE_COUNTRY"]},"message":{"type":"string"}},"title":"UNSUPPORTED_PHONE_COUNTRY","description":"Only US phone numbers are supported"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["PRODUCT_BLOCKED"]},"message":{"type":"string"}},"title":"PRODUCT_BLOCKED","description":"The cash deposit product is blocked for this entity"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["PRODUCT_INACTIVE"]},"message":{"type":"string"}},"title":"PRODUCT_INACTIVE","description":"The cash deposit product is not active for this entity"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["ENTITY_NOT_FOUND"]},"message":{"type":"string"}},"title":"ENTITY_NOT_FOUND","description":"The entity was not found"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["LIMIT_EXCEEDED"]},"message":{"type":"string"}},"title":"LIMIT_EXCEEDED","description":"The deposit amount exceeds the configured transaction or periodic limit"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["NO_COUNTRY"]},"message":{"type":"string"}},"title":"NO_COUNTRY","description":"Could not determine the country for the provided entity"}]}]}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"409":{"description":"A duplicate request with this idempotency key is already in progress","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["IDEMPOTENCY_IN_PROGRESS"]},"message":{"type":"string"}},"title":"IDEMPOTENCY_IN_PROGRESS","description":"A duplicate request with this idempotency key is already in progress"}}}},"422":{"description":"Another request with this idempotency key was made using a different body","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},"message":{"type":"string"}},"title":"IDEMPOTENCY_KEY_REUSED","description":"Another request with this idempotency key was made using a different body"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/deposit/cash/{id}":{"get":{"summary":"Get Cash Deposit Request","tags":["Cash"],"description":"Retrieve a previously submitted cash deposit request.","parameters":[{"schema":{"type":"string"},"example":"dprq_FiZcY1MGfgB4XjIWsKgtT","in":"path","name":"id","required":true,"description":"Unique identifier for a deposit request, can be either the request id or the deposit id"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["id","reference","wallet","updatedAt","createdAt"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request, can be either the request id or the deposit id","examples":["dprq_FiZcY1MGfgB4XjIWsKgtT"]},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"depositId":{"type":"string","description":"Unique identifier of the associated Deposit"},"deviceIpAddress":{"type":"string","description":"IP address of the device creating the deposit request","examples":["123.123.123.123"]},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"},"updatedAt":{"type":"string","description":"Datetime the deposit request was last updated","examples":["2023-10-23T06:20:04.366+00:00"]},"createdAt":{"type":"string","description":"Datetime the deposit request was created","examples":["2023-10-23T06:20:04.366+00:00"]}}},{"type":"object","required":["id","identityId","expiresAt","barcodeNumber","retailerId","retailerName","user","status"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request, can be either the request ID, or the deposit ID","examples":["cshdprq_2e3LyTbcILYHDs5vQqOwl","dp_FiZcY1MGfgB4XjIWsKgtT"]},"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]},"quote":{"type":"object","required":["amountIn","amountOut","fees"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}},"description":"Quote for the deposit"},"expiresAt":{"type":"string","description":"Datetime the cash deposit barcode will expire","examples":["2023-10-23T06:20:04.366+00:00"]},"barcodeNumber":{"type":"string","description":"Barcode number for the cash deposit","examples":["830324006611181360006329048375"]},"retailerId":{"type":"string","description":"Unique ID for the retailer","examples":["10831"]},"retailerName":{"type":"string","description":"Name of the cash deposit retailer","examples":["Walgreens"]},"user":{"type":"object","required":["firstName","lastName","zipcode"],"properties":{"firstName":{"type":"string","description":"Identity first name","examples":["Robert"]},"lastName":{"type":"string","description":"Identity last name","examples":["Smith"]},"zipcode":{"type":"string","description":"Identity residence zip code","examples":["90210"]},"address":{"type":"string"}}},"status":{"type":"string","enum":["CREATED","PENDING","EXPIRED","CANCELLED","CONSUMED","VOIDED","DECLINED"]},"metadata":{"type":"object","additionalProperties":{}}}}]}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"}},"title":"NOT_FOUND","description":"The resource was not found"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/deposit/cash/{id}/cancel":{"post":{"summary":"Cancel Cash Deposit Request","tags":["Cash"],"description":"Cancel a cash deposit request. Note that this endpoint can only be utilised before the user payment at a retailer has been successfully completed.","parameters":[{"schema":{"type":"string"},"example":"dprq_FiZcY1MGfgB4XjIWsKgtT","in":"path","name":"id","required":true,"description":"Unique identifier for a deposit request, can be either the request id or the deposit id"},{"schema":{"type":"string"},"in":"header","name":"Idempotency-Key","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request, can be either the request id or the deposit id","example":"dprq_FiZcY1MGfgB4XjIWsKgtT"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["MISSING_IDEMPOTENCY_KEY"]},"message":{"type":"string"}},"title":"MISSING_IDEMPOTENCY_KEY","description":"Missing required idempotency key header"},{"anyOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["DEPOSIT_ALREADY_PROCESSED"]},"message":{"type":"string"}},"title":"DEPOSIT_ALREADY_PROCESSED","description":"The cash deposit request has already been processed or is pending and cannot be cancelled"}]}]}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"}},"title":"NOT_FOUND","description":"The resource was not found"}}}},"409":{"description":"A duplicate request with this idempotency key is already in progress","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["IDEMPOTENCY_IN_PROGRESS"]},"message":{"type":"string"}},"title":"IDEMPOTENCY_IN_PROGRESS","description":"A duplicate request with this idempotency key is already in progress"}}}},"422":{"description":"Another request with this idempotency key was made using a different body","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},"message":{"type":"string"}},"title":"IDEMPOTENCY_KEY_REUSED","description":"Another request with this idempotency key was made using a different body"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/deposit/{id}":{"get":{"summary":"Get Deposit","tags":["Deposit"],"description":"Get deposit details including the financial instrument utilised.","parameters":[{"schema":{"type":"boolean"},"in":"query","name":"withRequest","required":false,"description":"Flag indicating whether the deposit request should also be returned"},{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Deposit ID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"allOf":[{"type":"object","required":["wallet","reference","id","status","amount","quote","receipt","createdAt"],"properties":{"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"}]},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"id":{"type":"string","description":"Unique identifier for a deposit instance","examples":["dp_dn62A7pvwIAyd3rWaV4gh"]},"status":{"anyOf":[{"type":"string","enum":["PENDING","CANCELLED","PROCESSING","DEPOSITED"]},{"type":"string","enum":["PENDING","CANCELLED","PROCESSING","DEPOSITED"]}]},"amount":{"anyOf":[{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"}]},"quote":{"anyOf":[{"type":"object","required":["amountIn","amountOut","fees"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}},"description":"Quote for the deposit"},{"type":"object","required":["amountIn","amountOut","fees"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}},"description":"Quote for the deposit"}]},"receipt":{"anyOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"Unique receipt identifier"},"type":{"type":"string","title":"SOLANA_TRANSACTION_SIGNATURE","enum":["SOLANA_TRANSACTION_SIGNATURE"]}},"description":"Receipt associated with the deposit"},{"type":"null"}]},"createdAt":{"type":"string","description":"Datetime the deposit was created","examples":["2023-10-23T06:20:04.366+00:00"]},"history":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PENDING"]}},"title":"PENDING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PROCESSING"]}},"title":"PROCESSING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["CANCELLED"]}},"title":"CANCELLED"},{"type":"object","required":["id","createdAt","status","transactionId"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["DEPOSITED"]},"transactionId":{"type":"string"}},"title":"DEPOSITED"}]},"title":"Historical record for the deposit"}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["CASH"]},"request":{"allOf":[{"type":"object","required":["id","reference","wallet","updatedAt","createdAt"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request, can be either the request id or the deposit id","examples":["dprq_FiZcY1MGfgB4XjIWsKgtT"]},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"depositId":{"type":"string","description":"Unique identifier of the associated Deposit"},"deviceIpAddress":{"type":"string","description":"IP address of the device creating the deposit request","examples":["123.123.123.123"]},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"},"updatedAt":{"type":"string","description":"Datetime the deposit request was last updated","examples":["2023-10-23T06:20:04.366+00:00"]},"createdAt":{"type":"string","description":"Datetime the deposit request was created","examples":["2023-10-23T06:20:04.366+00:00"]}}},{"type":"object","required":["id","identityId","expiresAt","barcodeNumber","retailerId","retailerName","user","status"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request, can be either the request ID, or the deposit ID","examples":["cshdprq_2e3LyTbcILYHDs5vQqOwl","dp_FiZcY1MGfgB4XjIWsKgtT"]},"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]},"quote":{"type":"object","required":["amountIn","amountOut","fees"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}},"description":"Quote for the deposit"},"expiresAt":{"type":"string","description":"Datetime the cash deposit barcode will expire","examples":["2023-10-23T06:20:04.366+00:00"]},"barcodeNumber":{"type":"string","description":"Barcode number for the cash deposit","examples":["830324006611181360006329048375"]},"retailerId":{"type":"string","description":"Unique ID for the retailer","examples":["10831"]},"retailerName":{"type":"string","description":"Name of the cash deposit retailer","examples":["Walgreens"]},"user":{"type":"object","required":["firstName","lastName","zipcode"],"properties":{"firstName":{"type":"string","description":"Identity first name","examples":["Robert"]},"lastName":{"type":"string","description":"Identity last name","examples":["Smith"]},"zipcode":{"type":"string","description":"Identity residence zip code","examples":["90210"]},"address":{"type":"string"}}},"status":{"type":"string","enum":["CREATED","PENDING","EXPIRED","CANCELLED","CONSUMED","VOIDED","DECLINED"]},"metadata":{"type":"object","additionalProperties":{}}}}]}}}],"title":"CASH"},{"allOf":[{"type":"object","required":["wallet","reference","id","status","amount","quote","receipt","createdAt"],"properties":{"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"}]},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"id":{"type":"string","description":"Unique identifier for a deposit instance","examples":["dp_dn62A7pvwIAyd3rWaV4gh"]},"status":{"anyOf":[{"type":"string","enum":["PENDING","CANCELLED","PROCESSING","DEPOSITED"]},{"type":"string","enum":["PENDING","CANCELLED","PROCESSING","DEPOSITED"]}]},"amount":{"anyOf":[{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"}]},"quote":{"anyOf":[{"type":"object","required":["amountIn","amountOut","fees"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}},"description":"Quote for the deposit"},{"type":"object","required":["amountIn","amountOut","fees"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}},"description":"Quote for the deposit"}]},"receipt":{"anyOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"Unique receipt identifier"},"type":{"type":"string","title":"SOLANA_TRANSACTION_SIGNATURE","enum":["SOLANA_TRANSACTION_SIGNATURE"]}},"description":"Receipt associated with the deposit"},{"type":"null"}]},"createdAt":{"type":"string","description":"Datetime the deposit was created","examples":["2023-10-23T06:20:04.366+00:00"]},"history":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PENDING"]}},"title":"PENDING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PROCESSING"]}},"title":"PROCESSING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["CANCELLED"]}},"title":"CANCELLED"},{"type":"object","required":["id","createdAt","status","transactionId"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["DEPOSITED"]},"transactionId":{"type":"string"}},"title":"DEPOSITED"}]},"title":"Historical record for the deposit"}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["RTP"]},"request":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"allOf":[{"type":"object","required":["id","reference","wallet","updatedAt","createdAt"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request, can be either the request id or the deposit id","examples":["dprq_FiZcY1MGfgB4XjIWsKgtT"]},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"depositId":{"type":"string","description":"Unique identifier of the associated Deposit"},"deviceIpAddress":{"type":"string","description":"IP address of the device creating the deposit request","examples":["123.123.123.123"]},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"},"updatedAt":{"type":"string","description":"Datetime the deposit request was last updated","examples":["2023-10-23T06:20:04.366+00:00"]},"createdAt":{"type":"string","description":"Datetime the deposit request was created","examples":["2023-10-23T06:20:04.366+00:00"]}}},{"type":"object","required":["id","memo","status","quote"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request can be either the request ID or the deposit ID","examples":["uswrdprq_BDDLyTbcILYHDs5vQqOwl","dp_FiZcY1MGfgB4XjIWsKgtT"]},"memo":{"type":"string"},"status":{"type":"string","enum":["PENDING","PROCESSING","CANCELLED","DEPOSITED"]},"quote":{"allOf":[{"type":"object","required":["amountOut","fees"],"properties":{"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}}},{"type":"object","required":["amountIn"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","description":"Amount of the nominated currency","enum":["USD"]}},"description":"Amount associated with this deposit"}}}]}}}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"allOf":[{"type":"object","required":["id","reference","wallet","updatedAt","createdAt"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request, can be either the request id or the deposit id","examples":["dprq_FiZcY1MGfgB4XjIWsKgtT"]},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"depositId":{"type":"string","description":"Unique identifier of the associated Deposit"},"deviceIpAddress":{"type":"string","description":"IP address of the device creating the deposit request","examples":["123.123.123.123"]},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"},"updatedAt":{"type":"string","description":"Datetime the deposit request was last updated","examples":["2023-10-23T06:20:04.366+00:00"]},"createdAt":{"type":"string","description":"Datetime the deposit request was created","examples":["2023-10-23T06:20:04.366+00:00"]}}},{"type":"object","required":["id","memo","status","quote"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request can be either the request ID or the deposit ID","examples":["uswrdprq_BDDLyTbcILYHDs5vQqOwl","dp_FiZcY1MGfgB4XjIWsKgtT"]},"memo":{"type":"string"},"status":{"type":"string","enum":["PENDING","PROCESSING","CANCELLED","DEPOSITED"]},"quote":{"allOf":[{"type":"object","required":["amountOut","fees"],"properties":{"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}}},{"type":"object","required":["amountIn"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","description":"Amount of the nominated currency","enum":["USD"]}},"description":"Amount associated with this deposit"}}}]}}}]}]}]}}}],"title":"RTP"},{"allOf":[{"type":"object","required":["wallet","reference","id","status","amount","quote","receipt","createdAt"],"properties":{"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"}]},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"id":{"type":"string","description":"Unique identifier for a deposit instance","examples":["dp_dn62A7pvwIAyd3rWaV4gh"]},"status":{"anyOf":[{"type":"string","enum":["PENDING","CANCELLED","PROCESSING","DEPOSITED"]},{"type":"string","enum":["PENDING","CANCELLED","PROCESSING","DEPOSITED"]}]},"amount":{"anyOf":[{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"}]},"quote":{"anyOf":[{"type":"object","required":["amountIn","amountOut","fees"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}},"description":"Quote for the deposit"},{"type":"object","required":["amountIn","amountOut","fees"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}},"description":"Quote for the deposit"}]},"receipt":{"anyOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"Unique receipt identifier"},"type":{"type":"string","title":"SOLANA_TRANSACTION_SIGNATURE","enum":["SOLANA_TRANSACTION_SIGNATURE"]}},"description":"Receipt associated with the deposit"},{"type":"null"}]},"createdAt":{"type":"string","description":"Datetime the deposit was created","examples":["2023-10-23T06:20:04.366+00:00"]},"history":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PENDING"]}},"title":"PENDING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PROCESSING"]}},"title":"PROCESSING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["CANCELLED"]}},"title":"CANCELLED"},{"type":"object","required":["id","createdAt","status","transactionId"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["DEPOSITED"]},"transactionId":{"type":"string"}},"title":"DEPOSITED"}]},"title":"Historical record for the deposit"}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["ACH_CREDIT"]},"request":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"allOf":[{"type":"object","required":["id","reference","wallet","updatedAt","createdAt"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request, can be either the request id or the deposit id","examples":["dprq_FiZcY1MGfgB4XjIWsKgtT"]},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"depositId":{"type":"string","description":"Unique identifier of the associated Deposit"},"deviceIpAddress":{"type":"string","description":"IP address of the device creating the deposit request","examples":["123.123.123.123"]},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"},"updatedAt":{"type":"string","description":"Datetime the deposit request was last updated","examples":["2023-10-23T06:20:04.366+00:00"]},"createdAt":{"type":"string","description":"Datetime the deposit request was created","examples":["2023-10-23T06:20:04.366+00:00"]}}},{"type":"object","required":["id","memo","status","quote"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request can be either the request ID or the deposit ID","examples":["uswrdprq_BDDLyTbcILYHDs5vQqOwl","dp_FiZcY1MGfgB4XjIWsKgtT"]},"memo":{"type":"string"},"status":{"type":"string","enum":["PENDING","PROCESSING","CANCELLED","DEPOSITED"]},"quote":{"allOf":[{"type":"object","required":["amountOut","fees"],"properties":{"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}}},{"type":"object","required":["amountIn"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","description":"Amount of the nominated currency","enum":["USD"]}},"description":"Amount associated with this deposit"}}}]}}}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"allOf":[{"type":"object","required":["id","reference","wallet","updatedAt","createdAt"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request, can be either the request id or the deposit id","examples":["dprq_FiZcY1MGfgB4XjIWsKgtT"]},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"depositId":{"type":"string","description":"Unique identifier of the associated Deposit"},"deviceIpAddress":{"type":"string","description":"IP address of the device creating the deposit request","examples":["123.123.123.123"]},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"},"updatedAt":{"type":"string","description":"Datetime the deposit request was last updated","examples":["2023-10-23T06:20:04.366+00:00"]},"createdAt":{"type":"string","description":"Datetime the deposit request was created","examples":["2023-10-23T06:20:04.366+00:00"]}}},{"type":"object","required":["id","memo","status","quote"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request can be either the request ID or the deposit ID","examples":["uswrdprq_BDDLyTbcILYHDs5vQqOwl","dp_FiZcY1MGfgB4XjIWsKgtT"]},"memo":{"type":"string"},"status":{"type":"string","enum":["PENDING","PROCESSING","CANCELLED","DEPOSITED"]},"quote":{"allOf":[{"type":"object","required":["amountOut","fees"],"properties":{"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}}},{"type":"object","required":["amountIn"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","description":"Amount of the nominated currency","enum":["USD"]}},"description":"Amount associated with this deposit"}}}]}}}]}]}]}}}],"title":"ACH_CREDIT"},{"allOf":[{"type":"object","required":["wallet","reference","id","status","amount","quote","receipt","createdAt"],"properties":{"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"}]},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"id":{"type":"string","description":"Unique identifier for a deposit instance","examples":["dp_dn62A7pvwIAyd3rWaV4gh"]},"status":{"anyOf":[{"type":"string","enum":["PENDING","CANCELLED","PROCESSING","DEPOSITED"]},{"type":"string","enum":["PENDING","CANCELLED","PROCESSING","DEPOSITED"]}]},"amount":{"anyOf":[{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"}]},"quote":{"anyOf":[{"type":"object","required":["amountIn","amountOut","fees"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}},"description":"Quote for the deposit"},{"type":"object","required":["amountIn","amountOut","fees"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}},"description":"Quote for the deposit"}]},"receipt":{"anyOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"Unique receipt identifier"},"type":{"type":"string","title":"SOLANA_TRANSACTION_SIGNATURE","enum":["SOLANA_TRANSACTION_SIGNATURE"]}},"description":"Receipt associated with the deposit"},{"type":"null"}]},"createdAt":{"type":"string","description":"Datetime the deposit was created","examples":["2023-10-23T06:20:04.366+00:00"]},"history":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PENDING"]}},"title":"PENDING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PROCESSING"]}},"title":"PROCESSING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["CANCELLED"]}},"title":"CANCELLED"},{"type":"object","required":["id","createdAt","status","transactionId"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["DEPOSITED"]},"transactionId":{"type":"string"}},"title":"DEPOSITED"}]},"title":"Historical record for the deposit"}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["US_BANK_ACH"]},"request":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"allOf":[{"type":"object","required":["id","reference","wallet","updatedAt","createdAt"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request, can be either the request id or the deposit id","examples":["dprq_FiZcY1MGfgB4XjIWsKgtT"]},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"depositId":{"type":"string","description":"Unique identifier of the associated Deposit"},"deviceIpAddress":{"type":"string","description":"IP address of the device creating the deposit request","examples":["123.123.123.123"]},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"},"updatedAt":{"type":"string","description":"Datetime the deposit request was last updated","examples":["2023-10-23T06:20:04.366+00:00"]},"createdAt":{"type":"string","description":"Datetime the deposit request was created","examples":["2023-10-23T06:20:04.366+00:00"]}}},{"type":"object","required":["status","sourcePaymentInstrumentId","amount","quote"],"properties":{"status":{"type":"string","enum":["CREATED","PROCESSING","SUCCEEDED","FAILED","CANCELLED"]},"sourcePaymentInstrumentId":{"type":"string","description":"ID for a US_ACH payment instrument","examples":["pi_jk23h4j564rthk32"]},"amount":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","description":"Amount of the nominated currency","enum":["USD"]}},"description":"Amount associated with this deposit"},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified. Same-day requires a Victor-eligible ledger account.","examples":["same-day"]},"quote":{"allOf":[{"type":"object","required":["amountOut","fees"],"properties":{"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}}},{"type":"object","required":["amountIn"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","description":"Amount of the nominated currency","enum":["USD"]}},"description":"Amount associated with this deposit"}}}]}}}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"allOf":[{"type":"object","required":["id","reference","wallet","updatedAt","createdAt"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request, can be either the request id or the deposit id","examples":["dprq_FiZcY1MGfgB4XjIWsKgtT"]},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"depositId":{"type":"string","description":"Unique identifier of the associated Deposit"},"deviceIpAddress":{"type":"string","description":"IP address of the device creating the deposit request","examples":["123.123.123.123"]},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"},"updatedAt":{"type":"string","description":"Datetime the deposit request was last updated","examples":["2023-10-23T06:20:04.366+00:00"]},"createdAt":{"type":"string","description":"Datetime the deposit request was created","examples":["2023-10-23T06:20:04.366+00:00"]}}},{"type":"object","required":["status","sourcePaymentInstrumentId","amount","quote"],"properties":{"status":{"type":"string","enum":["CREATED","PROCESSING","SUCCEEDED","FAILED","CANCELLED"]},"sourcePaymentInstrumentId":{"type":"string","description":"ID for a US_ACH payment instrument","examples":["pi_jk23h4j564rthk32"]},"amount":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","description":"Amount of the nominated currency","enum":["USD"]}},"description":"Amount associated with this deposit"},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified. Same-day requires a Victor-eligible ledger account.","examples":["same-day"]},"quote":{"allOf":[{"type":"object","required":["amountOut","fees"],"properties":{"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}}},{"type":"object","required":["amountIn"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","description":"Amount of the nominated currency","enum":["USD"]}},"description":"Amount associated with this deposit"}}}]}}}]}]}]}}}],"title":"US_BANK_ACH"},{"allOf":[{"type":"object","required":["wallet","reference","id","status","amount","quote","receipt","createdAt"],"properties":{"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"}]},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"id":{"type":"string","description":"Unique identifier for a deposit instance","examples":["dp_dn62A7pvwIAyd3rWaV4gh"]},"status":{"anyOf":[{"type":"string","enum":["PENDING","CANCELLED","PROCESSING","DEPOSITED"]},{"type":"string","enum":["PENDING","CANCELLED","PROCESSING","DEPOSITED"]}]},"amount":{"anyOf":[{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"}]},"quote":{"anyOf":[{"type":"object","required":["amountIn","amountOut","fees"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}},"description":"Quote for the deposit"},{"type":"object","required":["amountIn","amountOut","fees"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}},"description":"Quote for the deposit"}]},"receipt":{"anyOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"Unique receipt identifier"},"type":{"type":"string","title":"SOLANA_TRANSACTION_SIGNATURE","enum":["SOLANA_TRANSACTION_SIGNATURE"]}},"description":"Receipt associated with the deposit"},{"type":"null"}]},"createdAt":{"type":"string","description":"Datetime the deposit was created","examples":["2023-10-23T06:20:04.366+00:00"]},"history":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PENDING"]}},"title":"PENDING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PROCESSING"]}},"title":"PROCESSING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["CANCELLED"]}},"title":"CANCELLED"},{"type":"object","required":["id","createdAt","status","transactionId"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["DEPOSITED"]},"transactionId":{"type":"string"}},"title":"DEPOSITED"}]},"title":"Historical record for the deposit"}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["US_WIRE"]},"request":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"allOf":[{"type":"object","required":["id","reference","wallet","updatedAt","createdAt"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request, can be either the request id or the deposit id","examples":["dprq_FiZcY1MGfgB4XjIWsKgtT"]},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"depositId":{"type":"string","description":"Unique identifier of the associated Deposit"},"deviceIpAddress":{"type":"string","description":"IP address of the device creating the deposit request","examples":["123.123.123.123"]},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"},"updatedAt":{"type":"string","description":"Datetime the deposit request was last updated","examples":["2023-10-23T06:20:04.366+00:00"]},"createdAt":{"type":"string","description":"Datetime the deposit request was created","examples":["2023-10-23T06:20:04.366+00:00"]}}},{"type":"object","required":["id","memo","status","quote"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request can be either the request ID or the deposit ID","examples":["uswrdprq_BDDLyTbcILYHDs5vQqOwl","dp_FiZcY1MGfgB4XjIWsKgtT"]},"memo":{"type":"string"},"status":{"type":"string","enum":["PENDING","PROCESSING","CANCELLED","DEPOSITED"]},"quote":{"allOf":[{"type":"object","required":["amountOut","fees"],"properties":{"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}}},{"type":"object","required":["amountIn"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","description":"Amount of the nominated currency","enum":["USD"]}},"description":"Amount associated with this deposit"}}}]}}}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"allOf":[{"type":"object","required":["id","reference","wallet","updatedAt","createdAt"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request, can be either the request id or the deposit id","examples":["dprq_FiZcY1MGfgB4XjIWsKgtT"]},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"depositId":{"type":"string","description":"Unique identifier of the associated Deposit"},"deviceIpAddress":{"type":"string","description":"IP address of the device creating the deposit request","examples":["123.123.123.123"]},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"},"updatedAt":{"type":"string","description":"Datetime the deposit request was last updated","examples":["2023-10-23T06:20:04.366+00:00"]},"createdAt":{"type":"string","description":"Datetime the deposit request was created","examples":["2023-10-23T06:20:04.366+00:00"]}}},{"type":"object","required":["id","memo","status","quote"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request can be either the request ID or the deposit ID","examples":["uswrdprq_BDDLyTbcILYHDs5vQqOwl","dp_FiZcY1MGfgB4XjIWsKgtT"]},"memo":{"type":"string"},"status":{"type":"string","enum":["PENDING","PROCESSING","CANCELLED","DEPOSITED"]},"quote":{"allOf":[{"type":"object","required":["amountOut","fees"],"properties":{"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}}},{"type":"object","required":["amountIn"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","description":"Amount of the nominated currency","enum":["USD"]}},"description":"Amount associated with this deposit"}}}]}}}]}]}]},"imad":{"type":"string"},"omad":{"type":"string"},"senderName":{"type":"string"}}}],"title":"US_WIRE"},{"allOf":[{"type":"object","required":["wallet","reference","id","status","amount","quote","receipt","createdAt"],"properties":{"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"}]},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"id":{"type":"string","description":"Unique identifier for a deposit instance","examples":["dp_dn62A7pvwIAyd3rWaV4gh"]},"status":{"anyOf":[{"type":"string","enum":["PENDING","CANCELLED","PROCESSING","DEPOSITED"]},{"type":"string","enum":["PENDING","CANCELLED","PROCESSING","DEPOSITED"]}]},"amount":{"anyOf":[{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"}]},"quote":{"anyOf":[{"type":"object","required":["amountIn","amountOut","fees"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}},"description":"Quote for the deposit"},{"type":"object","required":["amountIn","amountOut","fees"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}},"description":"Quote for the deposit"}]},"receipt":{"anyOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"Unique receipt identifier"},"type":{"type":"string","title":"SOLANA_TRANSACTION_SIGNATURE","enum":["SOLANA_TRANSACTION_SIGNATURE"]}},"description":"Receipt associated with the deposit"},{"type":"null"}]},"createdAt":{"type":"string","description":"Datetime the deposit was created","examples":["2023-10-23T06:20:04.366+00:00"]},"history":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PENDING"]}},"title":"PENDING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PROCESSING"]}},"title":"PROCESSING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["CANCELLED"]}},"title":"CANCELLED"},{"type":"object","required":["id","createdAt","status","transactionId"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["DEPOSITED"]},"transactionId":{"type":"string"}},"title":"DEPOSITED"}]},"title":"Historical record for the deposit"}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["SWIFT_WIRE"]},"request":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"allOf":[{"type":"object","required":["id","reference","wallet","updatedAt","createdAt"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request, can be either the request id or the deposit id","examples":["dprq_FiZcY1MGfgB4XjIWsKgtT"]},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"depositId":{"type":"string","description":"Unique identifier of the associated Deposit"},"deviceIpAddress":{"type":"string","description":"IP address of the device creating the deposit request","examples":["123.123.123.123"]},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"},"updatedAt":{"type":"string","description":"Datetime the deposit request was last updated","examples":["2023-10-23T06:20:04.366+00:00"]},"createdAt":{"type":"string","description":"Datetime the deposit request was created","examples":["2023-10-23T06:20:04.366+00:00"]}}},{"type":"object","required":["id","memo","status","quote"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request can be either the request ID or the deposit ID","examples":["uswrdprq_BDDLyTbcILYHDs5vQqOwl","dp_FiZcY1MGfgB4XjIWsKgtT"]},"memo":{"type":"string"},"status":{"type":"string","enum":["PENDING","PROCESSING","CANCELLED","DEPOSITED"]},"quote":{"allOf":[{"type":"object","required":["amountOut","fees"],"properties":{"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}}},{"type":"object","required":["amountIn"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","description":"Amount of the nominated currency","enum":["USD"]}},"description":"Amount associated with this deposit"}}}]}}}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"allOf":[{"type":"object","required":["id","reference","wallet","updatedAt","createdAt"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request, can be either the request id or the deposit id","examples":["dprq_FiZcY1MGfgB4XjIWsKgtT"]},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"depositId":{"type":"string","description":"Unique identifier of the associated Deposit"},"deviceIpAddress":{"type":"string","description":"IP address of the device creating the deposit request","examples":["123.123.123.123"]},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"},"updatedAt":{"type":"string","description":"Datetime the deposit request was last updated","examples":["2023-10-23T06:20:04.366+00:00"]},"createdAt":{"type":"string","description":"Datetime the deposit request was created","examples":["2023-10-23T06:20:04.366+00:00"]}}},{"type":"object","required":["id","memo","status","quote"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request can be either the request ID or the deposit ID","examples":["uswrdprq_BDDLyTbcILYHDs5vQqOwl","dp_FiZcY1MGfgB4XjIWsKgtT"]},"memo":{"type":"string"},"status":{"type":"string","enum":["PENDING","PROCESSING","CANCELLED","DEPOSITED"]},"quote":{"allOf":[{"type":"object","required":["amountOut","fees"],"properties":{"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}}},{"type":"object","required":["amountIn"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","description":"Amount of the nominated currency","enum":["USD"]}},"description":"Amount associated with this deposit"}}}]}}}]}]}]},"imad":{"type":"string"},"omad":{"type":"string"},"senderName":{"type":"string"}}}],"title":"SWIFT_WIRE"}]}}}},"400":{"description":"The service cannot understand the request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"}},"title":"NOT_FOUND","description":"The resource was not found"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/deposit":{"get":{"summary":"Search Deposits","tags":["Deposit"],"description":"Search deposits across all payment instruments for a given identityId or organizationId.\n\nDeposits can be further filtered by populating the `status` and `reference` parameters.\n\nNote that cash deposits will only be returned after they have progressed to at least the `RECEIVED` state.","parameters":[{"schema":{"type":"string"},"example":"id_VfsdSMtd8UdgxCgTnz0tm","in":"query","name":"identityId","required":false,"description":"Identity ID associated with the deposit request"},{"schema":{"type":"string"},"example":"org_RD2of9vs3XFodUSd8T5hW","in":"query","name":"organizationId","required":false,"description":"Organization ID associated with the deposit request"},{"schema":{"type":"string"},"example":"mysystem-123","in":"query","name":"reference","required":false,"description":"Reference provided when deposit was created"},{"schema":{"type":"string","pattern":"^(PENDING|CANCELLED|PROCESSING|DEPOSITED)(,(PENDING|CANCELLED|PROCESSING|DEPOSITED))*$"},"example":"CREATED","in":"query","name":"status","required":false,"description":"Status of the deposit"},{"schema":{"type":"string","enum":["CASH","US_BANK_ACH","ACH_CREDIT","RTP","US_WIRE","SWIFT_WIRE"]},"in":"query","name":"type","required":false},{"schema":{"type":"string"},"in":"query","name":"id","required":false,"description":"Deposit ID"},{"schema":{"type":"integer"},"in":"query","name":"page","required":false,"description":"Page number"},{"schema":{"type":"integer"},"in":"query","name":"pageSize","required":false,"description":"Page size"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["results"],"properties":{"results":{"type":"array","items":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"type":"object","required":["wallet","reference","id","type","status","amount","quote","receipt","createdAt"],"properties":{"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"id":{"type":"string","description":"Unique identifier for a deposit instance","examples":["dp_dn62A7pvwIAyd3rWaV4gh"]},"type":{"type":"string","enum":["CASH","US_BANK_ACH","ACH_CREDIT","RTP","US_WIRE","SWIFT_WIRE"]},"status":{"type":"string","enum":["PENDING","CANCELLED","PROCESSING","DEPOSITED"]},"amount":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"quote":{"type":"object","required":["amountIn","amountOut","fees"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}},"description":"Quote for the deposit"},"receipt":{"anyOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"Unique receipt identifier"},"type":{"type":"string","title":"SOLANA_TRANSACTION_SIGNATURE","enum":["SOLANA_TRANSACTION_SIGNATURE"]}},"description":"Receipt associated with the deposit"},{"type":"null"}]},"createdAt":{"type":"string","description":"Datetime the deposit was created","examples":["2023-10-23T06:20:04.366+00:00"]},"history":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PENDING"]}},"title":"PENDING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PROCESSING"]}},"title":"PROCESSING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["CANCELLED"]}},"title":"CANCELLED"},{"type":"object","required":["id","createdAt","status","transactionId"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["DEPOSITED"]},"transactionId":{"type":"string"}},"title":"DEPOSITED"}]},"title":"Historical record for the deposit"}}}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"type":"object","required":["wallet","reference","id","type","status","amount","quote","receipt","createdAt"],"properties":{"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"id":{"type":"string","description":"Unique identifier for a deposit instance","examples":["dp_dn62A7pvwIAyd3rWaV4gh"]},"type":{"type":"string","enum":["CASH","US_BANK_ACH","ACH_CREDIT","RTP","US_WIRE","SWIFT_WIRE"]},"status":{"type":"string","enum":["PENDING","CANCELLED","PROCESSING","DEPOSITED"]},"amount":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"quote":{"type":"object","required":["amountIn","amountOut","fees"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USD","AUD","HKD","JPY","MXN","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}},"description":"Quote for the deposit"},"receipt":{"anyOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"Unique receipt identifier"},"type":{"type":"string","title":"SOLANA_TRANSACTION_SIGNATURE","enum":["SOLANA_TRANSACTION_SIGNATURE"]}},"description":"Receipt associated with the deposit"},{"type":"null"}]},"createdAt":{"type":"string","description":"Datetime the deposit was created","examples":["2023-10-23T06:20:04.366+00:00"]},"history":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PENDING"]}},"title":"PENDING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PROCESSING"]}},"title":"PROCESSING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["CANCELLED"]}},"title":"CANCELLED"},{"type":"object","required":["id","createdAt","status","transactionId"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["DEPOSITED"]},"transactionId":{"type":"string"}},"title":"DEPOSITED"}]},"title":"Historical record for the deposit"}}}]}]},"description":"Deposit"}}}}}},"400":{"description":"The service cannot understand the request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/deposit/estimate":{"get":{"summary":"Estimate Deposit Fees","tags":["Deposit"],"description":"Preview the effective fees and quote math for a deposit without creating one.\n\nResolves the fee template for the chosen route. When `sourceAmount` is provided, also returns the concrete amount math (target after fees, per-fee items). This endpoint never enforces limits or writes a quote — use `/v1/deposit` create endpoints for that.","parameters":[{"schema":{"type":"string"},"example":"id_VfsdSMtd8UdgxCgTnz0tm","in":"query","name":"identityId","required":false,"description":"Identity ID associated with the deposit request"},{"schema":{"type":"string"},"example":"org_RD2of9vs3XFodUSd8T5hW","in":"query","name":"organizationId","required":false,"description":"Organization ID associated with the deposit request"},{"schema":{"type":"string","enum":["deposit.us_cash.v1","deposit.rtp.v1","deposit.us_bank_ach.v1","deposit.ach_credit.v1","deposit.us_wire.v1","deposit.swift_wire.v1"]},"in":"query","name":"product","required":true},{"schema":{"type":"string"},"example":"USD","in":"query","name":"sourceCurrency","required":true,"description":"Currency to be debited from the source"},{"schema":{"type":"string"},"example":"MOVEUSD","in":"query","name":"targetCurrency","required":true,"description":"Currency to be credited at the destination"},{"schema":{"type":"string"},"example":"100.00","in":"query","name":"sourceAmount","required":false,"description":"Source amount as a number string. When omitted, only the fee template is returned (`quote` will be `null`)"},{"schema":{"type":"string"},"in":"query","name":"countryCode","required":false,"description":"ISO-3166-1 Alpha-2 country override for rule evaluation. Defaults to the entity's country of residence."},{"schema":{"type":"string"},"in":"query","name":"regionCode","required":false,"description":"ISO-3166-2 region/state override"},{"schema":{"type":"string"},"in":"query","name":"cashDepositRetailerId","required":false,"description":"Required when `product` is `deposit.us_cash.v1` and rules vary by retailer"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["effective","quote","minSettlementDate"],"properties":{"effective":{"type":"array","items":{"anyOf":[{"type":"object","required":["type","receiver","feeAmount"],"properties":{"type":{"type":"string","enum":["FIXED"]},"receiver":{"type":"string","enum":["PROVIDER","CFX","CUSTOMER"]},"feeAmount":{"type":"string","description":"Fixed fee amount as a number string, in the source currency","examples":["0.45"]}},"title":"FIXED"},{"type":"object","required":["type","receiver","feeBps"],"properties":{"type":{"type":"string","enum":["VARIABLE"]},"receiver":{"type":"string","enum":["PROVIDER","CFX","CUSTOMER"]},"feeBps":{"type":"string","description":"Variable fee in basis points (number string) of the source amount, e.g. `120` is 1.2%","examples":["120"]}},"title":"VARIABLE"}]},"description":"Resolved fee template for the chosen route — admin and customer-tier rules combined"},"quote":{"anyOf":[{"type":"object","required":["sourceAmount","targetAmountAfterFees","fees","totalFees"],"properties":{"sourceAmount":{"type":"string","examples":["100.00"]},"targetAmountAfterFees":{"type":"string","examples":["98.80"]},"fees":{"type":"array","items":{"type":"object","required":["receiver","type","amount"],"properties":{"receiver":{"type":"string","enum":["PROVIDER","CFX","CUSTOMER"]},"type":{"type":"string","enum":["FIXED","VARIABLE"]},"amount":{"type":"string","description":"Concrete fee amount as a number string, in source currency","examples":["1.20"]}}}},"totalFees":{"type":"string","examples":["1.20"]}}},{"type":"null"}],"description":"Concrete quote math; `null` when `sourceAmount` is omitted"},"minSettlementDate":{"type":"string","format":"date","description":"Earliest date funds settle by (Mon–Fri, no holiday calendar)"}}}}}},"400":{"description":"The service cannot understand the request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"}},"title":"NOT_FOUND","description":"The resource was not found"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/deposit/usage":{"get":{"summary":"Get Deposit Usage","tags":["Deposit"],"description":"Retrieve deposit product usages for a given identity","parameters":[{"schema":{"type":"string"},"example":"id_VfsdSMtd8UdgxCgTnz0tm","in":"query","name":"identityId","required":false,"description":"Identity ID associated with the deposit request"},{"schema":{"type":"string"},"example":"org_RD2of9vs3XFodUSd8T5hW","in":"query","name":"organizationId","required":false,"description":"Organization ID associated with the deposit request"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["products","aggregated"],"properties":{"products":{"type":"array","items":{"allOf":[{"type":"object","required":["name","limits"],"properties":{"name":{"type":"string","enum":["organization.v1","identity.v1","card.physical_card.v1","card.virtual_card.v1","deposit.us_cash.v1","deposit.rtp.v1","deposit.us_bank_ach.v1","deposit.ach_credit.v1","deposit.us_wire.v1","deposit.swift_wire.v1","transfer.redemption.v1","swap.v1","withdraw.blockchain.v1","withdraw.ke_bank.v1","withdraw.ke_momo.v1","withdraw.mx_bank_spei.v1","withdraw.swift_wire.v1","withdraw.tg_momo.v1","withdraw.us_bank_ach.v1","withdraw.us_instant.v1","withdraw.us_wire.v1","withdraw.ach_pull.v1","withdraw.us_wire_drawdown.v1","account.virtual-account.v1"]},"limits":{"type":"object","required":["transactionMinUsd","transactionMaxUsd","limit24hMaxUsd","limit24hMaxCount","limit7dMaxUsd","limit7dMaxCount","limit30dMaxUsd","limit30dMaxCount","limitCalendarMonthMaxUsd","limitCalendarMonthMaxCount"],"properties":{"transactionMinUsd":{"type":"string","nullable":true},"transactionMaxUsd":{"type":"string","nullable":true},"limit24hMaxUsd":{"type":"string","nullable":true},"limit24hMaxCount":{"type":"string","nullable":true},"limit7dMaxUsd":{"type":"string","nullable":true},"limit7dMaxCount":{"type":"string","nullable":true},"limit30dMaxUsd":{"type":"string","nullable":true},"limit30dMaxCount":{"type":"string","nullable":true},"limitCalendarMonthMaxUsd":{"type":"string","nullable":true},"limitCalendarMonthMaxCount":{"type":"string","nullable":true}},"description":"Effective limits after evaluating all admin and customer limit rules against the entity. `null` means no limit on that dimension. All amounts are USD BigNumber strings."}}},{"type":"object","required":["usage24hUsd","usage24hCount","usage7dUsd","usage7dCount","usage30dUsd","usage30dCount","usageCalendarMonthUsd","usageCalendarMonthCount"],"properties":{"usage24hUsd":{"type":"string"},"usage24hCount":{"type":"string"},"usage7dUsd":{"type":"string"},"usage7dCount":{"type":"string"},"usage30dUsd":{"type":"string"},"usage30dCount":{"type":"string"},"usageCalendarMonthUsd":{"type":"string"},"usageCalendarMonthCount":{"type":"string"}},"description":"Effective usage by entity over rolling time windows, mirroring the dimensions in `TProductLimits`. All amounts are USD BigNumber strings; counts are integer-valued BigNumber strings."}]},"description":"CFX product"},"aggregated":{"type":"object","required":["usage24hUsd","usage24hCount","usage7dUsd","usage7dCount","usage30dUsd","usage30dCount","usageCalendarMonthUsd","usageCalendarMonthCount"],"properties":{"usage24hUsd":{"type":"string"},"usage24hCount":{"type":"string"},"usage7dUsd":{"type":"string"},"usage7dCount":{"type":"string"},"usage30dUsd":{"type":"string"},"usage30dCount":{"type":"string"},"usageCalendarMonthUsd":{"type":"string"},"usageCalendarMonthCount":{"type":"string"}},"description":"Effective usage by entity over rolling time windows, mirroring the dimensions in `TProductLimits`. All amounts are USD BigNumber strings; counts are integer-valued BigNumber strings."}}}}}},"400":{"description":"The service cannot understand the request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"}},"title":"NOT_FOUND","description":"The resource was not found"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/deposit/us-bank-ach":{"post":{"summary":"Create US Bank ACH Deposit Request","tags":["US Bank ACH"],"description":"Creates a request to mint MOVEUSD by debiting a US bank account via ACH.\n\nSource bank accounts need to be registered as Payment Instruments which are associated with an Identity or Organization. ACH Deposit Requests refer to this Payment Instrument in the `sourcePaymentInstrumentId` field. Registered deposit requests will result in an ACH pull from the nominated bank account. After the debit is processed and reconciled the funds will be minted to the wallet specified in the request.","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"type":"object","required":["reference","wallet","sourcePaymentInstrumentId","amount"],"properties":{"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"sourcePaymentInstrumentId":{"type":"string","description":"ID for a US_ACH payment instrument","examples":["pi_jk23h4j564rthk32"]},"amount":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","description":"Amount of the nominated currency","enum":["USD"]}},"description":"Amount associated with this deposit"},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified. Same-day requires a Victor-eligible ledger account.","examples":["same-day"]}}}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"type":"object","required":["reference","wallet","sourcePaymentInstrumentId","amount"],"properties":{"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"sourcePaymentInstrumentId":{"type":"string","description":"ID for a US_ACH payment instrument","examples":["pi_jk23h4j564rthk32"]},"amount":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","description":"Amount of the nominated currency","enum":["USD"]}},"description":"Amount associated with this deposit"},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified. Same-day requires a Victor-eligible ledger account.","examples":["same-day"]}}}]}]}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Idempotency-Key","required":false}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request, can be either the request id or the deposit id","example":"dprq_FiZcY1MGfgB4XjIWsKgtT"},"createdAt":{"type":"string","description":"Datetime the deposit request was created","example":"2023-10-23T06:20:04.366+00:00"},"status":{"type":"string","enum":["CREATED","PROCESSING","SUCCEEDED","FAILED","CANCELLED"]}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["MISSING_IDEMPOTENCY_KEY"]},"message":{"type":"string"}},"title":"MISSING_IDEMPOTENCY_KEY","description":"Missing required idempotency key header"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"}]}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"}},"title":"NOT_FOUND","description":"The resource was not found"}}}},"409":{"description":"A duplicate request with this idempotency key is already in progress","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["IDEMPOTENCY_IN_PROGRESS"]},"message":{"type":"string"}},"title":"IDEMPOTENCY_IN_PROGRESS","description":"A duplicate request with this idempotency key is already in progress"}}}},"422":{"description":"Another request with this idempotency key was made using a different body","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},"message":{"type":"string"}},"title":"IDEMPOTENCY_KEY_REUSED","description":"Another request with this idempotency key was made using a different body"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/deposit/us-bank-ach/{id}":{"get":{"summary":"Get US Bank ACH Deposit Request","tags":["US Bank ACH"],"description":"Retrieve a previously submitted US Bank ACH deposit request.","parameters":[{"schema":{"type":"string"},"example":"dprq_FiZcY1MGfgB4XjIWsKgtT","in":"path","name":"id","required":true,"description":"Unique identifier for a deposit request, can be either the request id or the deposit id"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"allOf":[{"type":"object","required":["id","reference","wallet","updatedAt","createdAt"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request, can be either the request id or the deposit id","examples":["dprq_FiZcY1MGfgB4XjIWsKgtT"]},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"depositId":{"type":"string","description":"Unique identifier of the associated Deposit"},"deviceIpAddress":{"type":"string","description":"IP address of the device creating the deposit request","examples":["123.123.123.123"]},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"},"updatedAt":{"type":"string","description":"Datetime the deposit request was last updated","examples":["2023-10-23T06:20:04.366+00:00"]},"createdAt":{"type":"string","description":"Datetime the deposit request was created","examples":["2023-10-23T06:20:04.366+00:00"]}}},{"type":"object","required":["status","sourcePaymentInstrumentId","amount","quote"],"properties":{"status":{"type":"string","enum":["CREATED","PROCESSING","SUCCEEDED","FAILED","CANCELLED"]},"sourcePaymentInstrumentId":{"type":"string","description":"ID for a US_ACH payment instrument","examples":["pi_jk23h4j564rthk32"]},"amount":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","description":"Amount of the nominated currency","enum":["USD"]}},"description":"Amount associated with this deposit"},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified. Same-day requires a Victor-eligible ledger account.","examples":["same-day"]},"quote":{"allOf":[{"type":"object","required":["amountOut","fees"],"properties":{"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}}},{"type":"object","required":["amountIn"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","description":"Amount of the nominated currency","enum":["USD"]}},"description":"Amount associated with this deposit"}}}]}}}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"allOf":[{"type":"object","required":["id","reference","wallet","updatedAt","createdAt"],"properties":{"id":{"type":"string","description":"Unique identifier for a deposit request, can be either the request id or the deposit id","examples":["dprq_FiZcY1MGfgB4XjIWsKgtT"]},"reference":{"type":"string","description":"A unique identifier of the deposit request in the caller's system.\n\n  This is useful to correlate the id in the caller's system with the id returned by the API.","examples":["DR-123456789"]},"wallet":{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","title":"SOLANA","enum":["SOLANA"]}},"description":"The blockchain wallet where funds are to be deposited"},"depositId":{"type":"string","description":"Unique identifier of the associated Deposit"},"deviceIpAddress":{"type":"string","description":"IP address of the device creating the deposit request","examples":["123.123.123.123"]},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"},"updatedAt":{"type":"string","description":"Datetime the deposit request was last updated","examples":["2023-10-23T06:20:04.366+00:00"]},"createdAt":{"type":"string","description":"Datetime the deposit request was created","examples":["2023-10-23T06:20:04.366+00:00"]}}},{"type":"object","required":["status","sourcePaymentInstrumentId","amount","quote"],"properties":{"status":{"type":"string","enum":["CREATED","PROCESSING","SUCCEEDED","FAILED","CANCELLED"]},"sourcePaymentInstrumentId":{"type":"string","description":"ID for a US_ACH payment instrument","examples":["pi_jk23h4j564rthk32"]},"amount":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","description":"Amount of the nominated currency","enum":["USD"]}},"description":"Amount associated with this deposit"},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified. Same-day requires a Victor-eligible ledger account.","examples":["same-day"]},"quote":{"allOf":[{"type":"object","required":["amountOut","fees"],"properties":{"amountOut":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"Amount of the nominated currency"}},"description":"Amount associated with this deposit"},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE"]}}},"description":"Fees associated with a deposit"}}},{"type":"object","required":["amountIn"],"properties":{"amountIn":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number","description":"Amount of the nominated currency"},"currency":{"type":"string","description":"Amount of the nominated currency","enum":["USD"]}},"description":"Amount associated with this deposit"}}}]}}}]}]}]}}}},"400":{"description":"The service cannot understand the request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"}},"title":"NOT_FOUND","description":"The resource was not found"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}}},"servers":[{"url":"https://api.dev.cfx.to","description":"Customer Sandbox"},{"url":"https://api.cfx.to","description":"Production"}],"security":[{"ApiKeyAuth":[],"ApiSecretAuth":[]}],"tags":[{"name":"Cash"},{"name":"Deposit"}],"externalDocs":{"description":"Find out more about CFX","url":"https://www.cfxlabs.com/"}}