--- updatedAt: 2026-08-17T02:45:59.000Z agentTools: projectIndex: https://docs.cfx.to/llms.txt --- # Update Payment Instrument Update the details of an existing payment instrument. Only the fields present in the request body are changed; anything omitted is left as-is. The `type` must match the stored instrument's type. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Organization API", "description": "Interact with Organizations", "termsOfService": "", "contact": { "name": "API Owner", "email": "api@cfxlabs.com" }, "license": { "name": "", "url": "" }, "version": "@VERSION@", "summary": "CFX Organization API" }, "components": { "securitySchemes": { "ApiKeyAuth": { "name": "x-api-key", "type": "apiKey", "in": "header" }, "ApiSecretAuth": { "name": "x-api-secret", "type": "apiKey", "in": "header" } } }, "paths": { "/v1/organization/{organizationId}/instrument/{instrumentId}": { "patch": { "summary": "Update Payment Instrument", "tags": [ "Payment Instruments" ], "description": "Update the details of an existing payment instrument. Only the fields present in the request body are changed; anything omitted is left as-is. The `type` must match the stored instrument's type.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "description": "Type of payment instrument.", "enum": [ "WALLET" ] }, "referenceId": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "description": "Customer's unique identifier for this payment instrument. Send `null` to clear it." } ] } }, "title": "Update WALLET", "description": "Update a wallet payment instrument. Only the reference ID is mutable — the address and chain identify the wallet.", "additionalProperties": false }, { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "description": "Type of payment instrument.", "enum": [ "US_ACH" ] }, "referenceId": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "description": "Customer's unique identifier for this payment instrument. Send `null` to clear it." } ] }, "accountName": { "type": "string", "minLength": 1, "description": "Bank account name", "example": "My Bank Account 123" }, "routingNumber": { "type": "string", "minLength": 1, "description": "Routing number for the account", "example": "123456789" }, "accountNumber": { "type": "string", "minLength": 1, "description": "Bank account number", "example": "123456789" }, "accountHolderName": { "type": "string", "minLength": 1, "description": "The Name Of the Account Holder", "example": "Jane Doe" }, "accountType": { "anyOf": [ { "type": "string", "enum": [ "CHECKING" ] }, { "type": "string", "enum": [ "SAVING" ] } ], "description": "The Account Type, defaults to 'CHECKING'" }, "beneficiaryAddress": { "type": "object", "required": [ "line1", "city", "postalCode", "countryCode" ], "properties": { "line1": { "type": "string", "minLength": 1 }, "line2": { "type": "string" }, "city": { "type": "string", "minLength": 1 }, "region": { "type": "string" }, "postalCode": { "type": "string", "minLength": 1 }, "countryCode": { "type": "string", "minLength": 2 } }, "description": "Postal address of the account holder. ACH transfers do not need one. Optional because instruments created before this field existed carry none." }, "bankName": { "type": "string", "minLength": 1, "description": "Bank the routing number resolves to. Optional for the same reason as beneficiaryAddress.", "example": "JPMORGAN CHASE BANK, NA" } }, "title": "Update US ACH", "description": "Update a US Automated Clearing House payment instrument", "additionalProperties": false }, { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "description": "Type of payment instrument.", "enum": [ "US_INSTANT" ] }, "referenceId": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "description": "Customer's unique identifier for this payment instrument. Send `null` to clear it." } ] }, "routingNumber": { "type": "string", "minLength": 1, "description": "Routing number for the account", "example": "123456789" }, "accountNumber": { "type": "string", "minLength": 1, "description": "Bank account number", "example": "123456789" }, "accountHolderName": { "type": "string", "minLength": 1, "description": "The Name Of the Account Holder", "example": "Jane Doe" } }, "title": "Update US_INSTANT", "description": "Update a US Instant (FedNow or RTP) payment instrument", "additionalProperties": false }, { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "description": "Type of payment instrument.", "enum": [ "US_WIRE" ] }, "referenceId": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "description": "Customer's unique identifier for this payment instrument. Send `null` to clear it." } ] }, "accountNumber": { "type": "string", "minLength": 1, "description": "Account number" }, "routingNumber": { "type": "string", "minLength": 1, "description": "ABA routing number" }, "accountType": { "anyOf": [ { "type": "string", "enum": [ "CHECKING" ] }, { "type": "string", "enum": [ "SAVING" ] } ], "default": "CHECKING", "description": "Deposit account type at the receiving bank. Defaults to `CHECKING`." }, "beneficiary": { "type": "object", "oneOf": [ { "type": "object", "required": [ "address", "type", "name" ], "properties": { "email": { "type": "string" }, "phone": { "type": "string" }, "reference": { "type": "string" }, "address": { "type": "object", "required": [ "line1", "city", "postalCode", "countryCode" ], "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } } }, "type": { "type": "string", "enum": [ "BUSINESS" ] }, "name": { "type": "string", "minLength": 1 } }, "title": "BUSINESS" }, { "type": "object", "required": [ "address", "type", "firstName", "lastName" ], "properties": { "email": { "type": "string" }, "phone": { "type": "string" }, "reference": { "type": "string" }, "address": { "type": "object", "required": [ "line1", "city", "postalCode", "countryCode" ], "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } } }, "type": { "type": "string", "enum": [ "PERSON" ] }, "firstName": { "type": "string", "minLength": 1 }, "middleName": { "type": "string" }, "lastName": { "type": "string", "minLength": 1 } }, "title": "PERSON" } ], "discriminator": { "propertyName": "type" } } }, "title": "Update US Wire", "description": "Update a US Wire payment instrument. `beneficiary` is replaced wholesale, and its `type` cannot change.", "additionalProperties": false }, { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "description": "Type of payment instrument.", "enum": [ "SWIFT_WIRE" ] }, "referenceId": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "description": "Customer's unique identifier for this payment instrument. Send `null` to clear it." } ] }, "accountNumber": { "type": "string", "minLength": 1, "description": "Account number" }, "routingNumber": { "type": "string", "minLength": 1, "description": "BIC/SWIFT code" }, "accountType": { "anyOf": [ { "type": "string", "enum": [ "CHECKING" ] }, { "type": "string", "enum": [ "SAVING" ] } ], "default": "CHECKING", "description": "Deposit account type at the beneficiary's bank. Defaults to `CHECKING`." }, "beneficiary": { "type": "object", "oneOf": [ { "type": "object", "required": [ "address", "type", "name" ], "properties": { "email": { "type": "string" }, "phone": { "type": "string" }, "reference": { "type": "string" }, "address": { "type": "object", "required": [ "line1", "city", "postalCode", "countryCode" ], "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } } }, "type": { "type": "string", "enum": [ "BUSINESS" ] }, "name": { "type": "string", "minLength": 1 } }, "title": "BUSINESS" }, { "type": "object", "required": [ "address", "type", "firstName", "lastName" ], "properties": { "email": { "type": "string" }, "phone": { "type": "string" }, "reference": { "type": "string" }, "address": { "type": "object", "required": [ "line1", "city", "postalCode", "countryCode" ], "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } } }, "type": { "type": "string", "enum": [ "PERSON" ] }, "firstName": { "type": "string", "minLength": 1 }, "middleName": { "type": "string" }, "lastName": { "type": "string", "minLength": 1 } }, "title": "PERSON" } ], "discriminator": { "propertyName": "type" } }, "iban": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "description": "IBAN. Send `null` to clear it." } ] }, "localAccountNumber": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "description": "Local Account Number at the beneficiary's bank. Send `null` to clear it." } ] }, "localBankCode": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "description": "Local Bank Code Ex. BSB, Institution-Transit, IFSN. Send `null` to clear it." } ] }, "intermediaryRoutingNumber": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "description": "Intermediary bank BIC/SWIFT code. Send `null` to clear it, which also clears the stored intermediary bank record." } ] } }, "title": "Update SWIFT Wire", "description": "Update a SWIFT Wire payment instrument. `beneficiary` is replaced wholesale, and its `type` cannot change.", "additionalProperties": false } ], "discriminator": { "propertyName": "type" } } } } }, "parameters": [ { "schema": { "type": "string" }, "example": "id_HYFDutVuh5oWCu266VdmC", "in": "path", "name": "organizationId", "required": true, "description": "The unique Organization ID provided upon organization registration" }, { "schema": { "type": "string" }, "example": "pi_JITym5MfDBJ4jOqiji2hP", "in": "path", "name": "instrumentId", "required": true, "description": "The unique instrument ID provided when creating an instrument" }, { "schema": { "type": "string" }, "in": "header", "name": "Idempotency-Key", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "id", "status", "providerId", "createdAt", "updatedAt", "type", "address", "chain" ], "properties": { "id": { "type": "string", "description": "Unique identifier for the payment instrument", "example": "pi_D29OrS7YFGuCUG3pbgSoU" }, "status": { "enum": [ "PENDING_VERIFICATION", "ACTIVE", "BLOCKED", "DELETED" ], "type": "string" }, "referenceId": { "type": "string", "description": "Customer's unique identifier for this payment instrument" }, "providerId": { "type": "string", "description": "Unique ID provider by a CFX Network partner" }, "createdAt": { "type": "string", "format": "date-time", "description": "When the payment instrument was created, in ISO 8601.", "example": "2026-01-15T09:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the payment instrument was last updated, in ISO 8601.", "example": "2026-01-16T14:05:00.000Z" }, "type": { "type": "string", "description": "Type of payment instrument.", "enum": [ "WALLET" ] }, "address": { "type": "string", "description": "Blockchain address or account." }, "chain": { "type": "string", "description": "Canonical chain key from the chain registry (e.g. \"solana\", \"ethereum\")." }, "staticMemo": { "type": "string", "description": "Memo line for making deposits (solana only)" } }, "description": "Wallet payment instrument", "title": "Wallet" }, { "type": "object", "required": [ "id", "status", "providerId", "createdAt", "updatedAt", "type", "originatorName" ], "properties": { "id": { "type": "string", "description": "Unique identifier for the payment instrument", "example": "pi_D29OrS7YFGuCUG3pbgSoU" }, "status": { "enum": [ "PENDING_VERIFICATION", "ACTIVE", "BLOCKED", "DELETED" ], "type": "string" }, "referenceId": { "type": "string", "description": "Customer's unique identifier for this payment instrument" }, "providerId": { "type": "string", "description": "Unique ID provider by a CFX Network partner" }, "createdAt": { "type": "string", "format": "date-time", "description": "When the payment instrument was created, in ISO 8601.", "example": "2026-01-15T09:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the payment instrument was last updated, in ISO 8601.", "example": "2026-01-16T14:05:00.000Z" }, "type": { "type": "string", "description": "Type of payment instrument.", "enum": [ "EXTERNAL_US_ACH" ] }, "originatorName": { "type": "string", "description": "Name of the ACH originator", "example": "Acme Corp" } }, "description": "External US ACH debit payment instrument (originator name only)", "title": "External US ACH" }, { "type": "object", "required": [ "id", "status", "providerId", "createdAt", "updatedAt", "type", "currency", "accountType", "beneficiary", "financialInstitution" ], "properties": { "id": { "type": "string", "description": "Unique identifier for the payment instrument", "example": "pi_D29OrS7YFGuCUG3pbgSoU" }, "status": { "enum": [ "PENDING_VERIFICATION", "ACTIVE", "BLOCKED", "DELETED" ], "type": "string" }, "referenceId": { "type": "string", "description": "Customer's unique identifier for this payment instrument" }, "providerId": { "type": "string", "description": "Unique ID provider by a CFX Network partner" }, "createdAt": { "type": "string", "format": "date-time", "description": "When the payment instrument was created, in ISO 8601.", "example": "2026-01-15T09:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the payment instrument was last updated, in ISO 8601.", "example": "2026-01-16T14:05:00.000Z" }, "type": { "type": "string", "description": "Type of payment instrument.", "enum": [ "SWIFT_WIRE" ] }, "accountNumber": { "type": "string", "minLength": 1, "description": "Account number" }, "routingNumber": { "type": "string", "minLength": 1, "description": "BIC/SWIFT code" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "default": "USD", "description": "ISO-4217 currency this recipient is paid in. Defaults to `USD`. Immutable once the recipient is created — a recipient paid in a second currency is a second recipient.", "example": "USD" }, "accountType": { "anyOf": [ { "type": "string", "enum": [ "CHECKING" ] }, { "type": "string", "enum": [ "SAVING" ] } ], "default": "CHECKING", "description": "Deposit account type at the beneficiary's bank. Defaults to `CHECKING`." }, "intermediaryRoutingNumber": { "type": "string", "minLength": 1, "description": "Intermediary bank BIC/SWIFT code" }, "localAccountNumber": { "type": "string", "minLength": 1, "description": "Local Account Number at the beneficiary's bank" }, "localBankCode": { "type": "string", "minLength": 1, "description": "Local Bank Code Ex. BSB, Institution-Transit, IFSN" }, "iban": { "type": "string", "minLength": 1, "description": "IBAN" }, "beneficiary": { "anyOf": [ { "type": "object", "required": [ "address", "type", "name" ], "properties": { "email": { "type": "string" }, "phone": { "type": "string" }, "reference": { "type": "string" }, "address": { "type": "object", "required": [ "line1", "city", "postalCode", "countryCode" ], "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } } }, "type": { "type": "string", "enum": [ "BUSINESS" ] }, "name": { "type": "string", "minLength": 1 } }, "title": "Business" }, { "type": "object", "required": [ "address", "type", "firstName", "lastName" ], "properties": { "email": { "type": "string" }, "phone": { "type": "string" }, "reference": { "type": "string" }, "address": { "type": "object", "required": [ "line1", "city", "postalCode", "countryCode" ], "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } } }, "type": { "type": "string", "enum": [ "PERSON" ] }, "firstName": { "type": "string", "minLength": 1 }, "middleName": { "type": "string" }, "lastName": { "type": "string", "minLength": 1 } }, "title": "Person" } ] }, "financialInstitution": { "type": "object", "required": [ "name", "code", "branch", "address" ], "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "branch": { "type": "object", "required": [ "name", "code" ], "properties": { "name": { "type": "string" }, "code": { "type": "string" } } }, "address": { "type": "object", "required": [ "line1", "city", "postalCode", "countryCode" ], "properties": { "line1": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } } } } }, "intermediaryFinancialInstitution": { "type": "object", "required": [ "name", "code", "branch", "address" ], "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "branch": { "type": "object", "required": [ "name", "code" ], "properties": { "name": { "type": "string" }, "code": { "type": "string" } } }, "address": { "type": "object", "required": [ "line1", "city", "postalCode", "countryCode" ], "properties": { "line1": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } } } } } }, "description": "SWIFT Wire payment instrument", "title": "SWIFT wire" }, { "type": "object", "required": [ "id", "status", "providerId", "createdAt", "updatedAt", "type", "routingNumber", "accountNumber", "accountHolderName" ], "properties": { "id": { "type": "string", "description": "Unique identifier for the payment instrument", "example": "pi_D29OrS7YFGuCUG3pbgSoU" }, "status": { "enum": [ "PENDING_VERIFICATION", "ACTIVE", "BLOCKED", "DELETED" ], "type": "string" }, "referenceId": { "type": "string", "description": "Customer's unique identifier for this payment instrument" }, "providerId": { "type": "string", "description": "Unique ID provider by a CFX Network partner" }, "createdAt": { "type": "string", "format": "date-time", "description": "When the payment instrument was created, in ISO 8601.", "example": "2026-01-15T09:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the payment instrument was last updated, in ISO 8601.", "example": "2026-01-16T14:05:00.000Z" }, "type": { "type": "string", "description": "Type of payment instrument.", "enum": [ "US_INSTANT" ] }, "routingNumber": { "type": "string", "minLength": 1, "description": "Routing number for the account", "example": "123456789" }, "accountNumber": { "type": "string", "minLength": 1, "description": "Bank account number", "example": "123456789" }, "accountHolderName": { "type": "string", "minLength": 1, "description": "The Name Of the Account Holder", "example": "Jane Doe" } }, "description": "US Instant (FedNow or RTP) Payment Instrument", "title": "US Instant" }, { "type": "object", "required": [ "id", "status", "providerId", "createdAt", "updatedAt", "type", "accountName", "routingNumber", "accountNumber", "accountHolderName" ], "properties": { "id": { "type": "string", "description": "Unique identifier for the payment instrument", "example": "pi_D29OrS7YFGuCUG3pbgSoU" }, "status": { "enum": [ "PENDING_VERIFICATION", "ACTIVE", "BLOCKED", "DELETED" ], "type": "string" }, "referenceId": { "type": "string", "description": "Customer's unique identifier for this payment instrument" }, "providerId": { "type": "string", "description": "Unique ID provider by a CFX Network partner" }, "createdAt": { "type": "string", "format": "date-time", "description": "When the payment instrument was created, in ISO 8601.", "example": "2026-01-15T09:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the payment instrument was last updated, in ISO 8601.", "example": "2026-01-16T14:05:00.000Z" }, "type": { "type": "string", "description": "Type of payment instrument.", "enum": [ "US_ACH" ] }, "accountName": { "type": "string", "minLength": 1, "description": "Bank account name", "example": "My Bank Account 123" }, "routingNumber": { "type": "string", "minLength": 1, "description": "Routing number for the account", "example": "123456789" }, "accountNumber": { "type": "string", "minLength": 1, "description": "Bank account number", "example": "123456789" }, "accountHolderName": { "type": "string", "minLength": 1, "description": "The Name Of the Account Holder", "example": "Jane Doe" }, "accountType": { "anyOf": [ { "type": "string", "enum": [ "CHECKING" ] }, { "type": "string", "enum": [ "SAVING" ] } ], "description": "The Account Type, defaults to 'CHECKING'" }, "beneficiaryAddress": { "type": "object", "required": [ "line1", "city", "postalCode", "countryCode" ], "properties": { "line1": { "type": "string", "minLength": 1 }, "line2": { "type": "string" }, "city": { "type": "string", "minLength": 1 }, "region": { "type": "string" }, "postalCode": { "type": "string", "minLength": 1 }, "countryCode": { "type": "string", "minLength": 2 } }, "description": "Postal address of the account holder. ACH transfers do not need one. Optional because instruments created before this field existed carry none." }, "bankName": { "type": "string", "minLength": 1, "description": "Bank the routing number resolves to. Optional for the same reason as beneficiaryAddress.", "example": "JPMORGAN CHASE BANK, NA" } }, "description": "US Automated Clearing House payment instrument", "title": "US ACH" }, { "type": "object", "required": [ "id", "status", "providerId", "createdAt", "updatedAt", "type", "accountNumber", "routingNumber", "accountType", "beneficiary", "financialInstitution" ], "properties": { "id": { "type": "string", "description": "Unique identifier for the payment instrument", "example": "pi_D29OrS7YFGuCUG3pbgSoU" }, "status": { "enum": [ "PENDING_VERIFICATION", "ACTIVE", "BLOCKED", "DELETED" ], "type": "string" }, "referenceId": { "type": "string", "description": "Customer's unique identifier for this payment instrument" }, "providerId": { "type": "string", "description": "Unique ID provider by a CFX Network partner" }, "createdAt": { "type": "string", "format": "date-time", "description": "When the payment instrument was created, in ISO 8601.", "example": "2026-01-15T09:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the payment instrument was last updated, in ISO 8601.", "example": "2026-01-16T14:05:00.000Z" }, "type": { "type": "string", "description": "Type of payment instrument.", "enum": [ "US_WIRE" ] }, "accountNumber": { "type": "string", "minLength": 1, "description": "Account number" }, "routingNumber": { "type": "string", "minLength": 1, "description": "ABA routing number" }, "accountType": { "anyOf": [ { "type": "string", "enum": [ "CHECKING" ] }, { "type": "string", "enum": [ "SAVING" ] } ], "default": "CHECKING", "description": "Deposit account type at the receiving bank. Defaults to `CHECKING`." }, "beneficiary": { "anyOf": [ { "type": "object", "required": [ "address", "type", "name" ], "properties": { "email": { "type": "string" }, "phone": { "type": "string" }, "reference": { "type": "string" }, "address": { "type": "object", "required": [ "line1", "city", "postalCode", "countryCode" ], "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } } }, "type": { "type": "string", "enum": [ "BUSINESS" ] }, "name": { "type": "string", "minLength": 1 } }, "title": "Business" }, { "type": "object", "required": [ "address", "type", "firstName", "lastName" ], "properties": { "email": { "type": "string" }, "phone": { "type": "string" }, "reference": { "type": "string" }, "address": { "type": "object", "required": [ "line1", "city", "postalCode", "countryCode" ], "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } } }, "type": { "type": "string", "enum": [ "PERSON" ] }, "firstName": { "type": "string", "minLength": 1 }, "middleName": { "type": "string" }, "lastName": { "type": "string", "minLength": 1 } }, "title": "Person" } ] }, "financialInstitution": { "type": "object", "required": [ "name", "address" ], "properties": { "name": { "type": "string" }, "address": { "type": "object", "required": [ "city", "state" ], "properties": { "line1": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" } } } }, "description": "Beneficiary bank, resolved by routing number — never caller-supplied. A Fedwire-only bank has no street address, so `line1` and `postalCode` may be absent." } }, "description": "US Wire payment instrument", "title": "US wire" } ] } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_REQUEST", "TYPE_MISMATCH", "NO_UPDATE", "DUPLICATE", "BENEFICIARY_TYPE_IMMUTABLE", "ACCOUNT_HOLDER_NAME_REQUIRED" ], "description": "- `INVALID_REQUEST`: The service cannot understand the request\n- `TYPE_MISMATCH`: The `type` in the request body does not match the stored instrument's type\n- `NO_UPDATE`: The request body contains no fields to update\n- `DUPLICATE`: The updated details collide with another instrument for this organization\n- `BENEFICIARY_TYPE_IMMUTABLE`: A wire beneficiary cannot change between BUSINESS and PERSON\n- `ACCOUNT_HOLDER_NAME_REQUIRED`: The US ACH or instant account holder name is blank or a placeholder such as N/A" }, "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" } } } } } } } }, "servers": [ { "url": "https://api.dev.cfx.to", "description": "Customer Sandbox" }, { "url": "https://api.cfx.to", "description": "Production" } ], "security": [ { "ApiKeyAuth": [], "ApiSecretAuth": [] } ], "tags": [ { "name": "Payment Instruments", "description": "Bank accounts and wallets an organization can send to or receive from." } ], "externalDocs": { "description": "Find out more about CFX", "url": "https://www.cfxlabs.com/" } } ```