Initiate a transfer #

ParameterRequiredTypeDescription_linksyesobjectA _links JSON object describing the desired source and destination of a transfer. Reference the Source and Destination object to learn more about possible values for source and destination.amountyesobjectAn amount JSON object. Reference the amount JSON object to learn more.metadatanoobjectA metadata JSON object with a maximum of 10 key-value pairs (each key and value must be less than 255 characters).feesnoarrayAn array of fee JSON objects that contain unique fee transfers. Reference the facilitator fee JSON object to learn more.clearingnoobjectA clearing JSON object that contains source and destination keys to slow down or expedite a transfer. Reference the clearing JSON object to learn more.achDetailsnoobjectAn ACH details JSON object which represents additional information sent along with a transfer to an originating or receiving financial institution. Details within this object can be used to reference a transaction that has settled with a financial institution. Reference the achDetails JSON object to learn morertpDetailsnoobjectAn RTP® details JSON object which represents additional information sent along with an RTP® credit transfer to the receiving financial institution. Details within this object can be used to reference a transaction that has settled with a financial institution. Reference the rtpDetails JSON object to learn morecorrelationIdnostringA string value attached to a customer which can be used for traceability between Dwolla and your application. Note: A correlationId is not a replacement for an idempotency-key.
Must be less than or equal to 255 characters and contain no spaces.
Acceptable characters are: a-Z, 0-9, -, ., and _.
Note: Sensitive Personal Identifying Information (PII) should not be used in this field and it is recommended to use a random value for correlationId, like a UUID.processingChannelnoobjectA processingChannel JSON object that contains a key-value pair with a string key and string value of destination and real-time-payments.

HTTP StatusError MessageDescription201Created.A transfer was created.400Funding source not found.Double check the funding source Id, and make sure you are using the correct funding source Id.400Invalid funding source.The source funding source must be verified in order to send funds. Make sure your source funding source is verified.400Metadata not supported for this type of transfer.Metadata is unable to be passed in on transfers with a Balance Funding Source.400Sender // Receiver Restricted.The source or destination Customer is either deactivated or suspended and not eligible for transfers.400Invalid amountThe supplied amount is greater than your transaction limit. This error can also be triggered for PAYG Clients if the amount is less than 10 cents. For more information on transaction limits for various Customer types, check out our Customer Types article.400Invalid amountThe supplied amount must be a positive number.401Invalid access tokenAccess token not valid. Generate a new one and try again.403ForbiddenNot authorized to create a transfer.403ForbiddenInvalid Funds Flow: this operation requires the funds flow (facilitate/receive/send) to be enabled.429TooManyRequestsConcurrent transfers with the given funding source are not supported. Please wait a short period of time before re-attempting the request.
Note: We don’t support concurrent transfers sourced from a Dwolla balance.

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/AB443D36-3757-44C1-A1B4-29727FB3111C",
    },
  },
  amount: {
    currency: "USD",
    value: "1.00",
  },
  metadata: {
    paymentId: "12345678",
    note: "payment for completed work Dec. 1",
  },
  clearing: {
    destination: "next-available",
  },
  achDetails: {
    source: {
      addenda: {
        values: ["ABC123_AddendaValue"],
      },
    },
    destination: {
      addenda: {
        values: ["ZYX987_AddendaValue"],
      },
    },
  },
  correlationId: "8a2cdc8d-629d-4a24-98ac-40b735229fe2",
};

dwolla
  .post("transfers", requestBody)
  .then((res) => res.headers.get("location")); // => 'https://api-sandbox.dwolla.com/transfers/74c9129b-d14a-e511-80da-0aa34a9b2388'