> ## Documentation Index > Fetch the complete documentation index at: https://developers.dwolla.com/llms.txt > Use this file to discover all available pages before exploring further. # Initiate a transfer > Initiate a transfer between funding sources from a Dwolla Account or API Customer resource. Supports ACH, Instant Payments (RTP/FedNow), Push-to-Debit Card, and wire transfers with optional expedited clearing, facilitator fees, metadata, and correlation IDs for enhanced traceability. Includes idempotency key support to prevent duplicate transfers and extensive customization options for addenda records and processing channels. Returns the location of the created transfer resource for tracking and management. ## OpenAPI ````yaml post /transfers openapi: 3.1.0 info: title: Dwolla API description: Dwolla API Documentation contact: name: Dwolla Developer Relations Team url: https://developers.dwolla.com email: api@dwolla.com version: '2.0' termsOfService: https://www.dwolla.com/legal/tos/ license: name: MIT url: https://github.com/Dwolla/dwolla-openapi/blob/master/LICENSE servers: - url: https://api.dwolla.com description: Production server - url: https://api-sandbox.dwolla.com description: Sandbox server security: - clientCredentials: [] tags: - name: tokens description: Operations related to Application Access Tokens - name: root description: Root API operations - name: accounts description: Operations related to Accounts - name: customers description: Operations related to Customers - name: kba description: Operations related to Knowledge-Based Authentication - name: beneficial owners description: Operations related to Beneficial Owners - name: documents description: Operations related to Documents - name: exchanges description: Operations related to Exchanges - name: exchange sessions description: Operations related to Exchange Sessions - name: funding sources description: Operations related to Funding Sources - name: transfers description: Operations related to Transfers - name: labels description: Operations related to Labels - name: mass payments description: Operations related to Mass Payments - name: events description: Operations related to Events - name: webhook subscriptions description: Operations related to Webhook Subscriptions - name: webhooks description: Operations related to Webhooks - name: client tokens description: Operations related to Client Tokens - name: sandbox simulations description: Sandbox-only operations for simulating processing of bank transfers paths: /transfers: post: tags: - transfers summary: Initiate a transfer description: >- Initiate a transfer between funding sources from a Dwolla Account or API Customer resource. Supports ACH, Instant Payments (RTP/FedNow), Push-to-Debit Card, and wire transfers with optional expedited clearing, facilitator fees, metadata, and correlation IDs for enhanced traceability. Includes idempotency key support to prevent duplicate transfers and extensive customization options for addenda records and processing channels. Returns the location of the created transfer resource for tracking and management. operationId: initiateTransfer parameters: - $ref: '#/components/parameters/Accept' - name: Idempotency-Key schema: type: string in: header example: 19051a62-3403-11e6-ac61-9e71128cae77 requestBody: required: true description: Parameters to initiate a transfer content: application/json: schema: required: - _links - amount type: object properties: _links: type: object properties: source: type: object properties: href: type: string destination: type: object properties: href: type: string amount: $ref: '#/components/schemas/TransferAmount' metadata: type: object fees: type: array items: type: object properties: _links: type: object properties: charge-to: type: object properties: href: type: string amount: $ref: '#/components/schemas/TransferAmount' clearing: type: object properties: source: type: string destination: type: string achDetails: type: object properties: source: type: object properties: addenda: type: object properties: values: type: array items: type: string destination: type: object properties: addenda: type: object properties: values: type: array items: type: string rtpDetails: type: object description: Real-Time Payments (RTP) specific transaction details. properties: destination: type: object description: RTP details for the destination properties: remittanceData: type: string description: >- Remittance information for Real-Time Payments, providing context about the payment purpose. Acceptable characters: alphanumeric (0-9, a-z, A-Z), space, and special characters (#,.'&/-@!$%*()_+={}|:;`[]^~\") maxLength: 140 pattern: '^[0-9a-zA-Z #,.''&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+$' example: ABC_123 Remittance Data instantDetails: type: object description: >- Instant Payments specific transaction details for both RTP and FedNow networks. properties: destination: type: object description: Instant payment details for the destination properties: remittanceData: type: string description: >- Remittance information for Instant Payments (RTP/FedNow), providing context about the payment purpose. Acceptable characters: alphanumeric (0-9, a-z, A-Z), space, and special characters (#,.'&/-@!$%*()_+={}|:;`[]^~\") maxLength: 140 pattern: '^[0-9a-zA-Z #,.''&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+$' example: ABC_123 Remittance Data correlationId: type: string processingChannel: type: object properties: destination: type: string enum: - real-time-payments - instant example: instant responses: '201': description: created headers: Location: $ref: '#/components/headers/Location' '400': description: Bad Request headers: {} content: application/vnd.dwolla.v1.hal+json: schema: oneOf: - $ref: '#/components/schemas/SourceNotFoundError' - $ref: '#/components/schemas/ReceiverNotFoundError' - $ref: '#/components/schemas/InvalidSourceFundingSourceError' - $ref: '#/components/schemas/SenderRestrictedError' - $ref: '#/components/schemas/ReceiverRestrictedError' - $ref: '#/components/schemas/InvalidMetadataError' - $ref: '#/components/schemas/OperationBlockedError' - $ref: '#/components/schemas/InvalidAmountLimitError' - $ref: '#/components/schemas/CannotParseAmountError' - $ref: '#/components/schemas/InsufficientFundsError' - $ref: '#/components/schemas/FacilitatorFeeAccountNotFoundError' - $ref: '#/components/schemas/FacilitatorFeeSumTooLargeError' - $ref: '#/components/schemas/FacilitatorFeeBelowMinimumError' - $ref: '#/components/schemas/HighRiskError' - $ref: '#/components/schemas/IncompatibleHoldingsError' - $ref: '#/components/schemas/DirectAccountWithoutBankError' - $ref: '#/components/schemas/SourceSameAsDestinationError' - $ref: '#/components/schemas/InvalidFacilitatorError' - $ref: '#/components/schemas/InvalidFacilitatorFeeCollectFromError' - $ref: >- #/components/schemas/InvalidFacilitatorFeeCollectFromCombinationError - $ref: '#/components/schemas/InvalidDestinationFundingSourceError' - $ref: '#/components/schemas/InvalidOrRemovedCardDestinationError' - $ref: '#/components/schemas/InvalidFacilitatorFeeAmountError' - $ref: '#/components/schemas/WeeklyReceiveLimitReachedError' - $ref: '#/components/schemas/InvalidDestinationClearingTypeError' - $ref: >- #/components/schemas/InvalidAmountForDestinationClearingTypeError - $ref: '#/components/schemas/InvalidCorrelationIdError' - $ref: '#/components/schemas/SourceAddendaMaxLengthError' - $ref: '#/components/schemas/DestinationAddendaMaxLengthError' - $ref: >- #/components/schemas/AchAddendaEntriesNotEnabledForAccountError - $ref: >- #/components/schemas/PointOfSaleAddendaEntriesNotEnabledForAccountError - $ref: '#/components/schemas/IncompatibleAddendaEntriesError' - $ref: >- #/components/schemas/InvalidPointOfSaleAddendaIdentificationCodeError - $ref: >- #/components/schemas/InvalidPointOfSaleAddendaSerialNumberError - $ref: '#/components/schemas/InvalidPointOfSaleAddendaDateError' - $ref: '#/components/schemas/InvalidPointOfSaleAddendaAddressError' - $ref: '#/components/schemas/InvalidPointOfSaleAddendaCityError' - $ref: '#/components/schemas/InvalidPointOfSaleAddendaStateError' - $ref: '#/components/schemas/TransferExpiredForFeeError' - $ref: '#/components/schemas/InvalidFeeOdfiError' - $ref: '#/components/schemas/InvalidSourceBankAccountTypeError' - $ref: >- #/components/schemas/InvalidDestinationBankAccountTypeError - $ref: >- #/components/schemas/IncompatibleSourceAndDestinationTypesError - $ref: '#/components/schemas/SourceNotCardNetworkSettlementError' - $ref: '#/components/schemas/CardSourceNotAllowedError' - $ref: >- #/components/schemas/IncompatibleSourceForRtpDestinationError - $ref: >- #/components/schemas/InvalidAmountForDestinationProcessingChannelError - $ref: '#/components/schemas/RtpFacilitatorFeeNotSupportedError' - $ref: '#/components/schemas/RtpUnverifiedSenderNotSupportedError' - $ref: >- #/components/schemas/RtpPersonalToPersonalNotSupportedError - $ref: >- #/components/schemas/DestinationProcessingChannelNotSupportedError - $ref: >- #/components/schemas/DestinationRemittanceDataMaxLengthError - $ref: '#/components/schemas/WithdrawInvalidAmountError' - $ref: '#/components/schemas/WithdrawInvalidFundingSourceError' - $ref: '#/components/schemas/WithdrawAccountRestrictedError' - $ref: >- #/components/schemas/WithdrawInvalidAmountForClearingTypeError - $ref: >- #/components/schemas/WithdrawInvalidWireBeneficiaryLocalityError - $ref: >- #/components/schemas/WithdrawInvalidWireBeneficiaryRegionError - $ref: >- #/components/schemas/WithdrawInvalidWireBeneficiaryCountryError - $ref: >- #/components/schemas/WithdrawInvalidWireOriginatorToBeneficiaryError - $ref: >- #/components/schemas/WithdrawProcessingChannelNotSupportedError - $ref: >- #/components/schemas/WithdrawRtpUnverifiedSenderNotSupportedError - $ref: >- #/components/schemas/WithdrawRtpPersonalWithdrawalNotSupportedError - $ref: '#/components/schemas/DepositAccountRestrictedError' - $ref: '#/components/schemas/WireInvalidImadError' - $ref: '#/components/schemas/WireAccountRestrictedError' - $ref: '#/components/schemas/WireNotEnabledError' - $ref: '#/components/schemas/WireAccountNotFoundError' - $ref: '#/components/schemas/PrefundingSourceNotAllowedError' '403': description: Forbidden headers: {} content: application/vnd.dwolla.v1.hal+json: schema: oneOf: - $ref: '#/components/schemas/InvalidAttemptToFacilitateFundsError' - $ref: '#/components/schemas/InvalidAttemptToPayInFundsError' - $ref: '#/components/schemas/InvalidAttemptToPayOutFundsError' - $ref: '#/components/schemas/RtpAccountSettingNotEnabledError' '429': description: Too Many Requests headers: {} content: application/vnd.dwolla.v1.hal+json: schema: $ref: '#/components/schemas/TooManyRequestsErrorError' x-codeSamples: - lang: bash source: > POST https://api-sandbox.dwolla.com/transfers Accept: application/vnd.dwolla.v1.hal+json Content-Type: application/vnd.dwolla.v1.hal+json Authorization: Bearer pBA9fVDBEyYZCEsLf/wKehyh1RTpzjUj5KzIRfDi0wKTii7DqY { "_links": { "source": { "href": "https://api-sandbox.dwolla.com/funding-sources/707177c3-bf15-4e7e-b37c-55c3898d9bf4" }, "destination": { "href": "https://api-sandbox.dwolla.com/funding-sources/9c7f8d57-cd45-4e7a-bf7a-914dbd6131db" } }, "amount": { "currency": "USD", "value": "1.00" }, "clearing": { "source": "standard", "destination": "next-available" }, "achDetails": { "source": { "addenda": { "values": ["ABC123_AddendaValue"] } }, "destination": { "addenda": { "values": ["ZYX987_AddendaValue"] } } }, "instantDetails": { "destination": { "remittanceData": "ABC_123 Remittance Data" } }, "fees": [ { "_links": { "charge-to": { "href": "https://api-sandbox.dwolla.com/customers/d795f696-2cac-4662-8f16-95f1db9bddd8" } }, "amount": { "value": "4.00", "currency": "USD" } } ], "metadata": { "key": "value" }, "correlationId": "6d127333-69e9-4c2b-8cae-df850228e130", "processingChannel": { "destination": "instant" } } - lang: javascript source: | // Using dwolla-v2 - https://github.com/Dwolla/dwolla-v2-node var requestBody = { _links: { source: { href: "https://api-sandbox.dwolla.com/funding-sources/707177c3-bf15-4e7e-b37c-55c3898d9bf4", }, destination: { href: "https://api-sandbox.dwolla.com/funding-sources/9c7f8d57-cd45-4e7a-bf7a-914dbd6131db", }, }, amount: { currency: "USD", value: "1.00", }, clearing: { source: "standard", destination: "next-available", }, achDetails: { source: { addenda: { values: ["ABC123_AddendaValue"], }, }, destination: { addenda: { values: ["ZYX987_AddendaValue"], }, }, }, instantDetails: { destination: { remittanceData: "ABC_123 Remittance Data", }, }, fees: [ { _links: { "charge-to": { href: "https://api-sandbox.dwolla.com/customers/d795f696-2cac-4662-8f16-95f1db9bddd8", }, }, amount: { value: "4.00", currency: "USD", }, }, ], metadata: { key: "value", }, correlationId: "6d127333-69e9-4c2b-8cae-df850228e130", processingChannel: { destination: "instant", }, }; dwolla .post("transfers", requestBody) .then((res) => res.headers.get("location")); // => 'https://api-sandbox.dwolla.com/transfers/0e6b8c1e-7b6e-4b2e-8e2e-1b2e2e2e2e2e' - lang: python source: > # Using dwollav2 - https://github.com/Dwolla/dwolla-v2-python request_body = { '_links': { 'source': { 'href': 'https://api-sandbox.dwolla.com/funding-sources/707177c3-bf15-4e7e-b37c-55c3898d9bf4' }, 'destination': { 'href': 'https://api-sandbox.dwolla.com/funding-sources/9c7f8d57-cd45-4e7a-bf7a-914dbd6131db' } }, 'amount': { 'currency': 'USD', 'value': '1.00' }, 'clearing': { 'source': 'standard', 'destination': 'next-available' }, 'achDetails': { 'source': { 'addenda': { 'values': ['ABC123_AddendaValue'] } }, 'destination': { 'addenda': { 'values': ['ZYX987_AddendaValue'] } } }, 'instantDetails': { 'destination': { 'remittanceData': 'ABC_123 Remittance Data' } }, 'fees': [ { '_links': { 'charge-to': { 'href': 'https://api-sandbox.dwolla.com/customers/d795f696-2cac-4662-8f16-95f1db9bddd8' } }, 'amount': { 'value': '4.00', 'currency': 'USD' } } ], 'metadata': { 'key': 'value' }, 'correlationId': '6d127333-69e9-4c2b-8cae-df850228e130', 'processingChannel': { 'destination': 'instant' } } transfer = app_token.post('transfers', request_body) transfer.headers['location'] # => 'https://api-sandbox.dwolla.com/transfers/0e6b8c1e-7b6e-4b2e-8e2e-1b2e2e2e2e2e' - lang: php source: > create([ '_links' => [ 'source' => [ 'href' => 'https://api-sandbox.dwolla.com/funding-sources/707177c3-bf15-4e7e-b37c-55c3898d9bf4', ], 'destination' => [ 'href' => 'https://api-sandbox.dwolla.com/funding-sources/9c7f8d57-cd45-4e7a-bf7a-914dbd6131db', ] ], 'amount' => [ 'currency' => 'USD', 'value' => '1.00' ], 'clearing' => [ 'source' => 'standard', 'destination' => 'next-available' ], 'achDetails' => [ 'source' => [ 'addenda' => [ 'values' => ['ABC123_AddendaValue'] ] ], 'destination' => [ 'addenda' => [ 'values' => ['ZYX987_AddendaValue'] ] ] ], 'instantDetails' => [ 'destination' => [ 'remittanceData' => 'ABC_123 Remittance Data' ] ], 'fees' => [ [ '_links' => [ 'charge-to' => [ 'href' => 'https://api-sandbox.dwolla.com/customers/d795f696-2cac-4662-8f16-95f1db9bddd8', ] ], 'amount' => [ 'value' => '4.00', 'currency' => 'USD' ] ] ], 'metadata' => [ 'key' => 'value' ], 'correlationId' => '6d127333-69e9-4c2b-8cae-df850228e130', 'processingChannel' => [ 'destination' => 'instant' ] ]); $transfer; # => "https://api-sandbox.dwolla.com/transfers/0e6b8c1e-7b6e-4b2e-8e2e-1b2e2e2e2e2e" ?> - lang: ruby source: > # Using dwolla_v2 - https://github.com/Dwolla/dwolla-v2-ruby request_body = { :_links => { :source => { :href => "https://api-sandbox.dwolla.com/funding-sources/707177c3-bf15-4e7e-b37c-55c3898d9bf4" }, :destination => { :href => "https://api-sandbox.dwolla.com/funding-sources/9c7f8d57-cd45-4e7a-bf7a-914dbd6131db" } }, :amount => { :currency => "USD", :value => "1.00" }, :clearing => { :source => "standard", :destination => "next-available" }, :achDetails => { :source => { :addenda => { :values => ["ABC123_AddendaValue"] } }, :destination => { :addenda => { :values => ["ZYX987_AddendaValue"] } } }, :instantDetails => { :destination => { :remittanceData => "ABC_123 Remittance Data" } }, :fees => [ { :_links => { :"charge-to" => { :href => "https://api-sandbox.dwolla.com/customers/d795f696-2cac-4662-8f16-95f1db9bddd8" } }, :amount => { :value => "4.00", :currency => "USD" } } ], :metadata => { :key => "value" }, :correlationId => "6d127333-69e9-4c2b-8cae-df850228e130", :processingChannel => { :destination => "instant" } } transfer = app_token.post "transfers", request_body transfer.response_headers[:location] # => "https://api-sandbox.dwolla.com/transfers/0e6b8c1e-7b6e-4b2e-8e2e-1b2e2e2e2e2e" components: parameters: Accept: name: Accept in: header required: true description: >- The media type of the response. Must be application/vnd.dwolla.v1.hal+json schema: type: string enum: - application/vnd.dwolla.v1.hal+json default: application/vnd.dwolla.v1.hal+json schemas: TransferAmount: title: TransferAmount type: object required: - value - currency properties: value: type: string example: '5.00' currency: type: string example: USD SourceNotFoundError: title: SourceNotFoundError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: Funding source not found. path: type: string example: /_links/source/href _links: type: object example: {} ReceiverNotFoundError: title: ReceiverNotFoundError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: Receiver not found. path: type: string example: /_links/destination/href _links: type: object example: {} InvalidSourceFundingSourceError: title: InvalidSourceFundingSourceError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: Invalid funding source. path: type: string example: /_links/source/href _links: type: object example: {} SenderRestrictedError: title: SenderRestrictedError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Restricted message: type: string example: Sender restricted. path: type: string example: /_links/source/href _links: type: object example: {} ReceiverRestrictedError: title: ReceiverRestrictedError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Restricted message: type: string example: Receiver restricted. path: type: string example: /_links/destination/href _links: type: object example: {} InvalidMetadataError: title: InvalidMetadataError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: Invalid metadata. path: type: string example: /metadata _links: type: object example: {} OperationBlockedError: title: OperationBlockedError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: NotAllowed message: type: string example: Receiver cannot receive from sender. path: type: string example: /_links/destination/href _links: type: object example: {} InvalidAmountLimitError: title: InvalidAmountLimitError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: >- Invalid amount. The supplied amount is greater than your transaction limit. path: type: string example: /amount/value _links: type: object example: {} CannotParseAmountError: title: CannotParseAmountError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: InvalidFormat message: type: string example: >- Invalid amount. The supplied amount must be a positive number. path: type: string example: /amount/value _links: type: object example: {} InsufficientFundsError: title: InsufficientFundsError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: InsufficientFunds message: type: string example: Insufficient funds. path: type: string example: /_links/source/href _links: type: object example: {} FacilitatorFeeAccountNotFoundError: title: FacilitatorFeeAccountNotFoundError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: Facilitator fee account not found. path: type: string example: '' _links: type: object example: {} FacilitatorFeeSumTooLargeError: title: FacilitatorFeeSumTooLargeError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: Facilitator fee sum too large. path: type: string example: '' _links: type: object example: {} FacilitatorFeeBelowMinimumError: title: FacilitatorFeeBelowMinimumError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: Facilitator fee below minimum. path: type: string example: '' _links: type: object example: {} HighRiskError: title: HighRiskError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: NotAllowed message: type: string example: >- Due to account restrictions, we are unable to process this transaction. path: type: string example: /_links/destination/href _links: type: object example: {} IncompatibleHoldingsError: title: IncompatibleHoldingsError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: NotAllowed message: type: string example: Receiver cannot receive from sender. path: type: string example: /_links/destination/href _links: type: object example: {} DirectAccountWithoutBankError: title: DirectAccountWithoutBankError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: RequiresFundingSource message: type: string example: Receiver requires funding source. path: type: string example: /_links/destination/href _links: type: object example: {} SourceSameAsDestinationError: title: SourceSameAsDestinationError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: Receiver cannot be the owner of the source funding source. path: type: string example: /_links/destination/href _links: type: object example: {} InvalidFacilitatorError: title: InvalidFacilitatorError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: Account cannot facilitate this transaction. path: type: string example: '' _links: type: object example: {} InvalidFacilitatorFeeCollectFromError: title: InvalidFacilitatorFeeCollectFromError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: Unable to charge fee to specified destination. path: type: string example: /fees/_links/charge-to/href _links: type: object example: {} InvalidFacilitatorFeeCollectFromCombinationError: title: InvalidFacilitatorFeeCollectFromCombinationError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: Currently, all fees must be paid by same destination." path: type: string example: /fees/_links/charge-to/href _links: type: object example: {} InvalidDestinationFundingSourceError: title: InvalidDestinationFundingSourceError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: Invalid destination funding source. path: type: string example: /_links/destination/href _links: type: object example: {} InvalidOrRemovedCardDestinationError: title: InvalidOrRemovedCardDestinationError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: >- Destination funding source is either removed or does not exist. path: type: string example: /_links/destination/href _links: type: object example: {} InvalidFacilitatorFeeAmountError: title: InvalidFacilitatorFeeAmountError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: Invalid facilitator fee amount. path: type: string example: /fees/_links/charge-to/href _links: type: object example: {} WeeklyReceiveLimitReachedError: title: WeeklyReceiveLimitReachedError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Restricted message: type: string example: Destination customer has reached its weekly receive limit. path: type: string example: /_links/destination/href _links: type: object example: {} InvalidDestinationClearingTypeError: title: InvalidDestinationClearingTypeError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Restricted message: type: string example: Destination clearing type is currently not enabled. path: type: string example: /clearing/destination _links: type: object example: {} InvalidAmountForDestinationClearingTypeError: title: InvalidAmountForDestinationClearingTypeError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Restricted message: type: string example: >- Amount is above the allowed threshold for the specified destination clearing type. path: type: string example: /amount/value _links: type: object example: {} InvalidCorrelationIdError: title: InvalidCorrelationIdError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: InvalidFormat message: type: string example: >- Correlation id must be at least one character and up to 255 characters when supplied. path: type: string example: /correlationId _links: type: object example: {} SourceAddendaMaxLengthError: title: SourceAddendaMaxLengthError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: InvalidFormat message: type: string example: >- Ach addenda entries can be up to 80 characters when supplied. path: type: string example: /achDetails/source/addenda/values _links: type: object example: {} DestinationAddendaMaxLengthError: title: DestinationAddendaMaxLengthError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: InvalidFormat message: type: string example: >- Ach addenda entries can be up to 80 characters when supplied. path: type: string example: /achDetails/destination/addenda/values _links: type: object example: {} AchAddendaEntriesNotEnabledForAccountError: title: AchAddendaEntriesNotEnabledForAccountError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: NotAllowed message: type: string example: Supplying ach addenda entries is currently not enabled. path: type: string example: '' _links: type: object example: {} PointOfSaleAddendaEntriesNotEnabledForAccountError: title: PointOfSaleAddendaEntriesNotEnabledForAccountError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: NotAllowed message: type: string example: >- Supplying point of sale addenda entries is currently not enabled. path: type: string example: '' _links: type: object example: {} IncompatibleAddendaEntriesError: title: IncompatibleAddendaEntriesError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: NotAllowed message: type: string example: >- Addenda must not include both 'values' and 'pointOfSale addenda path: type: string example: /achDetails/source/addenda/pointOfSale _links: type: object example: {} InvalidPointOfSaleAddendaIdentificationCodeError: title: InvalidPointOfSaleAddendaIdentificationCodeError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: InvalidFormat message: type: string example: >- Identification code on a Point of Sale addenda entry is required and can be up to 6 characters. path: type: string example: /achDetails/source/addenda/pointOfSale/identificationCode _links: type: object example: {} InvalidPointOfSaleAddendaSerialNumberError: title: InvalidPointOfSaleAddendaSerialNumberError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: InvalidFormat message: type: string example: >- Serial number on a Point of Sale addenda entry is required and can be up to 6 characters. path: type: string example: /achDetails/source/addenda/pointOfSale/serialNumber _links: type: object example: {} InvalidPointOfSaleAddendaDateError: title: InvalidPointOfSaleAddendaDateError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: InvalidFormat message: type: string example: >- Date on a Point of Sale addenda entry is required and should be ISO-8601 format: YYYY-MM-DD. path: type: string example: /achDetails/source/addenda/pointOfSale/date _links: type: object example: {} InvalidPointOfSaleAddendaAddressError: title: InvalidPointOfSaleAddendaAddressError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: InvalidFormat message: type: string example: >- Address on a Point of Sale addenda entry is required and can be up to 27 characters. path: type: string example: /achDetails/source/addenda/pointOfSale/address _links: type: object example: {} InvalidPointOfSaleAddendaCityError: title: InvalidPointOfSaleAddendaCityError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: InvalidFormat message: type: string example: >- City on a Point of Sale addenda entry is required and can be up to 15 characters. path: type: string example: /achDetails/source/addenda/pointOfSale/city _links: type: object example: {} InvalidPointOfSaleAddendaStateError: title: InvalidPointOfSaleAddendaStateError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: InvalidFormat message: type: string example: >- State on a Point of Sale addenda entry is required and should be a valid 2-letter abbreviation. path: type: string example: /achDetails/source/addenda/pointOfSale/state _links: type: object example: {} TransferExpiredForFeeError: title: TransferExpiredForFeeError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: NotAllowed message: type: string example: >- Return fees can only be charged within 45 days of the original transfer's settlement date. path: type: string example: /_links/failed-transfer/href _links: type: object example: {} InvalidFeeOdfiError: title: InvalidFeeOdfiError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: NotAllowed message: type: string example: Transfer ineligible. path: type: string example: /_links/failed-transfer/href _links: type: object example: {} InvalidSourceBankAccountTypeError: title: InvalidBankAccountTypeError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: Invalid bank account type path: type: string example: /_links/source/href _links: type: object example: {} InvalidDestinationBankAccountTypeError: title: InvalidDestinationBankAccountTypeError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: Invalid bank account type path: type: string example: /_links/destination/href _links: type: object example: {} IncompatibleSourceAndDestinationTypesError: title: IncompatibleSourceAndDestinationTypesError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: >- Card type funding sources can only accept payments directly from a balance path: type: string example: /_links/destination/href _links: type: object example: {} SourceNotCardNetworkSettlementError: title: SourceNotCardNetworkSettlementError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: NotAllowed message: type: string example: Source funding source does not support card payouts. path: type: string example: /_links/source/href _links: type: object example: {} CardSourceNotAllowedError: title: CardSourceNotAllowedError description: >- Error returned when attempting to use a debit card funding source as the transfer source type: object required: - code - message - _embedded additionalProperties: false properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object required: - errors properties: errors: type: array items: type: object required: - code - message - path properties: code: type: string enum: - NotAllowed example: NotAllowed message: type: string enum: - Cards cannot be used as a source for transfers. example: Cards cannot be used as a source for transfers. path: type: string enum: - /_links/source/href example: /_links/source/href _links: type: object example: {} IncompatibleSourceForRtpDestinationError: title: IncompatibleSourceForRtpDestinationError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: NotAllowed message: type: string example: >- Transfers using the Real Time Payments processing channel must be funded by a balance path: type: string example: /_links/destination/href _links: type: object example: {} InvalidAmountForDestinationProcessingChannelError: title: InvalidAmountForDestinationProcessingChannelError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Restricted message: type: string example: >- Amount is greater than the allowed threshold for the specified destination processing channel. path: type: string example: /amount/value _links: type: object example: {} RtpFacilitatorFeeNotSupportedError: title: RtpFacilitatorFeeNotSupportedError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: NotAllowed message: type: string example: >- Real Time Payments does not currently support facilitator fees path: type: string example: '' _links: type: object example: {} RtpUnverifiedSenderNotSupportedError: title: RtpUnverifiedSenderNotSupportedError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: NotAllowed message: type: string example: >- Real Time Payments does not currently support unverified senders path: type: string example: '' _links: type: object example: {} RtpPersonalToPersonalNotSupportedError: title: RtpPersonalToPersonalNotSupportedError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: NotAllowed message: type: string example: >- Real Time Payments does not currently support transfers between personal accounts path: type: string example: '' _links: type: object example: {} DestinationProcessingChannelNotSupportedError: title: DestinationProcessingChannelNotSupportedError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: NotAllowed message: type: string example: >- Destination funding source does not support processing channel path: type: string example: /processingChannel/destination _links: type: object example: {} DestinationRemittanceDataMaxLengthError: title: DestinationRemittanceDataMaxLengthError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: InvalidFormat message: type: string example: >- Remittance data entries can be up to 140 characters when supplied. path: type: string example: /rtpDetails/destination/remittanceData _links: type: object example: {} WithdrawInvalidAmountError: title: WithdrawInvalidAmountError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: Invalid amount. path: type: string example: /amount/value _links: type: object example: {} WithdrawInvalidFundingSourceError: title: WithdrawInvalidFundingSourceError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: >- Destination funding source is either removed or does not exist. path: type: string example: /_links/destination/href _links: type: object example: {} WithdrawAccountRestrictedError: title: WithdrawAccountRestrictedError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Restricted message: type: string example: Account or customer restricted. path: type: string example: /_links/source/href _links: type: object example: {} WithdrawInvalidAmountForClearingTypeError: title: WithdrawInvalidAmountForClearingTypeError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Restricted message: type: string example: >- Amount is above the allowed threshold for the specified clearing type. path: type: string example: /amount/value _links: type: object example: {} WithdrawInvalidWireBeneficiaryLocalityError: title: WithdrawInvalidWireBeneficiaryLocalityError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: InvalidFormat message: type: string example: >- Beneficiary locality must not exceed 35 characters and contain only alphanumeric, white space, '.' or '#' characters. path: type: string example: /wireInstructions/beneficiaryLocality _links: type: object example: {} WithdrawInvalidWireBeneficiaryRegionError: title: WithdrawInvalidWireBeneficiaryRegionError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: InvalidFormat message: type: string example: >- Beneficiary region must not exceed 35 characters and contain only alphanumeric, white space, '.' or '#' characters. path: type: string example: /wireInstructions/beneficiaryRegion _links: type: object example: {} WithdrawInvalidWireBeneficiaryCountryError: title: WithdrawInvalidWireBeneficiaryCountryError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: InvalidFormat message: type: string example: >- Beneficiary country must not exceed 35 characters and contain only alphanumeric, white space, '.' or '#' characters. path: type: string example: /wireInstructions/beneficiaryCountry _links: type: object example: {} WithdrawInvalidWireOriginatorToBeneficiaryError: title: WithdrawInvalidWireOriginatorToBeneficiaryError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: InvalidFormat message: type: string example: >- Originator to beneficiary items must not exceed 35 characters and contain only alphanumeric, white space, '.' or '#' characters. path: type: string example: /wireInstructions/originatorToBeneficiary _links: type: object example: {} WithdrawProcessingChannelNotSupportedError: title: WithdrawProcessingChannelNotSupportedError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: Unsupported processing channel. path: type: string example: /_links/destination/href _links: type: object example: {} WithdrawRtpUnverifiedSenderNotSupportedError: title: WithdrawRtpUnverifiedSenderNotSupportedError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: NotAllowed message: type: string example: >- Real Time Payments does not currently support unverified senders path: type: string example: '' _links: type: object example: {} WithdrawRtpPersonalWithdrawalNotSupportedError: title: WithdrawRtpPersonalWithdrawalNotSupportedError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: NotAllowed message: type: string example: >- Real Time Payments withdrawal from a personal account is currently not supported path: type: string example: '' _links: type: object example: {} DepositAccountRestrictedError: title: DepositAccountRestrictedError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Restricted message: type: string example: Account is restricted. path: type: string example: /_links/destination/href _links: type: object example: {} WireInvalidImadError: title: WireInvalidImadError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Invalid message: type: string example: Missing or invalid IMAD. path: type: string example: /imad _links: type: object example: {} WireAccountRestrictedError: title: WireAccountRestrictedError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: Restricted message: type: string example: Account or customer restricted. path: type: string example: /_links/destination/href _links: type: object example: {} WireNotEnabledError: title: WireNotEnabledError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: NotAllowed message: type: string example: Wire transfers are currently not enabled. path: type: string example: /_links/source/href _links: type: object example: {} WireAccountNotFoundError: title: WireAccountNotFoundError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: NotFound message: type: string example: Account or customer invalid. path: type: string example: /_links/destination/href _links: type: object example: {} PrefundingSourceNotAllowedError: title: PrefundingSourceNotAllowedError type: object required: - code - message properties: code: type: string example: ValidationError message: type: string example: >- Validation error(s) present. See embedded errors list for more details. _embedded: type: object properties: errors: type: array items: type: object properties: code: type: string example: NotAllowed message: type: string example: >- Only the prefunding account owner is able to prefund the account. path: type: string example: /_links/source/href _links: type: object example: {} InvalidAttemptToFacilitateFundsError: title: InvalidAttemptToFacilitateFundsError type: object required: - code - message properties: code: type: string example: Forbidden message: type: string example: >- Invalid Funds Flow: this operation requires the funds flow 'Facilitate' to be enabled InvalidAttemptToPayInFundsError: title: InvalidAttemptToPayInFundsError type: object required: - code - message properties: code: type: string example: Forbidden message: type: string example: >- Invalid Funds Flow: this operation requires the funds flow 'Receive' to be enabled InvalidAttemptToPayOutFundsError: title: InvalidAttemptToPayOutFundsError type: object required: - code - message properties: code: type: string example: Forbidden message: type: string example: >- Invalid Funds Flow: this operation requires the funds flow 'Send' to be enabled RtpAccountSettingNotEnabledError: title: RtpAccountSettingNotEnabledError type: object required: - code - message properties: code: type: string example: Forbidden message: type: string example: Real Time Payments not enabled for this account TooManyRequestsErrorError: title: TooManyRequestsErrorError type: object required: - code - message properties: code: type: string example: TooManyRequests message: type: string example: >- Concurrent transfers with the given funding source are not supported. Please wait a short period of time before re-attempting the request. headers: Location: description: The location of the created resource schema: type: string securitySchemes: clientCredentials: type: oauth2 flows: clientCredentials: tokenUrl: /token x-speakeasy-token-endpoint-authentication: client_secret_basic scopes: {} ````