Skip to content

exchangesession.md

Latest commit

 

History

History
54 lines (47 loc) · 6.68 KB

exchangesession.md

File metadata and controls

54 lines (47 loc) · 6.68 KB

ExchangeSession

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).

Example Usage

import { ExchangeSession } from "dwolla/models";

let value: ExchangeSession = {
  created: new Date("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",
      resourceType: "exchange-sessions",
    },
    exchangePartner: {
      href:
        "https://api.dwolla.com/exchange-partners/bca8d065-49a5-475b-a6b4-509bc8504d22",
      type: "application/vnd.dwolla.v1.hal+json",
      resourceType: "exchange-partner",
    },
    externalProviderSession: {
      href:
        "https://www.mx.com/connect/lAfkc7m897s3t1ks9mmwyj4ry7Zq0xql4grzAg1kz77x7c9jrwls1t22w6xt8d2lsxx9zpqv30js3wswfdwcrpAsqgbAfkqwpksp7c2chsx167xy90Asfc67dkj9y48y8p142xw3yp4x5l9t9gkk6m3yk5vwsvyq2qq7w9trszxwdl14lmkg7l6949bn5n41chdkbnxycy40n9b6fkbdwl6qt5wl107k1x8srvlkpz325p412x9tkyA5clf39109lsfrgz2lkgsvntqf7l0zzwb5hl658gdjbxwhb52krwybnbdAqfq69cdy54l05jkvfwyf01q89x48jtgtx290lzjdfcty1lwb8d648wns/eyJ1aV9tZXNzYWdlX3ZlcnNpb24iOjQsInVpX21lc3NhZ2Vfd2Vidmlld191cmxfc2NoZW1lIjoibXgiLCJtb2RlIjoidmVyaWZpY2F0aW9uIn0%3D",
      type: "application/vnd.dwolla.v1.hal+json",
      resourceType: "text/html",
    },
  },
  externalProviderSessionToken:
    "link-production-b41e8ed3-0874-4c64-b07d-a77088979d5f",
  externalProviderSessionData: {
    id: "ps_39vhHjFxZuJRKOw5Hexbnv39fC7",
    paymentSessionSecret: "pss_2400dd88-171d-4a9c-bebf-e06b56d59bb6",
    paymentSessionToken:
      "YmFzZTY0:eyJpZCI6InBzXzM5dmhIakZ4WnVKUktPdzVIZXhibnYzOWZDNyIs...",
  },
};

Fields

Field Type Required Description Example
created Date ✔️ N/A 2024-03-25T17:13:38.430Z
links models.ExchangeSessionLinks ✔️ N/A
externalProviderSessionToken string ➖ Present for Plaid exchange sessions.
Contains the token to initialize the Plaid Link flow.
 link-production-b41e8ed3-0874-4c64-b07d-a77088979d5f
externalProviderSessionData models.ExternalProviderSessionData ➖ 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.