openapi: 3.2.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 servers: - url: https://api.dev.cfx.to description: Customer Sandbox - url: https://api.cfx.to description: Production security: - ApiKeyAuth: [] ApiSecretAuth: [] tags: - name: Deposit description: Retrieve and manage deposits into the CFX network. paths: /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: - type: object required: - wallet - reference - id - status - amount - quote - receipt - createdAt - type properties: wallet: type: object required: - address - blockchain properties: address: type: string description: Blockchain address or account blockchain: type: string 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." example: DR-123456789 id: type: string description: Unique identifier for a deposit instance example: dp_dn62A7pvwIAyd3rWaV4gh status: enum: - PENDING - CANCELLED - PROCESSING - DEPOSITED type: string amount: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USD - AUD - HKD - JPY - MXN - NZD - SGD - SEK - CHF - CAD - GBP - CZK - DKK - EUR type: string 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: enum: - USD - AUD - HKD - JPY - MXN - NZD - SGD - SEK - CHF - CAD - GBP - CZK - DKK - EUR type: string 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: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string 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 example: '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 identityId: type: string description: Identity ID that owns the deposit. Present for an individual's deposit, absent for an organization's. example: id_VfsdSMtd8UdgxCgTnz0tm organizationId: type: string description: Organization ID that owns the deposit. Present for an organization's deposit, absent for an individual's. example: org_RD2of9vs3XFodUSd8T5hW type: type: string enum: - CASH request: type: object required: - id - reference - wallet - updatedAt - createdAt - 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 example: cshdprq_2e3LyTbcILYHDs5vQqOwl 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 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: enum: - USD - AUD - HKD - JPY - MXN - NZD - SGD - SEK - CHF - CAD - GBP - CZK - DKK - EUR type: string 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: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string description: Fees associated with a deposit description: Quote for the deposit expiresAt: type: string description: Datetime the cash deposit barcode will expire, as returned by the retailer network. The lifetime is set by the network and is not a fixed interval — read this value rather than deriving it from createdAt. Authorisation at the retailer is decided by the network's own view of the barcode, so treat expiresAt as indicative of validity rather than the definitive cut-off. 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 user: type: object required: - firstName - lastName - zipcode properties: firstName: type: string description: Identity first name example: Robert lastName: type: string description: Identity last name example: Smith zipcode: type: string description: Identity residence zip code example: '90210' address: type: string status: enum: - CREATED - PENDING - EXPIRED - CANCELLED - CONSUMED - VOIDED - DECLINED type: string metadata: type: object additionalProperties: {} title: CASH - type: object required: - wallet - reference - id - status - amount - quote - receipt - createdAt - type properties: wallet: type: object required: - address - blockchain properties: address: type: string description: Blockchain address or account blockchain: type: string 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." example: DR-123456789 id: type: string description: Unique identifier for a deposit instance example: dp_dn62A7pvwIAyd3rWaV4gh status: enum: - PENDING - CANCELLED - PROCESSING - DEPOSITED type: string amount: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USD - AUD - HKD - JPY - MXN - NZD - SGD - SEK - CHF - CAD - GBP - CZK - DKK - EUR type: string 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: enum: - USD - AUD - HKD - JPY - MXN - NZD - SGD - SEK - CHF - CAD - GBP - CZK - DKK - EUR type: string 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: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string 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 example: '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 identityId: type: string description: Identity ID that owns the deposit. Present for an individual's deposit, absent for an organization's. example: id_VfsdSMtd8UdgxCgTnz0tm organizationId: type: string description: Organization ID that owns the deposit. Present for an organization's deposit, absent for an individual's. example: org_RD2of9vs3XFodUSd8T5hW type: type: string enum: - RTP request: anyOf: - type: object required: - identityId - id - reference - wallet - updatedAt - createdAt - memo - status - quote properties: identityId: type: string description: Identity ID associated with the deposit request example: id_VfsdSMtd8UdgxCgTnz0tm id: type: string description: Unique identifier for a deposit request can be either the request ID or the deposit ID example: uswrdprq_BDDLyTbcILYHDs5vQqOwl 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 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' memo: type: string status: enum: - PENDING - PROCESSING - CANCELLED - DEPOSITED type: string quote: type: object required: - amountOut - fees - amountIn properties: amountOut: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string description: Fees associated with a deposit 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 description: Quote for the deposit title: Individual - type: object required: - organizationId - id - reference - wallet - updatedAt - createdAt - memo - status - quote properties: organizationId: type: string description: Organization ID associated with the deposit request example: org_RD2of9vs3XFodUSd8T5hW id: type: string description: Unique identifier for a deposit request can be either the request ID or the deposit ID example: uswrdprq_BDDLyTbcILYHDs5vQqOwl 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 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' memo: type: string status: enum: - PENDING - PROCESSING - CANCELLED - DEPOSITED type: string quote: type: object required: - amountOut - fees - amountIn properties: amountOut: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string description: Fees associated with a deposit 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 description: Quote for the deposit title: Organization title: RTP - type: object required: - wallet - reference - id - status - amount - quote - receipt - createdAt - type properties: wallet: type: object required: - address - blockchain properties: address: type: string description: Blockchain address or account blockchain: type: string 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." example: DR-123456789 id: type: string description: Unique identifier for a deposit instance example: dp_dn62A7pvwIAyd3rWaV4gh status: enum: - PENDING - CANCELLED - PROCESSING - DEPOSITED type: string amount: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USD - AUD - HKD - JPY - MXN - NZD - SGD - SEK - CHF - CAD - GBP - CZK - DKK - EUR type: string 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: enum: - USD - AUD - HKD - JPY - MXN - NZD - SGD - SEK - CHF - CAD - GBP - CZK - DKK - EUR type: string 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: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string 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 example: '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 identityId: type: string description: Identity ID that owns the deposit. Present for an individual's deposit, absent for an organization's. example: id_VfsdSMtd8UdgxCgTnz0tm organizationId: type: string description: Organization ID that owns the deposit. Present for an organization's deposit, absent for an individual's. example: org_RD2of9vs3XFodUSd8T5hW type: type: string enum: - FEDNOW request: anyOf: - type: object required: - identityId - id - reference - wallet - updatedAt - createdAt - memo - status - quote properties: identityId: type: string description: Identity ID associated with the deposit request example: id_VfsdSMtd8UdgxCgTnz0tm id: type: string description: Unique identifier for a deposit request can be either the request ID or the deposit ID example: uswrdprq_BDDLyTbcILYHDs5vQqOwl 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 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' memo: type: string status: enum: - PENDING - PROCESSING - CANCELLED - DEPOSITED type: string quote: type: object required: - amountOut - fees - amountIn properties: amountOut: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string description: Fees associated with a deposit 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 description: Quote for the deposit title: Individual - type: object required: - organizationId - id - reference - wallet - updatedAt - createdAt - memo - status - quote properties: organizationId: type: string description: Organization ID associated with the deposit request example: org_RD2of9vs3XFodUSd8T5hW id: type: string description: Unique identifier for a deposit request can be either the request ID or the deposit ID example: uswrdprq_BDDLyTbcILYHDs5vQqOwl 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 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' memo: type: string status: enum: - PENDING - PROCESSING - CANCELLED - DEPOSITED type: string quote: type: object required: - amountOut - fees - amountIn properties: amountOut: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string description: Fees associated with a deposit 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 description: Quote for the deposit title: Organization title: FEDNOW - type: object required: - wallet - reference - id - status - amount - quote - receipt - createdAt - type properties: wallet: type: object required: - address - blockchain properties: address: type: string description: Blockchain address or account blockchain: type: string 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." example: DR-123456789 id: type: string description: Unique identifier for a deposit instance example: dp_dn62A7pvwIAyd3rWaV4gh status: enum: - PENDING - CANCELLED - PROCESSING - DEPOSITED type: string amount: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USD - AUD - HKD - JPY - MXN - NZD - SGD - SEK - CHF - CAD - GBP - CZK - DKK - EUR type: string 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: enum: - USD - AUD - HKD - JPY - MXN - NZD - SGD - SEK - CHF - CAD - GBP - CZK - DKK - EUR type: string 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: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string 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 example: '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 identityId: type: string description: Identity ID that owns the deposit. Present for an individual's deposit, absent for an organization's. example: id_VfsdSMtd8UdgxCgTnz0tm organizationId: type: string description: Organization ID that owns the deposit. Present for an organization's deposit, absent for an individual's. example: org_RD2of9vs3XFodUSd8T5hW type: type: string enum: - ACH_CREDIT request: anyOf: - type: object required: - identityId - id - reference - wallet - updatedAt - createdAt - memo - status - quote properties: identityId: type: string description: Identity ID associated with the deposit request example: id_VfsdSMtd8UdgxCgTnz0tm id: type: string description: Unique identifier for a deposit request can be either the request ID or the deposit ID example: uswrdprq_BDDLyTbcILYHDs5vQqOwl 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 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' memo: type: string status: enum: - PENDING - PROCESSING - CANCELLED - DEPOSITED type: string quote: type: object required: - amountOut - fees - amountIn properties: amountOut: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string description: Fees associated with a deposit 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 description: Quote for the deposit title: Individual - type: object required: - organizationId - id - reference - wallet - updatedAt - createdAt - memo - status - quote properties: organizationId: type: string description: Organization ID associated with the deposit request example: org_RD2of9vs3XFodUSd8T5hW id: type: string description: Unique identifier for a deposit request can be either the request ID or the deposit ID example: uswrdprq_BDDLyTbcILYHDs5vQqOwl 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 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' memo: type: string status: enum: - PENDING - PROCESSING - CANCELLED - DEPOSITED type: string quote: type: object required: - amountOut - fees - amountIn properties: amountOut: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string description: Fees associated with a deposit 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 description: Quote for the deposit title: Organization originatorName: type: string description: Name of the party that originated the inbound ACH entry, as the bank reported it. effectiveEntryDate: type: string description: Effective Entry Date from the NACHA batch header of the inbound ACH entry, as an ISO date (`YYYY-MM-DD`). settlementDate: type: string description: Date the inbound ACH entry settled, as an ISO date (`YYYY-MM-DD`). secCode: type: string description: Standard Entry Class code of the inbound ACH entry, such as `CCD` or `PPD`. companyId: type: string description: Company Identification from the NACHA batch header (positions 41-50) of the inbound ACH entry. companyName: type: string description: Company Name from the NACHA batch header (positions 5-20) of the inbound ACH entry. achTraceId: type: string description: Fed trace number of the inbound ACH entry. Quote this to the originating bank when tracing the payment. addenda: type: string description: Payment-related information from the type-05 addenda record of the inbound ACH entry, as the bank reported it. Present only when the entry carried an addenda record. companyEntryDescription: type: string description: Company Entry Description from the NACHA batch header (positions 54-63) of the inbound ACH entry — the originator's description of the batch, e.g. `PAYROLL`. companyDiscretionaryData: type: string description: Company Discretionary Data from the NACHA batch header (positions 21-40) of the inbound ACH entry — free-form text set by the originator. title: ACH_CREDIT - type: object required: - wallet - reference - id - status - amount - quote - receipt - createdAt - type properties: wallet: type: object required: - address - blockchain properties: address: type: string description: Blockchain address or account blockchain: type: string 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." example: DR-123456789 id: type: string description: Unique identifier for a deposit instance example: dp_dn62A7pvwIAyd3rWaV4gh status: enum: - PENDING - CANCELLED - PROCESSING - DEPOSITED type: string amount: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USD - AUD - HKD - JPY - MXN - NZD - SGD - SEK - CHF - CAD - GBP - CZK - DKK - EUR type: string 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: enum: - USD - AUD - HKD - JPY - MXN - NZD - SGD - SEK - CHF - CAD - GBP - CZK - DKK - EUR type: string 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: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string 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 example: '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 identityId: type: string description: Identity ID that owns the deposit. Present for an individual's deposit, absent for an organization's. example: id_VfsdSMtd8UdgxCgTnz0tm organizationId: type: string description: Organization ID that owns the deposit. Present for an organization's deposit, absent for an individual's. example: org_RD2of9vs3XFodUSd8T5hW type: type: string enum: - US_BANK_ACH request: anyOf: - type: object required: - identityId - id - reference - wallet - updatedAt - createdAt - status - sourcePaymentInstrumentId - amount - quote properties: identityId: type: string description: Identity ID associated with the deposit request example: id_VfsdSMtd8UdgxCgTnz0tm id: type: string description: Unique identifier for a deposit request, can be either the request id or the deposit id example: 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." example: DR-123456789 wallet: type: object required: - address - blockchain properties: address: type: string description: Blockchain address or account blockchain: type: string 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' status: enum: - CREATED - PROCESSING - SUCCEEDED - FAILED - CANCELLED type: string sourcePaymentInstrumentId: type: string description: ID for a US_ACH payment instrument example: 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 an eligible ledger account. example: same-day quote: type: object required: - amountOut - fees - amountIn properties: amountOut: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string description: Fees associated with a deposit 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 description: Quote for the deposit title: Individual - type: object required: - organizationId - id - reference - wallet - updatedAt - createdAt - status - sourcePaymentInstrumentId - amount - quote properties: organizationId: type: string description: Organization ID associated with the deposit request example: org_RD2of9vs3XFodUSd8T5hW id: type: string description: Unique identifier for a deposit request, can be either the request id or the deposit id example: 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." example: DR-123456789 wallet: type: object required: - address - blockchain properties: address: type: string description: Blockchain address or account blockchain: type: string 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' status: enum: - CREATED - PROCESSING - SUCCEEDED - FAILED - CANCELLED type: string sourcePaymentInstrumentId: type: string description: ID for a US_ACH payment instrument example: 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 an eligible ledger account. example: same-day quote: type: object required: - amountOut - fees - amountIn properties: amountOut: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string description: Fees associated with a deposit 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 description: Quote for the deposit title: Organization title: US_BANK_ACH - type: object required: - wallet - reference - id - status - amount - quote - receipt - createdAt - type properties: wallet: type: object required: - address - blockchain properties: address: type: string description: Blockchain address or account blockchain: type: string 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." example: DR-123456789 id: type: string description: Unique identifier for a deposit instance example: dp_dn62A7pvwIAyd3rWaV4gh status: enum: - PENDING - CANCELLED - PROCESSING - DEPOSITED type: string amount: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USD - AUD - HKD - JPY - MXN - NZD - SGD - SEK - CHF - CAD - GBP - CZK - DKK - EUR type: string 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: enum: - USD - AUD - HKD - JPY - MXN - NZD - SGD - SEK - CHF - CAD - GBP - CZK - DKK - EUR type: string 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: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string 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 example: '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 identityId: type: string description: Identity ID that owns the deposit. Present for an individual's deposit, absent for an organization's. example: id_VfsdSMtd8UdgxCgTnz0tm organizationId: type: string description: Organization ID that owns the deposit. Present for an organization's deposit, absent for an individual's. example: org_RD2of9vs3XFodUSd8T5hW type: type: string enum: - US_WIRE request: anyOf: - type: object required: - identityId - id - reference - wallet - updatedAt - createdAt - memo - status - quote properties: identityId: type: string description: Identity ID associated with the deposit request example: id_VfsdSMtd8UdgxCgTnz0tm id: type: string description: Unique identifier for a deposit request can be either the request ID or the deposit ID example: uswrdprq_BDDLyTbcILYHDs5vQqOwl 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 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' memo: type: string status: enum: - PENDING - PROCESSING - CANCELLED - DEPOSITED type: string quote: type: object required: - amountOut - fees - amountIn properties: amountOut: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string description: Fees associated with a deposit 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 description: Quote for the deposit title: Individual - type: object required: - organizationId - id - reference - wallet - updatedAt - createdAt - memo - status - quote properties: organizationId: type: string description: Organization ID associated with the deposit request example: org_RD2of9vs3XFodUSd8T5hW id: type: string description: Unique identifier for a deposit request can be either the request ID or the deposit ID example: uswrdprq_BDDLyTbcILYHDs5vQqOwl 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 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' memo: type: string status: enum: - PENDING - PROCESSING - CANCELLED - DEPOSITED type: string quote: type: object required: - amountOut - fees - amountIn properties: amountOut: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string description: Fees associated with a deposit 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 description: Quote for the deposit title: Organization imad: type: string omad: type: string senderName: type: string ffcMemo: type: string description: For-further-credit memo carried on the inbound wire — the reference the sender used to identify the beneficiary. Present only when the bank reported it. sendingFI: type: object required: - code - name properties: code: type: string description: Fedwire routing number of the sending financial institution. name: type: string description: Name of the sending financial institution. description: The financial institution that sent the wire, as the receiving bank reported it. Present only when the bank reported it. originatorInfo: type: string description: The originator of the wire — the sender's name and account as the wire carried them. Present only when the bank reported it. originatorAddressLine1: type: string description: First line of the originator's postal address, as the wire carried it. Present only when the bank reported it. originatorAddressLine2: type: string description: Second line of the originator's postal address, as the wire carried it. Present only when the bank reported it. originatorAddressLine3: type: string description: Third line of the originator's postal address, as the wire carried it. Present only when the bank reported it. originatingFI: type: string description: The financial institution where the wire originated, which is not always the sending institution. Present only when the bank reported it. title: US_WIRE - type: object required: - wallet - reference - id - status - amount - quote - receipt - createdAt - type properties: wallet: type: object required: - address - blockchain properties: address: type: string description: Blockchain address or account blockchain: type: string 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." example: DR-123456789 id: type: string description: Unique identifier for a deposit instance example: dp_dn62A7pvwIAyd3rWaV4gh status: enum: - PENDING - CANCELLED - PROCESSING - DEPOSITED type: string amount: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USD - AUD - HKD - JPY - MXN - NZD - SGD - SEK - CHF - CAD - GBP - CZK - DKK - EUR type: string 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: enum: - USD - AUD - HKD - JPY - MXN - NZD - SGD - SEK - CHF - CAD - GBP - CZK - DKK - EUR type: string 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: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string 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 example: '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 identityId: type: string description: Identity ID that owns the deposit. Present for an individual's deposit, absent for an organization's. example: id_VfsdSMtd8UdgxCgTnz0tm organizationId: type: string description: Organization ID that owns the deposit. Present for an organization's deposit, absent for an individual's. example: org_RD2of9vs3XFodUSd8T5hW type: type: string enum: - SWIFT_WIRE request: anyOf: - type: object required: - identityId - id - reference - wallet - updatedAt - createdAt - memo - status - quote properties: identityId: type: string description: Identity ID associated with the deposit request example: id_VfsdSMtd8UdgxCgTnz0tm id: type: string description: Unique identifier for a deposit request can be either the request ID or the deposit ID example: uswrdprq_BDDLyTbcILYHDs5vQqOwl 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 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' memo: type: string status: enum: - PENDING - PROCESSING - CANCELLED - DEPOSITED type: string quote: type: object required: - amountOut - fees - amountIn properties: amountOut: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string description: Fees associated with a deposit 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 description: Quote for the deposit title: Individual - type: object required: - organizationId - id - reference - wallet - updatedAt - createdAt - memo - status - quote properties: organizationId: type: string description: Organization ID associated with the deposit request example: org_RD2of9vs3XFodUSd8T5hW id: type: string description: Unique identifier for a deposit request can be either the request ID or the deposit ID example: uswrdprq_BDDLyTbcILYHDs5vQqOwl 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 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' memo: type: string status: enum: - PENDING - PROCESSING - CANCELLED - DEPOSITED type: string quote: type: object required: - amountOut - fees - amountIn properties: amountOut: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string description: Fees associated with a deposit 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 description: Quote for the deposit title: Organization imad: type: string omad: type: string senderName: type: string ffcMemo: type: string description: For-further-credit memo carried on the inbound wire — the reference the sender used to identify the beneficiary. Present only when the bank reported it. sendingFI: type: object required: - code - name properties: code: type: string description: Identifier of the sending financial institution — a SWIFT BIC on this rail. name: type: string description: Name of the sending financial institution. description: The financial institution that sent the wire, as the receiving bank reported it. Present only when the bank reported it. originatorInfo: type: string description: The originator of the wire — the sender's name and account as the wire carried them. Present only when the bank reported it. originatorAddressLine1: type: string description: First line of the originator's postal address, as the wire carried it. Present only when the bank reported it. originatorAddressLine2: type: string description: Second line of the originator's postal address, as the wire carried it. Present only when the bank reported it. originatorAddressLine3: type: string description: Third line of the originator's postal address, as the wire carried it. Present only when the bank reported it. originatingFI: type: string description: The financial institution where the wire originated, which is not always the sending institution. Present only when the bank reported it. 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 '403': description: The credentials are valid but the caller is not permitted to transact content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - FORBIDDEN message: type: string title: FORBIDDEN description: The credentials are valid but the caller is not permitted to transact '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 operationId: getV1DepositById x-operation-id-source: derived /v1/deposit: get: summary: Search Deposits tags: - Deposit description: 'Search deposits across all payment instruments for a given identityId or organizationId. Deposits can be further filtered by populating the `status` and `reference` parameters. Note 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: ^\s*(PENDING|CANCELLED|PROCESSING|DEPOSITED)\s*(,\s*(PENDING|CANCELLED|PROCESSING|DEPOSITED)\s*)*$ example: PENDING,PROCESSING in: query name: status required: false description: Comma-separated list of deposit statuses to filter on - schema: enum: - CASH - US_BANK_ACH - ACH_CREDIT - RTP - FEDNOW - US_WIRE - SWIFT_WIRE type: string 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: - type: object required: - identityId - wallet - reference - id - type - status - amount - quote - receipt - createdAt properties: identityId: type: string description: Identity ID associated with the deposit request example: id_VfsdSMtd8UdgxCgTnz0tm wallet: type: object required: - address - blockchain properties: address: type: string description: Blockchain address or account blockchain: type: string 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." example: DR-123456789 id: type: string description: Unique identifier for a deposit instance example: dp_dn62A7pvwIAyd3rWaV4gh type: enum: - CASH - US_BANK_ACH - ACH_CREDIT - RTP - FEDNOW - US_WIRE - SWIFT_WIRE type: string status: enum: - PENDING - CANCELLED - PROCESSING - DEPOSITED type: string amount: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USD - AUD - HKD - JPY - MXN - NZD - SGD - SEK - CHF - CAD - GBP - CZK - DKK - EUR type: string 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: enum: - USD - AUD - HKD - JPY - MXN - NZD - SGD - SEK - CHF - CAD - GBP - CZK - DKK - EUR type: string 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: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string 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 example: '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 title: Individual - type: object required: - organizationId - wallet - reference - id - type - status - amount - quote - receipt - createdAt properties: organizationId: type: string description: Organization ID associated with the deposit request example: org_RD2of9vs3XFodUSd8T5hW wallet: type: object required: - address - blockchain properties: address: type: string description: Blockchain address or account blockchain: type: string 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." example: DR-123456789 id: type: string description: Unique identifier for a deposit instance example: dp_dn62A7pvwIAyd3rWaV4gh type: enum: - CASH - US_BANK_ACH - ACH_CREDIT - RTP - FEDNOW - US_WIRE - SWIFT_WIRE type: string status: enum: - PENDING - CANCELLED - PROCESSING - DEPOSITED type: string amount: type: object required: - amount - currency properties: amount: type: number description: Amount of the nominated currency currency: enum: - USD - AUD - HKD - JPY - MXN - NZD - SGD - SEK - CHF - CAD - GBP - CZK - DKK - EUR type: string 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: enum: - USD - AUD - HKD - JPY - MXN - NZD - SGD - SEK - CHF - CAD - GBP - CZK - DKK - EUR type: string 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: enum: - USDC - MOVEUSD type: string 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: enum: - USDC - MOVEUSD type: string description: Amount of the nominated currency description: Amount associated with this deposit type: enum: - CFX_FIXED_FEE - CFX_VARIABLE_FEE - PROVIDER_FIXED_FEE - PROVIDER_VARIABLE_FEE - CUSTOMER_FIXED_FEE - CUSTOMER_VARIABLE_FEE type: string 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 example: '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 title: Organization 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 '403': description: The credentials are valid but the caller is not permitted to transact content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - FORBIDDEN message: type: string title: FORBIDDEN description: The credentials are valid but the caller is not permitted to transact 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 operationId: getV1Deposit x-operation-id-source: derived /v1/deposit/estimate: get: summary: Estimate Deposit Fees tags: - Deposit description: 'Preview the effective fees and quote math for a deposit without creating one. Resolves 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: enum: - deposit.us_cash.v1 - deposit.rtp.v1 - deposit.fednow.v1 - deposit.us_bank_ach.v1 - deposit.ach_credit.v1 - deposit.us_wire.v1 - deposit.swift_wire.v1 type: string 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: enum: - PROVIDER - CFX - CUSTOMER type: string feeAmount: type: string description: Fixed fee amount as a number string, in the source currency example: '0.45' title: FIXED - type: object required: - type - receiver - feeBps properties: type: type: string enum: - VARIABLE receiver: enum: - PROVIDER - CFX - CUSTOMER type: string feeBps: type: string description: Variable fee in basis points (number string) of the source amount, e.g. `120` is 1.2% example: '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 example: '100.00' targetAmountAfterFees: type: string example: '98.80' fees: type: array items: type: object required: - receiver - type - amount properties: receiver: enum: - PROVIDER - CFX - CUSTOMER type: string type: enum: - FIXED - VARIABLE type: string amount: type: string description: Concrete fee amount as a number string, in source currency example: '1.20' totalFees: type: string example: '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 '403': description: The credentials are valid but the caller is not permitted to transact content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - FORBIDDEN message: type: string title: FORBIDDEN description: The credentials are valid but the caller is not permitted to transact '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 operationId: getV1DepositEstimate x-operation-id-source: derived /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: type: object required: - name - limits - usage24hUsd - usage24hCount - usage7dUsd - usage7dCount - usage30dUsd - usage30dCount - usageCalendarMonthUsd - usageCalendarMonthCount properties: name: enum: - organization.v1 - identity.v1 - card.physical_card.v1 - card.virtual_card.v1 - deposit.us_cash.v1 - deposit.rtp.v1 - deposit.fednow.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 type: string limits: type: object required: - transactionMinUsd - transactionMaxUsd - limit24hMaxUsd - limit24hMaxCount - limit7dMaxUsd - limit7dMaxCount - limit30dMaxUsd - limit30dMaxCount - limitCalendarMonthMaxUsd - limitCalendarMonthMaxCount properties: transactionMinUsd: anyOf: - type: string - type: 'null' transactionMaxUsd: anyOf: - type: string - type: 'null' limit24hMaxUsd: anyOf: - type: string - type: 'null' limit24hMaxCount: anyOf: - type: string - type: 'null' limit7dMaxUsd: anyOf: - type: string - type: 'null' limit7dMaxCount: anyOf: - type: string - type: 'null' limit30dMaxUsd: anyOf: - type: string - type: 'null' limit30dMaxCount: anyOf: - type: string - type: 'null' limitCalendarMonthMaxUsd: anyOf: - type: string - type: 'null' limitCalendarMonthMaxCount: anyOf: - type: string - type: 'null' 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 decimal strings. 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: 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 decimal strings; counts are integer 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 '403': description: The credentials are valid but the caller is not permitted to transact content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - FORBIDDEN message: type: string title: FORBIDDEN description: The credentials are valid but the caller is not permitted to transact '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 operationId: getV1DepositUsage x-operation-id-source: derived components: securitySchemes: ApiKeyAuth: name: x-api-key type: apiKey in: header ApiSecretAuth: name: x-api-secret type: apiKey in: header externalDocs: description: Find out more about CFX url: https://www.cfxlabs.com/