Retrieve a transfer

cURL

GET https://api-sandbox.dwolla.com/transfers/15c6bcce-46f7-e811-8112-e8dd3bececa8
Accept: application/vnd.dwolla.v1.hal+json
Authorization: Bearer pBA9fVDBEyYZCEsLf/wKehyh1RTpzjUj5KzIRfDi0wKTii7DqY

{
  "_links": {},
  "id": "15c6bcce-46f7-e811-8112-e8dd3bececa8",
  "status": "pending",
  "amount": {
    "value": "42.00",
    "currency": "USD"
  },
  "created": "2018-12-03T22:00:22.970Z",
  "clearing": {
    "source": "standard",
    "destination": "same-day"
  },
  "metadata": {
    "paymentId": "12345678",
    "note": "Payment for completed work Dec. 1"
  },
  "achDetails": {
    "source": {
      "addenda": {
        "values": [
          "ABC123_AddendaValue"
        ]
      },
      "beneficiaryName": "John Doe",
      "companyEntryDescription": "PAYMENT",
      "companyId": "1234567890",
      "companyName": "Acme Corporation",
      "effectiveDate": "2021-12-01",
      "postingData": "Acme Corporation:Payment Reference:John Doe",
      "routingNumber": "222222226",
      "traceId": "222222225926346"
    },
    "destination": {
      "addenda": {
        "values": [
          "ZYX987_AddendaValue"
        ]
      },
      "beneficiaryName": "Jane Smith",
      "companyEntryDescription": "PAYMENT",
      "companyId": "1234567890",
      "companyName": "Acme Corporation",
      "effectiveDate": "2021-12-01",
      "postingData": "Acme Corporation:Payment Reference:Jane Smith",
      "routingNumber": "222222226",
      "traceId": "222222225926346"
    }
  },
  "rtpDetails": {
    "destination": {
      "remittanceData": "ABC_123 Remittance Data",
      "networkId": "20210617021214273T1BG27487110796028",
      "endToEndReferenceId": "E2E-RTP-20210617-001"
    }
  },
  "fedNowDetails": {
    "destination": {
      "remittanceData": "ABC_123 Remittance Data",
      "networkId": "20240115123456789FEDNOW123456",
      "endToEndReferenceId": "E2E-FEDNOW-20240115-001"
    }
  },
  "correlationId": "8a2cdc8d-629d-4a24-98ac-40b735229fe2",
  "processingChannel": {
    "destination": "real-time-payments"
  }
}

GET

transfers

{id}

cURL

GET https://api-sandbox.dwolla.com/transfers/15c6bcce-46f7-e811-8112-e8dd3bececa8
Accept: application/vnd.dwolla.v1.hal+json
Authorization: Bearer pBA9fVDBEyYZCEsLf/wKehyh1RTpzjUj5KzIRfDi0wKTii7DqY

