Transfer for Platforms

1const request: TransferPlatformOriginatorCreateRequest = {
2    originator_client_id: "6a65dh3d1h0d1027121ak184",
3    tos_acceptance_metadata: {
4      agreement_accepted: true,
5      originator_ip_address: "192.0.2.42",
6      agreement_accepted_at: "2017-09-14T14:42:19.350Z"
7    },
8    originator_reviewed_at: "2024-07-29T20:22:21Z",
9    webhook: "https://webhook.com/webhook"
10};
11
12try {
13  const response = await client.transferPlatformOriginatorCreate(request);
14} catch (error) {
15  // handle error
16}

1const request: TransferPlatformPersonCreateRequest = {
2  originator_client_id: "6a65dh3d1h0d1027121ak184",
3  name: {
4    given_name: "Owen",
5    family_name: "Gillespie"
6  },
7  email_address: "ogillespie@plaid.com",
8  phone_number: "+12223334444",
9  address: {
10    street: "123 Main St.",
11    street2: "Apt 456",
12    city: "San Francisco",
13    region: "CA",
14    postal_code: "94580",
15    country: "US"
16  },
17  id_number: {
18    type: "us_ssn",
19    value: "111223333"
20  },
21  date_of_birth: "2000-01-20",
22  relationship_to_originator: "BENEFICIAL_OWNER",
23  ownership_percentage: 50,
24  title: "COO"
25};
26
27try {
28  const response = await client.transferPlatformPersonCreate(request);
29} catch (error) {
30  // handle error
31}

1const request: TransferPlatformRequirementSubmitRequest = {
2  originator_client_id: "6a65dh3d1h0d1027121ak184",
3  requirement_submissions: [
4    {
5      requirement_type: "BUSINESS_NAME",
6      value: "Owen's Widgets Inc."
7    },
8    {
9      requirement_type: "BUSINESS_EIN",
10      value: "123-45-6789"
11    },
12    {
13      requirement_type: "BUSINESS_BANK_ACCOUNT",
14      value: "{\"access_token\": \"<access token>\",\"account_id\": \"<account id>\"}"
15    },
16    {
17      requirement_type: "BUSINESS_ORG_TYPE",
18      value: "LIMITED LIABILITY COMPANY"
19    },
20    {
21      requirement_type: "BUSINESS_INDUSTRY",
22      value: "TELECOMMUNICATIONS"
23    },
24    {
25      requirement_type: "BUSINESS_ADDRESS",
26      value: "{\"city\":\"San Francisco\",\"country\":\"US\",\"postal_code\":\"94105\",\"region\":\"CA\",\"street\":\"123 Market St\",\"street2\":\"Suite 400\"}"
27    },
28    {
29      requirement_type: "BUSINESS_WEBSITE",
30      value: "https://plaid.com"
31    },
32    {
33      requirement_type: "BUSINESS_PRODUCT_DESCRIPTION",
34      value: "This is a sample description."
35    },
36    {
37      requirement_type: "ASSOCIATED_PEOPLE",
38      value: "[\"8b0e3210-767a-4882-9154-89b1e4c20493\",\"6ce1022c-d2c6-416d-a587-ed5e3f9bf941\"]"
39    },
40    {
41      requirement_type: "PERSON_NAME",
42      person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",
43      value: "{\"given_name\": \"Jane\",\"family_name\": \"Smith\"}"
44    },
45    {
46      requirement_type: "PERSON_ID_NUMBER",
47      person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",
48      value: "{\"type\": \"us_ssn\",\"value\": \"123456789\"}"
49    },
50    {
51      requirement_type: "PERSON_ADDRESS",
52      person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",
53      value: "{\"city\":\"San Francisco\",\"country\":\"US\",\"postal_code\":\"94105\",\"region\":\"CA\",\"street\":\"123 Market St\",\"street2\":\"Suite 100\"}"
54    },
55    {
56      requirement_type: "PERSON_DOB",
57      person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",
58      value: "1999-12-31"
59    },
60    {
61      requirement_type: "PERSON_EMAIL",
62      person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",
63      value: "sample@example.com"
64    },
65    {
66      requirement_type: "PERSON_PHONE",
67      person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",
68      value: "+12345678909"
69    },
70    {
71      requirement_type: "PERSON_RELATIONSHIP",
72      person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",
73      value: "BENEFICIAL_OWNER"
74    },
75    {
76      requirement_type: "PERSON_PERCENT_OWNERSHIP",
77      person_id: "8b0e3210-767a-4882-9154-89b1e4c20493",
78      value: "50"
79    },
80    {
81      requirement_type: "PERSON_TITLE",
82      person_id: "8b0e3210-767a-4882-9154-89b1e4c20493",
83      value: "COO"
84    }
85  ]
86};
87
88
89try {
90  const response = await client.transferPlatformRequirementSubmit(request);
91} catch (error) {
92  // handle error
93}

1const request: TransferOriginatorGetRequest = {
2  originator_client_id: '6a65dh3d1h0d1027121ak184',
3};
4
5try {
6  const response = await client.transferOriginatorGet(request);
7} catch (error) {
8  // handle error
9}

1const request: TransferOriginatorListRequest = {
2  count: 14,
3  offset: 2,
4};
5
6try {
7  const response = await client.transferOriginatorList(request);
8} catch (error) {
9  // handle error
10}

1const request: TransferOriginatorFundingAccountCreateRequest = {
2  originator_client_id: '6a65dh3d1h0d1027121ak184',
3  funding_account: {
4    access_token: 'access-sandbox-71e02f71-0960-4a27-abd2-5631e04f2175',
5    account_id: '3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr',
6    display_name: "New Funding Account",
7  },
8};
9
10try {
11  const response = await client.transferOriginatorFundingAccountCreate(request);
12} catch (error) {
13  // handle error
14}