openapi: 3.2.0 info: title: Identity Deposit Memos API description: Registration, verification and management of CFX identities associated with financial transactions on the CFX network. termsOfService: '' contact: name: API Owner email: api@cfxlabs.com license: name: '' url: '' version: '@VERSION@' summary: CFX Identity API servers: - url: https://api.dev.cfx.to description: Customer Sandbox - url: https://api.cfx.to description: Production security: - ApiKeyAuth: [] ApiSecretAuth: [] tags: - name: Deposit Memos description: Memos that route inbound deposits to a ledger account. paths: /v1/identity/{identityId}/ledger-accounts/{accountId}/deposit-memos: post: summary: Create a deposit memo for an identity's ledger account tags: - Deposit Memos description: 'Include this memo in your deposit and the funds will be sent to the given ledger account. Only one recurring memo can be created for the same method and currency type. **Important:** When using the instructions, ensure all fields match the instruction values exactly so the funds are routed correctly. Do no add any other information but what is provided into memo/reference/message field when making a deposit.' requestBody: required: true content: application/json: schema: type: object required: - sourceCurrency - method properties: name: type: string description: Human-readable name for the memo sourceCurrency: anyOf: - type: string description: US Dollar enum: - USD - type: string description: Australian Dollar enum: - AUD - type: string description: Hong Kong Dollar enum: - HKD - type: string description: Japanese Yen enum: - JPY - type: string description: Mexico Peso enum: - MXN - type: string description: New Zealand Dollar enum: - NZD - type: string description: Singapore Dollar enum: - SGD - type: string description: Swedish Krona enum: - SEK - type: string description: Swiss Franc enum: - CHF - type: string description: Canadian Dollar enum: - CAD - type: string description: British Pound enum: - GBP - type: string description: Czech Koruna enum: - CZK - type: string description: Danish Krone enum: - DKK - type: string description: Euro enum: - EUR description: ISO currency code for the funds that will be deposited. Non-USD currencies only apply to SWIFT wire. method: enum: - US_WIRE - SWIFT_WIRE type: string frequency: enum: - ONE_TIME - RECURRING type: string description: Whether the memo is one-use only (consumed and unusable after first use) or if it can be used in multiple deposits default: RECURRING parameters: - schema: type: string example: redwal_xxxxxxxx in: path name: accountId required: true description: The unique identifier for the account - schema: type: string example: id_xxxxxxxxxx in: path name: identityId required: true description: The unique identifier for the identity that owns the account - schema: type: string in: header name: Idempotency-Key required: false responses: '200': description: Default Response content: application/json: schema: anyOf: - type: object required: - memo - status - sourceCurrency - frequency - createdAt - updatedAt - method - instructions properties: memo: type: string description: 'The memo, to be entered into memo/reference/message field when making a deposit. *Important:** Do not add any other information but what is provided in this field to ensure funds are routed correctly.' status: enum: - ACTIVE - DISABLED - CONSUMED type: string description: Whether the memo is active or disabled. One-time memos can also be `CONSUMED` after use. name: type: string description: Human-readable name for the memo sourceCurrency: anyOf: - type: string description: US Dollar enum: - USD - type: string description: Australian Dollar enum: - AUD - type: string description: Hong Kong Dollar enum: - HKD - type: string description: Japanese Yen enum: - JPY - type: string description: Mexico Peso enum: - MXN - type: string description: New Zealand Dollar enum: - NZD - type: string description: Singapore Dollar enum: - SGD - type: string description: Swedish Krona enum: - SEK - type: string description: Swiss Franc enum: - CHF - type: string description: Canadian Dollar enum: - CAD - type: string description: British Pound enum: - GBP - type: string description: Czech Koruna enum: - CZK - type: string description: Danish Krone enum: - DKK - type: string description: Euro enum: - EUR description: ISO currency code for the funds that will be deposited. Non-USD currencies only apply to SWIFT wire. frequency: enum: - ONE_TIME - RECURRING type: string description: Whether the memo is one-use only (consumed and unusable after first use) or if it can be used in multiple deposits consumedAt: type: string format: date-time description: The timestamp of when this one-time memo was consumed createdAt: type: string format: date-time description: The timestamp of when this memo was created updatedAt: type: string format: date-time description: The timestamp of when this memo was last updated method: enum: - US_WIRE type: string instructions: type: object required: - memo - routingNumber - accountNumber - bank - beneficiary properties: memo: type: string description: 'The memo, to be entered into memo/reference/message field when making a deposit. *Important:** Do not add any other information but what is provided in this field to ensure funds are routed correctly.' routingNumber: type: string accountNumber: type: string bank: type: object required: - name - address properties: name: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code beneficiary: type: object required: - name - address properties: name: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code title: US Wire - type: object required: - memo - status - sourceCurrency - frequency - createdAt - updatedAt - method - instructions properties: memo: type: string description: 'The memo, to be entered into memo/reference/message field when making a deposit. *Important:** Do not add any other information but what is provided in this field to ensure funds are routed correctly.' status: enum: - ACTIVE - DISABLED - CONSUMED type: string description: Whether the memo is active or disabled. One-time memos can also be `CONSUMED` after use. name: type: string description: Human-readable name for the memo sourceCurrency: anyOf: - type: string description: US Dollar enum: - USD - type: string description: Australian Dollar enum: - AUD - type: string description: Hong Kong Dollar enum: - HKD - type: string description: Japanese Yen enum: - JPY - type: string description: Mexico Peso enum: - MXN - type: string description: New Zealand Dollar enum: - NZD - type: string description: Singapore Dollar enum: - SGD - type: string description: Swedish Krona enum: - SEK - type: string description: Swiss Franc enum: - CHF - type: string description: Canadian Dollar enum: - CAD - type: string description: British Pound enum: - GBP - type: string description: Czech Koruna enum: - CZK - type: string description: Danish Krone enum: - DKK - type: string description: Euro enum: - EUR description: ISO currency code for the funds that will be deposited. Non-USD currencies only apply to SWIFT wire. frequency: enum: - ONE_TIME - RECURRING type: string description: Whether the memo is one-use only (consumed and unusable after first use) or if it can be used in multiple deposits consumedAt: type: string format: date-time description: The timestamp of when this one-time memo was consumed createdAt: type: string format: date-time description: The timestamp of when this memo was created updatedAt: type: string format: date-time description: The timestamp of when this memo was last updated method: enum: - SWIFT_WIRE type: string instructions: anyOf: - type: object required: - memo - swiftCode - accountNumber - swiftField70 - bank - intermediaryBank - beneficiary properties: memo: type: string description: 'The memo, to be entered into memo/reference/message field when making a deposit. *Important:** Do not add any other information but what is provided in this field to ensure funds are routed correctly.' swiftCode: type: string accountNumber: type: string swiftField70: type: array items: type: string bank: type: object required: - name - address properties: name: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code intermediaryBank: type: object required: - name - swiftCode - address properties: name: type: string swiftCode: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code beneficiary: type: object required: - name - accountNumber - address properties: name: type: string accountNumber: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code title: International SWIFT instructions - type: object required: - memo - swiftCode - accountNumber - swiftField70 - bank - beneficiary - routingNumber properties: memo: type: string description: 'The memo, to be entered into memo/reference/message field when making a deposit. *Important:** Do not add any other information but what is provided in this field to ensure funds are routed correctly.' swiftCode: type: string accountNumber: type: string swiftField70: type: array items: type: string bank: type: object required: - name - address properties: name: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code beneficiary: type: object required: - name - accountNumber - address properties: name: type: string accountNumber: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code routingNumber: type: string title: USD SWIFT instructions description: USD SWIFT instructions title: SWIFT Wire '400': description: Default Response content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - INVALID_REQUEST - INVALID_METHOD - INVALID_IDENTITY - DUPLICATE - INVALID_CURRENCY description: '- `INVALID_REQUEST`: The service cannot understand the request - `INVALID_METHOD`: This method is not available for the provided configuration. - `INVALID_IDENTITY`: The identity is not allowed to create a deposit memo - `DUPLICATE`: The provide method and currency combination already has a memo. - `INVALID_CURRENCY`: This currency is not available for the provided configuration.' message: type: string errors: type: array items: type: object properties: {} additionalProperties: true '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 '409': description: A duplicate request with this idempotency key is already in progress content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - IDEMPOTENCY_IN_PROGRESS message: type: string title: IDEMPOTENCY_IN_PROGRESS description: A duplicate request with this idempotency key is already in progress '422': description: Another request with this idempotency key was made using a different body content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - IDEMPOTENCY_KEY_REUSED message: type: string title: IDEMPOTENCY_KEY_REUSED description: Another request with this idempotency key was made using a different body default: description: Catch-all error response for any unexpected internal errors content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - INTERNAL message: type: string enum: - An unexpected internal error has occurred title: INTERNAL description: Catch-all error response for any unexpected internal errors operationId: postV1IdentityByIdentityIdLedgerAccountsByAccountIdDepositMemos x-operation-id-source: derived get: summary: Search for deposit memos for a ledger account of an identity tags: - Deposit Memos parameters: - schema: type: string in: query name: methods required: false description: 'Comma-separated list of deposit methods. Possible values: `SWIFT_WIRE`, `US_WIRE`.' - schema: type: string in: query name: statuses required: false description: 'Comma-separated list of deposit methods. Possible values: `ACTIVE`, `CONSUMED`, `DISABLED`.' - schema: type: string in: query name: sourceCurrencies required: false description: Comma-separated list of ISO currency codes - schema: type: string in: query name: frequencies required: false description: 'Comma-separated list of frequency types. Possible values: `ONE_TIME`, `RECURRING`.' - schema: type: string format: date-time in: query name: createdBefore required: false - schema: type: string format: date-time in: query name: createdAfter required: false - schema: type: string format: date-time in: query name: updatedBefore required: false - schema: type: string format: date-time in: query name: updatedAfter required: false - schema: type: string in: query name: orderBy required: false description: 'Comma-separated list of fields and directions to order the results by. Format: `:,...` * ``: `createdAt`, `updatedAt` * ``: `ASC`, `DESC`' - schema: type: integer default: 1 in: query name: page required: false description: Result page number to return, starting from 1 - schema: type: integer default: 10 maximum: 100 in: query name: pageSize required: false description: Items per page to return - schema: type: string example: redwal_xxxxxxxx in: path name: accountId required: true description: The unique identifier for the account - schema: type: string example: id_xxxxxxxxxx in: path name: identityId required: true description: The unique identifier for the identity that owns the account responses: '200': description: Default Response content: application/json: schema: type: object required: - hasNext - items properties: hasNext: type: boolean description: Whether there are more pages for this search result items: type: array items: anyOf: - type: object required: - memo - status - sourceCurrency - frequency - createdAt - updatedAt - method - instructions properties: memo: type: string description: 'The memo, to be entered into memo/reference/message field when making a deposit. *Important:** Do not add any other information but what is provided in this field to ensure funds are routed correctly.' status: enum: - ACTIVE - DISABLED - CONSUMED type: string description: Whether the memo is active or disabled. One-time memos can also be `CONSUMED` after use. name: type: string description: Human-readable name for the memo sourceCurrency: anyOf: - type: string description: US Dollar enum: - USD - type: string description: Australian Dollar enum: - AUD - type: string description: Hong Kong Dollar enum: - HKD - type: string description: Japanese Yen enum: - JPY - type: string description: Mexico Peso enum: - MXN - type: string description: New Zealand Dollar enum: - NZD - type: string description: Singapore Dollar enum: - SGD - type: string description: Swedish Krona enum: - SEK - type: string description: Swiss Franc enum: - CHF - type: string description: Canadian Dollar enum: - CAD - type: string description: British Pound enum: - GBP - type: string description: Czech Koruna enum: - CZK - type: string description: Danish Krone enum: - DKK - type: string description: Euro enum: - EUR description: ISO currency code for the funds that will be deposited. Non-USD currencies only apply to SWIFT wire. frequency: enum: - ONE_TIME - RECURRING type: string description: Whether the memo is one-use only (consumed and unusable after first use) or if it can be used in multiple deposits consumedAt: type: string format: date-time description: The timestamp of when this one-time memo was consumed createdAt: type: string format: date-time description: The timestamp of when this memo was created updatedAt: type: string format: date-time description: The timestamp of when this memo was last updated method: enum: - US_WIRE type: string instructions: type: object required: - memo - routingNumber - accountNumber - bank - beneficiary properties: memo: type: string description: 'The memo, to be entered into memo/reference/message field when making a deposit. *Important:** Do not add any other information but what is provided in this field to ensure funds are routed correctly.' routingNumber: type: string accountNumber: type: string bank: type: object required: - name - address properties: name: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code beneficiary: type: object required: - name - address properties: name: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code title: US Wire - type: object required: - memo - status - sourceCurrency - frequency - createdAt - updatedAt - method - instructions properties: memo: type: string description: 'The memo, to be entered into memo/reference/message field when making a deposit. *Important:** Do not add any other information but what is provided in this field to ensure funds are routed correctly.' status: enum: - ACTIVE - DISABLED - CONSUMED type: string description: Whether the memo is active or disabled. One-time memos can also be `CONSUMED` after use. name: type: string description: Human-readable name for the memo sourceCurrency: anyOf: - type: string description: US Dollar enum: - USD - type: string description: Australian Dollar enum: - AUD - type: string description: Hong Kong Dollar enum: - HKD - type: string description: Japanese Yen enum: - JPY - type: string description: Mexico Peso enum: - MXN - type: string description: New Zealand Dollar enum: - NZD - type: string description: Singapore Dollar enum: - SGD - type: string description: Swedish Krona enum: - SEK - type: string description: Swiss Franc enum: - CHF - type: string description: Canadian Dollar enum: - CAD - type: string description: British Pound enum: - GBP - type: string description: Czech Koruna enum: - CZK - type: string description: Danish Krone enum: - DKK - type: string description: Euro enum: - EUR description: ISO currency code for the funds that will be deposited. Non-USD currencies only apply to SWIFT wire. frequency: enum: - ONE_TIME - RECURRING type: string description: Whether the memo is one-use only (consumed and unusable after first use) or if it can be used in multiple deposits consumedAt: type: string format: date-time description: The timestamp of when this one-time memo was consumed createdAt: type: string format: date-time description: The timestamp of when this memo was created updatedAt: type: string format: date-time description: The timestamp of when this memo was last updated method: enum: - SWIFT_WIRE type: string instructions: anyOf: - type: object required: - memo - swiftCode - accountNumber - swiftField70 - bank - intermediaryBank - beneficiary properties: memo: type: string description: 'The memo, to be entered into memo/reference/message field when making a deposit. *Important:** Do not add any other information but what is provided in this field to ensure funds are routed correctly.' swiftCode: type: string accountNumber: type: string swiftField70: type: array items: type: string bank: type: object required: - name - address properties: name: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code intermediaryBank: type: object required: - name - swiftCode - address properties: name: type: string swiftCode: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code beneficiary: type: object required: - name - accountNumber - address properties: name: type: string accountNumber: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code title: International SWIFT instructions - type: object required: - memo - swiftCode - accountNumber - swiftField70 - bank - beneficiary - routingNumber properties: memo: type: string description: 'The memo, to be entered into memo/reference/message field when making a deposit. *Important:** Do not add any other information but what is provided in this field to ensure funds are routed correctly.' swiftCode: type: string accountNumber: type: string swiftField70: type: array items: type: string bank: type: object required: - name - address properties: name: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code beneficiary: type: object required: - name - accountNumber - address properties: name: type: string accountNumber: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code routingNumber: type: string title: USD SWIFT instructions description: USD SWIFT instructions 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: getV1IdentityByIdentityIdLedgerAccountsByAccountIdDepositMemos x-operation-id-source: derived /v1/identity/{identityId}/ledger-accounts/{accountId}/deposit-memos/{memo}: get: summary: Get a deposit memo details for an identity's ledger account tags: - Deposit Memos parameters: - schema: type: string in: path name: memo required: true description: The memo - schema: type: string example: redwal_xxxxxxxx in: path name: accountId required: true description: The unique identifier for the account - schema: type: string example: id_xxxxxxxxxx in: path name: identityId required: true description: The unique identifier for the identity that owns the account responses: '200': description: Default Response content: application/json: schema: anyOf: - type: object required: - memo - status - sourceCurrency - frequency - createdAt - updatedAt - method - instructions properties: memo: type: string description: 'The memo, to be entered into memo/reference/message field when making a deposit. *Important:** Do not add any other information but what is provided in this field to ensure funds are routed correctly.' status: enum: - ACTIVE - DISABLED - CONSUMED type: string description: Whether the memo is active or disabled. One-time memos can also be `CONSUMED` after use. name: type: string description: Human-readable name for the memo sourceCurrency: anyOf: - type: string description: US Dollar enum: - USD - type: string description: Australian Dollar enum: - AUD - type: string description: Hong Kong Dollar enum: - HKD - type: string description: Japanese Yen enum: - JPY - type: string description: Mexico Peso enum: - MXN - type: string description: New Zealand Dollar enum: - NZD - type: string description: Singapore Dollar enum: - SGD - type: string description: Swedish Krona enum: - SEK - type: string description: Swiss Franc enum: - CHF - type: string description: Canadian Dollar enum: - CAD - type: string description: British Pound enum: - GBP - type: string description: Czech Koruna enum: - CZK - type: string description: Danish Krone enum: - DKK - type: string description: Euro enum: - EUR description: ISO currency code for the funds that will be deposited. Non-USD currencies only apply to SWIFT wire. frequency: enum: - ONE_TIME - RECURRING type: string description: Whether the memo is one-use only (consumed and unusable after first use) or if it can be used in multiple deposits consumedAt: type: string format: date-time description: The timestamp of when this one-time memo was consumed createdAt: type: string format: date-time description: The timestamp of when this memo was created updatedAt: type: string format: date-time description: The timestamp of when this memo was last updated method: enum: - US_WIRE type: string instructions: type: object required: - memo - routingNumber - accountNumber - bank - beneficiary properties: memo: type: string description: 'The memo, to be entered into memo/reference/message field when making a deposit. *Important:** Do not add any other information but what is provided in this field to ensure funds are routed correctly.' routingNumber: type: string accountNumber: type: string bank: type: object required: - name - address properties: name: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code beneficiary: type: object required: - name - address properties: name: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code title: US Wire - type: object required: - memo - status - sourceCurrency - frequency - createdAt - updatedAt - method - instructions properties: memo: type: string description: 'The memo, to be entered into memo/reference/message field when making a deposit. *Important:** Do not add any other information but what is provided in this field to ensure funds are routed correctly.' status: enum: - ACTIVE - DISABLED - CONSUMED type: string description: Whether the memo is active or disabled. One-time memos can also be `CONSUMED` after use. name: type: string description: Human-readable name for the memo sourceCurrency: anyOf: - type: string description: US Dollar enum: - USD - type: string description: Australian Dollar enum: - AUD - type: string description: Hong Kong Dollar enum: - HKD - type: string description: Japanese Yen enum: - JPY - type: string description: Mexico Peso enum: - MXN - type: string description: New Zealand Dollar enum: - NZD - type: string description: Singapore Dollar enum: - SGD - type: string description: Swedish Krona enum: - SEK - type: string description: Swiss Franc enum: - CHF - type: string description: Canadian Dollar enum: - CAD - type: string description: British Pound enum: - GBP - type: string description: Czech Koruna enum: - CZK - type: string description: Danish Krone enum: - DKK - type: string description: Euro enum: - EUR description: ISO currency code for the funds that will be deposited. Non-USD currencies only apply to SWIFT wire. frequency: enum: - ONE_TIME - RECURRING type: string description: Whether the memo is one-use only (consumed and unusable after first use) or if it can be used in multiple deposits consumedAt: type: string format: date-time description: The timestamp of when this one-time memo was consumed createdAt: type: string format: date-time description: The timestamp of when this memo was created updatedAt: type: string format: date-time description: The timestamp of when this memo was last updated method: enum: - SWIFT_WIRE type: string instructions: anyOf: - type: object required: - memo - swiftCode - accountNumber - swiftField70 - bank - intermediaryBank - beneficiary properties: memo: type: string description: 'The memo, to be entered into memo/reference/message field when making a deposit. *Important:** Do not add any other information but what is provided in this field to ensure funds are routed correctly.' swiftCode: type: string accountNumber: type: string swiftField70: type: array items: type: string bank: type: object required: - name - address properties: name: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code intermediaryBank: type: object required: - name - swiftCode - address properties: name: type: string swiftCode: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code beneficiary: type: object required: - name - accountNumber - address properties: name: type: string accountNumber: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code title: International SWIFT instructions - type: object required: - memo - swiftCode - accountNumber - swiftField70 - bank - beneficiary - routingNumber properties: memo: type: string description: 'The memo, to be entered into memo/reference/message field when making a deposit. *Important:** Do not add any other information but what is provided in this field to ensure funds are routed correctly.' swiftCode: type: string accountNumber: type: string swiftField70: type: array items: type: string bank: type: object required: - name - address properties: name: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code beneficiary: type: object required: - name - accountNumber - address properties: name: type: string accountNumber: type: string address: type: object required: - line1 - city - region - postalCode - countryCode properties: line1: type: string city: type: string region: type: string description: Region, e.g. US state postalCode: type: string description: Postal code or zip code countryCode: type: string description: ISO country code routingNumber: type: string title: USD SWIFT instructions description: USD SWIFT instructions 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: getV1IdentityByIdentityIdLedgerAccountsByAccountIdDepositMemosByMemo 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/