Delink Accounts API
The method is used to delete a previously established account linkage to the user’s profile. Once deleted, the Account Aggregation function will not use these accounts and perform any data flow on them.
Request Parameters
Parameter Name
Data type
Required?
Description
ver
string
yes
Version of the API. Example:"1.0"
timestamp
string (date-time)
Yes
Creation timestamp of the message which will be updated at each call. Example : "2018-05-09T17:51:18.412Z"
txnid
string
Yes
An unique transaction identifier used for providing an end to end traceability. Example : "f35761ac-4a18-11e8-96ff-0277a9fbfedc"
Account
A list of customer’s accounts to be linked
customerAddress
string
No
Example : "customer_address@aa_identifier"
linkRefNumber
string
No
Example : "xxxxxxxxxxxxx"
Response Parameters
Parameter Name
Data type
Required?
Description
ver
string
Yes
The version of the API. Example: "1.0"
timestamp
string (date-time)
Yes
Creation timestamp of the message which will be updated at each leg. Example: "2018-12-06T11:39:57.153Z"
txnid
string
Yes
An unique transaction identifier used for providing an end to end traceability. Example: "f35761ac-4a18-11e8-96ff-0277a9fbfedc"
AccLinkDetails
List of accounts successfully delinked
customerAddress
string
No
Example : "customer_address
@aa_identifier"
linkRefNumber
string
No
Example : "xxxxxxxxxxxxx"
status
string
No
Example : "DELINKED"
Example
Sample Request
{
"ver": "1.0",
"timestamp": "2018-05-09T17:51:18.412Z",
"txnid": "f35761ac-4a18-11e8-96ff-0277a9fbfedc",
"Account": {
"customerAddress": "customer_address@aa_identifier",
"linkRefNumber": "xxxxxxxxxxxxx"
}
}
Sample Response
{
"ver": "1.0",
"timestamp": "2018-05-05T10:27:17.699+0000",
"txnid": "410c2d2e-4a1e-11e8-960e-0277a9fbfedc",
"AccLinkDetails": [
{
"customerAddress": "customer_address@aa_identifier",
"linkRefNumber": "xxxxxxxxxxxxx",
"status": "DELINKED"
}
]
}