Linked Account APIs

The Linked Account APIs provide for managing the Linked Account workflow available in the Etana dashboard.

Get a list of Linked Accounts

Query for Linked Accounts for a given agent. This API will respond with a list of Linked Accounts as below.

Request method

escrow/find/agent

Parameters

Field	Type	Description
agent_profile_id	string	The profile identifier of the agent.

Response

Field	Type	Description
escrow_id	string	The unique identifier of this request.
create_ts	timestamp	Timestamp of creation.
update_ts	timestamp	Timestamp of last update.
state	string	State of this request: 'pending', 'approved', 'rejected'
reject_reason	string	If rejected, a reason for why.
agent_profile_id	string	The agent's unique profile identifier.
cust_profile_id	string	The customer's unique profile identifier.
agent_account_id	string	The agent's identifier for this customer.

Approve a Linked Account Request

Acknowledge a Linked Account in the requested state with approval, creating the Linked Account.

Request method

platform/escrow/request/approve

Parameters

Field	Type	Description
request_id	string	The identifier of the request to approve.

Response

Field	Type	Description
request_id	string	The unique identifier of this request.
create_ts	timestamp	Timestamp of creation.
update_ts	timestamp	Timestamp of last update.
state	string	State of this request: 'pending', 'approved', 'rejected'
reject_reason	string	If rejected, a reason for why.
agent_profile_id	string	The agent's unique profile identifier.
cust_profile_id	string	The customer's unique profile identifier.
agent_account_id	string	The agent's identifier for this customer.

Reject a Linked Account Request

Acknowledge a Linked Account Request with rejection.

Request method

escrow/request/reject

Parameters

Field	Type	Description
request_id	string	The identifier of the request to reject.
reason	string	The reason for rejection.

Response

Field	Type	Description
request_id	string	The unique identifier of this request.
create_ts	timestamp	Timestamp of creation.
update_ts	timestamp	Timestamp of last update.
state	string	State of this request: 'pending', 'approved', 'rejected'
reject_reason	string	If rejected, a reason for why.
agent_profile_id	string	The agent's unique profile identifier.
cust_profile_id	string	The customer's unique profile identifier.
agent_account_id	string	The agent's identifier for this customer.

Get a list of Linked Account Transfer Requests

Query for Linked Account Transfer Requests for a linked accounts associated with a given agent. This API will respond with a list of Transfer Requests as below.

Request method

escrow/transfer/find/agent

Parameters

Field	Type	Description
profile_id	string	The profile identifier of the agent.

Response

Field	Type	Description
request_id	string	The unique identifier of this request.
create_ts	timestamp	Timestamp of creation.
update_ts	timestamp	Timestamp of last update.
state	string	State of this request: 'requested', 'approved', 'rejected'
reject_reason	string	If rejected, a reason for why.
escrow_id	string	The identifier of the linked account.
agent_profile_id	string	The agent's unique profile identifier.
cust_profile_id	string	The customer's unique profile identifier.
agent_account_id	string	The agent's identifier for this customer.
account_id	string	The linked account number.
destination_account_id	string	The destination account number for the transfer.
sec_id	string	The security to be transferred.
amount	string	The amount to be transferred.

Approve a Linked Account Transfer Request

Acknowledge a Linked Account Transfer Request with approval, performing the transfer of funds.

Request method

platform/transfer/approve

Parameters

Field	Type	Description
request_id	string	The identifier of the request to approve.

Response

Field	Type	Description
request_id	string	The unique identifier of this request.
create_ts	timestamp	Timestamp of creation.
update_ts	timestamp	Timestamp of last update.
state	string	State of this request: 'requested', 'approved', 'rejected'
reject_reason	string	If rejected, a reason for why.
escrow_id	string	The identifier of the linked account.
agent_profile_id	string	The agent's unique profile identifier.
cust_profile_id	string	The customer's unique profile identifier.
agent_account_id	string	The agent's identifier for this customer.
account_id	string	The linked account number.
destination_account_id	string	The destination account number for the transfer.
sec_id	string	The security to be transferred.
amount	string	The amount to be transferred.

Reject a Linked Account Transfer Request

Acknowledge a Linked Account Transfer Request with rejection.

Request method

escrow/transfer/reject

Parameters

Field	Type	Description
request_id	string	The identifier of the request to reject.
reason	string	The reason for rejection.

Response

Field	Type	Description
request_id	string	The unique identifier of this request.
create_ts	timestamp	Timestamp of creation.
update_ts	timestamp	Timestamp of last update.
state	string	State of this request: 'requested', 'approved', 'rejected'
reject_reason	string	If rejected, a reason for why.
escrow_id	string	The identifier of the linked account.
agent_profile_id	string	The agent's unique profile identifier.
cust_profile_id	string	The customer's unique profile identifier.
agent_account_id	string	The agent's identifier for this customer.
account_id	string	The linked account number.
destination_account_id	string	The destination account number for the transfer.
sec_id	string	The security to be transferred.
amount	string	The amount to be transferred.