Transfers #

A transfer represents money being transferred from a source to a destination. Transfers are available for the Customer and Account resources.

Transfer Links #

Transfer resource #

{
  "_links": {},
  "_embedded": {},
  "id": "string",
  "status": "string",
  "amount": {
    "value": "string",
    "currency": "string"
  },
  "created": "string",
  "metadata": {
    "key": "value"
  },
  "clearing": {
    "source": "standard",
    "destination": "next-available"
  },
  "achDetails": {
    "source": {
      "addenda": {
          "values": [
              "string"
          ]
      },
      "traceId": "string"
    },
    "destination": {
      "addenda": {
          "values": [
              "string"
          ]
      },
      "traceId": "string"
    }
  },
  "rtpDetails": {
    "destination": "string"
    "networkId": "string"
  },
  "correlationId": "string",
  "individualAchId": "string",
  "processingChannel": {
    "destination": "real-time-payments"
  }
}

Source and destination types #

Source types

Destination types

amount JSON object #

Facilitator fee JSON object #

The facilitator fee is a feature allowing for a flat rate amount to be removed from a payment as a fee, and sent to the creator of the Dwolla application. The fee does not affect the original payment amount, and exists as a separate Transfer resource with a unique transfer ID. Within a transfer request you can specify an optional fees request parameter, which is an array of fee objects that can represent many unique fee transfers.

For more information on collecting fees on payments, reference the facilitator fee resource article.

Facilitator fee example:

"fees": [
  {
    "_links": {
      "charge-to": {
        "href": "https://api-sandbox.dwolla.com/customers/d795f696-2cac-4662-8f16-95f1db9bddd8"
      }
    },
    "amount": {
      "value": "4.00",
      "currency": "USD"
    }
  }
]

clearing JSON object #

The clearing object is used in tandem with our expedited transfer feature. This object does not need to be included if not using expedited transfers. Source specifies the clearing time for the source funding source involved in the transfer, and can be used to downgrade the clearing time from the default of Next-day ACH or to upgrade it to Same-day ACH debit. Destination specifies the clearing time for the destination funding source involved in the transfer, and can be used to upgrade the clearing time from the default of Standard ACH to Same-day ACH.

Clearing examples:

Standard debit and Same-day credit (when Next-day is enabled)

"clearing": {
  "source": "standard",
  "destination": "next-available"
}

Next-day debit and Same-day credit (when Next-day is enabled)

"clearing": {
  "destination": "next-available"
}

Same-day debit and Same-day credit

"clearing": {
  "source": "next-available",
  "destination": "next-available"
}

Same-day debit and Standard credit

"clearing": {
  "source": "next-available"
}

achDetails and addenda object #

Note: This feature is only supported for business Customer records.
The addendum record is used to provide additional information to the payment recipient about the payment. This value will be passed in on a transfer request and can be exposed on a Customer’s bank statement. Addenda records provide a unique opportunity to supply your customers with more information about their transactions. Allowing businesses to include additional details about the transaction—such as invoice numbers—provides their end users with more information about the transaction in the comfort of their own banking application.

achDetails object

addenda object

achDetails with addenda example:

"achDetails": {
  "source": {
    "addenda": {
      "values": ["ABC123_AddendaValue"]
    }
  },
  "destination": {
    "addenda": {
      "values": ["ZYX987_AddendaValue"]
    }
  }
}

rtpDetails object #

Note: This is available as part of RTP®, a premium feature available for Dwolla customers. Enabling RTP® does require additional Dwolla approvals before getting started. Please contact Sales or your account manager for more information on enabling this account feature.

The rtpDetails object is used to provide additional information to the payment recipient about their RTP® credit transfer. This value will be passed in on an RTP® credit transfer request to the recipient’s bank account.

Refer to our Real-time Payments developer concept article to learn more about initiating an RTP® credit transfer.

rtpDetails object

destination object

rtpDetails example:

"rtpDetails": {
  "destination": {
    "remittanceData": "ABC_123 Remittance Data"
  }
}