Transfer Platform Payments
API reference for Transfer Platform Payments endpoints
Platform Payments | |
---|---|
/transfer/originator/create | Create a new originator |
/transfer/originator/get | Get the status of an originator's onboarding |
/transfer/originator/list | Get the status of all originators' onboarding |
/transfer/originator/funding_account/update | Update the default funding account of an originator |
/transfer/questionnaire/create | Generate a Plaid-hosted onboarding UI URL |
/transfer/originator/create
Create a new originator
Use the /transfer/originator/create
endpoint to create a new originator and return an originator_client_id
.
client_id
client_id
. The client_id
is required and may be provided either in the PLAID-CLIENT-ID
header or as part of a request body.secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.company_name
1
1const request: TransferOriginatorCreateRequest = {2 company_name: 'Marketplace of Shannon',3};45try {6 const response = await client.transferOriginatorCreate(request);7} catch (error) {8 // handle error9}
Response fields and example
originator_client_id
company_name
request_id
1{2 "originator_client_id": "6a65dh3d1h0d1027121ak184",3 "company_name": "Marketplace of Shannon",4 "request_id": "4zlKapIkTm8p5KM"5}
Was this helpful?
/transfer/originator/get
Get status of an originator's onboarding
The /transfer/originator/get
endpoint gets status updates for an originator's onboarding process. This information is also available via the Transfer page on the Plaid dashboard.
client_id
client_id
. The client_id
is required and may be provided either in the PLAID-CLIENT-ID
header or as part of a request body.secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.originator_client_id
1const request: TransferOriginatorGetRequest = {2 originator_client_id: '6a65dh3d1h0d1027121ak184',3};45try {6 const response = await client.transferOriginatorGet(request);7} catch (error) {8 // handle error9}
Response fields and example
originator
client_id
transfer_diligence _status
not_submitted
, submitted
, under_review
, approved
, denied
company_name
request_id
1{2 "originator": {3 "client_id": "6a65dh3d1h0d1027121ak184",4 "transfer_diligence_status": "approved",5 "company_name": "Plaid"6 },7 "request_id": "saKrIBuEB9qJZno"8}
Was this helpful?
/transfer/originator/list
Get status of all originators' onboarding
The /transfer/originator/list
endpoint gets status updates for all of your originators' onboarding. This information is also available via the Plaid dashboard.
client_id
client_id
. The client_id
is required and may be provided either in the PLAID-CLIENT-ID
header or as part of a request body.secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.count
25
1
25
offset
0
0
1const request: TransferOriginatorListRequest = {2 count: 14,3 offset: 2,4};56try {7 const response = await client.transferOriginatorList(request);8} catch (error) {9 // handle error10}
Response fields and example
originators
client_id
transfer_diligence _status
not_submitted
, submitted
, under_review
, approved
, denied
request_id
1{2 "originators": [3 {4 "client_id": "6a65dh3d1h0d1027121ak184",5 "transfer_diligence_status": "approved"6 },7 {8 "client_id": "8g89as4d2k1d9852938ba019",9 "transfer_diligence_status": "denied"10 }11 ],12 "request_id": "4zlKapIkTm8p5KM"13}
Was this helpful?
/transfer/originator/funding_account/update
Update the funding account associated with the originator
Use the /transfer/originator/funding_account/update
endpoint to update the funding account associated with the originator.
client_id
client_id
. The client_id
is required and may be provided either in the PLAID-CLIENT-ID
header or as part of a request body.secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.originator_client_id
funding_account
/transfer/migrate_account
.access_token
account_id
account_id
for the newly created Item.1const request: TransferOriginatorFundingAccountUpdateRequest = {2 originator_client_id: '6a65dh3d1h0d1027121ak184',3 funding_account: {4 access_token: 'access-sandbox-71e02f71-0960-4a27-abd2-5631e04f2175',5 account_id: '3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr',6 },7};89try {10 const response = await client.transferOriginatorFundingAccountUpdate(request);11} catch (error) {12 // handle error13}
Response fields and example
request_id
1{2 "request_id": "saKrIBuEB9qJZno"3}
Was this helpful?
/transfer/questionnaire/create
Generate a Plaid-hosted onboarding UI URL.
The /transfer/questionnaire/create
endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaid’s terms for ACH money movement.
client_id
client_id
. The client_id
is required and may be provided either in the PLAID-CLIENT-ID
header or as part of a request body.secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.originator_client_id
redirect_uri
1const request: TransferQuestionnaireCreateRequest = {2 originator_client_id: '6a65dh3d1h0d1027121ak184',3 redirect_uri: 'https://example.com',4};56try {7 const response = await client.transferQuestionnaireCreate(request);8} catch (error) {9 // handle error10}
Response fields and example
onboarding_url
request_id
1{2 "onboarding_url": "https://plaid.com/originator/hIFGXx1zM5pFerygu7lw",3 "request_id": "saKrIBuEB9qJZno"4}