Retrieve exchange session

Returns details of a previously created exchange session, including URLs and tokens needed to continue the instant account verification flow. Response varies by partner - MX provides redirect URLs while Plaid provides session tokens for Link initialization.

GET /exchange-sessions/{id}

cURL

cURL

GET https://api.dwolla.com/exchange-sessions/e5e9f2d3-a96c-4abd-a097-8ec7ae28aa8a
Accept: application/vnd.dwolla.v1.hal+json
Authorization: Bearer pBA9fVDBEyYZCEsLf/wKehyh1RTpzjUj5KzIRfDi0wKTii7DqY

200

{
  "created": "2024-03-25T17:13:38.430Z",
  "_links": {
    "self": {
      "href": "https://api.dwolla.com/exchange-sessions/9b7fb629-0fad-44f4-8c5e-44c25a0bfa8e",
      "type": "application/vnd.dwolla.v1.hal+json",
      "resource-type": "exchange-sessions"
    },
    "exchange-partner": {
      "href": "https://api.dwolla.com/exchange-partners/bca8d065-49a5-475b-a6b4-509bc8504d22",
      "type": "application/vnd.dwolla.v1.hal+json",
      "resource-type": "exchange-partner"
    },
    "external-provider-session": {
      "href": "https://www.mx.com/connect/lAfkc7m897s3t1ks9mmwyj4ry7Zq0xql4grzAg1kz77x7c9jrwls1t22w6xt8d2lsxx9zpqv30js3wswfdwcrpAsqgbAfkqwpksp7c2chsx167xy90Asfc67dkj9y48y8p142xw3yp4x5l9t9gkk6m3yk5vwsvyq2qq7w9trszxwdl14lmkg7l6949bn5n41chdkbnxycy40n9b6fkbdwl6qt5wl107k1x8srvlkpz325p412x9tkyA5clf39109lsfrgz2lkgsvntqf7l0zzwb5hl658gdjbxwhb52krwybnbdAqfq69cdy54l05jkvfwyf01q89x48jtgtx290lzjdfcty1lwb8d648wns/eyJ1aV9tZXNzYWdlX3ZlcnNpb24iOjQsInVpX21lc3NhZ2Vfd2Vidmlld191cmxfc2NoZW1lIjoibXgiLCJtb2RlIjoidmVyaWZpY2F0aW9uIn0%3D",
      "type": "application/vnd.dwolla.v1.hal+json",
      "resource-type": "text/html"
    }
  },
  "externalProviderSessionToken": "link-production-b41e8ed3-0874-4c64-b07d-a77088979d5f",
  "externalProviderSessionData": {
    "id": "ps_39vhHjFxZuJRKOw5Hexbnv39fC7",
    "payment_session_secret": "pss_2400dd88-171d-4a9c-bebf-e06b56d59bb6",
    "payment_session_token": "YmFzZTY0:eyJpZCI6InBzXzM5dmhIakZ4WnVKUktPdzVIZXhibnYzOWZDNyIs..."
  }
}

Authorizations

Authorization · string · header · required

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

Headers

Accept · 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

id · string · required

Exchange session's unique identifier

Response

200

application/vnd.dwolla.v1.hal+json

successful operation

Details of a previously created exchange session. Response shape varies by exchange partner.

• MX: includes _links.external-provider-session.href (redirect URL).
• Plaid: includes externalProviderSessionToken (Link initialization token).
• Checkout.com: includes externalProviderSessionData (payment session for Flow/debit card capture).

created · string<date-time> · required

Example:

"2024-03-25T17:13:38.430Z"

_links · object · required

Show child attributes

externalProviderSessionToken · string

Present for Plaid exchange sessions. Contains the token to initialize the Plaid Link flow.

Example:

"link-production-b41e8ed3-0874-4c64-b07d-a77088979d5f"

externalProviderSessionData · object

Present for Checkout.com exchange sessions (Push to Card / debit card flow). Use these fields to initialize the Checkout.com Flow component for card capture.

Show child attributes