{
  "_links": {},
  "id": "15c6bcce-46f7-e811-8112-e8dd3bececa8",
  "status": "pending",
  "amount": {
    "value": "42.00",
    "currency": "USD"
  },
  "created": "2018-12-03T22:00:22.970Z",
  "clearing": {
    "source": "standard",
    "destination": "same-day"
  },
  "metadata": {
    "paymentId": "12345678",
    "note": "Payment for completed work Dec. 1"
  },
  "achDetails": {
    "source": {
      "addenda": {
        "values": [
          "ABC123_AddendaValue"
        ]
      },
      "beneficiaryName": "John Doe",
      "companyEntryDescription": "PAYMENT",
      "companyId": "1234567890",
      "companyName": "Acme Corporation",
      "effectiveDate": "2021-12-01",
      "postingData": "Acme Corporation:Payment Reference:John Doe",
      "routingNumber": "222222226",
      "traceId": "222222225926346"
    },
    "destination": {
      "addenda": {
        "values": [
          "ZYX987_AddendaValue"
        ]
      },
      "beneficiaryName": "Jane Smith",
      "companyEntryDescription": "PAYMENT",
      "companyId": "1234567890",
      "companyName": "Acme Corporation",
      "effectiveDate": "2021-12-01",
      "postingData": "Acme Corporation:Payment Reference:Jane Smith",
      "routingNumber": "222222226",
      "traceId": "222222225926346"
    }
  },
  "rtpDetails": {
    "destination": {
      "remittanceData": "ABC_123 Remittance Data",
      "networkId": "20210617021214273T1BG27487110796028",
      "endToEndReferenceId": "E2E-RTP-20210617-001"
    }
  },
  "fedNowDetails": {
    "destination": {
      "remittanceData": "ABC_123 Remittance Data",
      "networkId": "20240115123456789FEDNOW123456",
      "endToEndReferenceId": "E2E-FEDNOW-20240115-001"
    }
  },
  "correlationId": "8a2cdc8d-629d-4a24-98ac-40b735229fe2",
  "processingChannel": {
    "destination": "real-time-payments"
  }
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

enum<string>

default:application/vnd.dwolla.v1.hal+json

required

The media type of the response. Must be application/vnd.dwolla.v1.hal+json

Available options:

application/vnd.dwolla.v1.hal+json

Path Parameters

string

required

ID of transfer to be retrieved

Response

successful operation

_links

object

Show child attributes

_links.{key}

HalLink · object

Show child attributes

_links.{key}.href

string

Example:

"https://api.dwolla.com"

_links.{key}.type

string

Example:

"application/vnd.dwolla.v1.hal+json"

_links.{key}.resource-type

string

Example:

"resource-type"

string

Example:

"15c6bcce-46f7-e811-8112-e8dd3bececa8"

status

string

Example:

"pending"

amount

object

Show child attributes

amount.value

string

Example:

"42.00"

amount.currency

string

Example:

"USD"

created

string<date-time>

Example:

"2018-12-03T22:00:22.970Z"

clearing

object

Show child attributes

clearing.source

string

Example:

"standard"

clearing.destination

string

Example:

"same-day"

metadata

object

Show child attributes

metadata.paymentId

string

Example:

"12345678"

metadata.note

string

Example:

"Payment for completed work Dec. 1"

achDetails

object

ACH-specific details for the transfer. Present when transfer was processed via ACH network.

Show child attributes

achDetails.source

object

Information sent to the source/originating bank account along with the transfer

Show child attributes

achDetails.source.addenda

object

Contains addenda information for the transfer

Show child attributes

achDetails.source.addenda.values

string[]

An array containing a single string addenda value

achDetails.source.beneficiaryName

string

Beneficiary of the transaction's name. In general, should match the user onboarded to the Platform's name

Example:

"John Doe"

achDetails.source.companyEntryDescription

enum<string>

Describes the purpose of the transaction

Available options:

REVERSAL,

RECLAIM,

NO CHECK,

AUTOENROLL,

REDEPCHECK,

RETURN FEE,

RETRY PMNT,

HEALTHCARE,

PAYMENT

Example:

"PAYMENT"

achDetails.source.companyId

string

Numeric identifier of originator

Example:

"1234567890"

achDetails.source.companyName

string

Name of the originator

Example:

"Acme Corporation"

achDetails.source.effectiveDate

string<date>

The date when the ACH transaction becomes effective, formatted as YYYY-MM-DD. This is typically the settlement date for the transaction

Example:

"2021-12-01"

achDetails.source.postingData

string

Suggested memo line format for bank statements, structured as companyName:companyDiscretionaryData:beneficiaryName

Example:

"Acme Corporation:Payment Reference:John Doe"

achDetails.source.routingNumber

string

Routing number of Originating Depository Financial Institution (ODFI). Identifies the financial institution that originated the ACH transaction

Example:

"222222226"

achDetails.source.traceId

string

A unique identifier for tracing the ACH transaction through the banking network. Used for transaction tracking and reconciliation purposes

Example:

"222222225926346"

achDetails.destination

object

Information sent to the destination/receiving bank account along with the transfer

Show child attributes

achDetails.destination.addenda

object

Contains addenda information for the transfer

Show child attributes

achDetails.destination.addenda.values

string[]

An array containing a single string addenda value

achDetails.destination.beneficiaryName

string

Beneficiary of the transaction's name. In general, should match the user onboarded to the Platform's name

Example:

"Jane Smith"

achDetails.destination.companyEntryDescription

enum<string>

Describes the purpose of the transaction

Available options:

REVERSAL,

RECLAIM,

NO CHECK,

AUTOENROLL,

REDEPCHECK,

RETURN FEE,

RETRY PMNT,

HEALTHCARE,

PAYMENT

Example:

"PAYMENT"

achDetails.destination.companyId

string

Numeric identifier of originator

Example:

"1234567890"

achDetails.destination.companyName

string

Name of the originator

Example:

"Acme Corporation"

achDetails.destination.effectiveDate

string<date>

The date when the ACH transaction becomes effective, formatted as YYYY-MM-DD. This is typically the settlement date for the transaction

Example:

"2021-12-01"

achDetails.destination.postingData

string

Suggested memo line format for bank statements, structured as companyName:companyDiscretionaryData:beneficiaryName

Example:

"Acme Corporation:Payment Reference:Jane Smith"

achDetails.destination.routingNumber

string

Routing number of Originating Depository Financial Institution (ODFI). Identifies the financial institution that originated the ACH transaction

Example:

"222222226"

achDetails.destination.traceId

string

A unique identifier for tracing the ACH transaction through the banking network. Used for transaction tracking and reconciliation purposes

Example:

"222222225926346"

rtpDetails

object

Real-Time Payments (RTP) network specific details. Present when transfer was processed via RTP network.

Show child attributes

rtpDetails.destination

object

RTP destination details with network identifiers

Show child attributes

rtpDetails.destination.remittanceData

string

Remittance information included in the transfer request

Example:

"ABC_123 Remittance Data"

rtpDetails.destination.networkId

string

Unique identifier for the transfer within the RTP network

Example:

"20210617021214273T1BG27487110796028"

rtpDetails.destination.endToEndReferenceId

string

End-to-end reference identifier for the RTP transfer

Example:

"E2E-RTP-20210617-001"

fedNowDetails

object

FedNow Service network specific details. Present when transfer was processed via FedNow network.

Show child attributes

fedNowDetails.destination

object

FedNow destination details with network identifiers

Show child attributes

fedNowDetails.destination.remittanceData

string

Remittance information included in the transfer request

Example:

"ABC_123 Remittance Data"

fedNowDetails.destination.networkId

string

Unique identifier for the transfer within the FedNow network

Example:

"20240115123456789FEDNOW123456"

fedNowDetails.destination.endToEndReferenceId

string

End-to-end reference identifier for the FedNow transfer

Example:

"E2E-FEDNOW-20240115-001"

correlationId

string

Example:

"8a2cdc8d-629d-4a24-98ac-40b735229fe2"

processingChannel

object

Show child attributes

processingChannel.destination

enum<string>

The payment network used to process the transfer

Available options:

real-time-payments,

fed-now

Example:

"real-time-payments"

Initiate a transfer Cancel a transfer

⌘I

Introduction

Resources

Authorizations

Headers

Path Parameters

Response