Weavr
Powered by Redocly

Linked Accounts

Linked accounts represent bank accounts that the buyer has with other banks. Once set up, they are used to fund payment runs.

Get Linked accounts

Retrieves the linked accounts belonging to the buyer that the logged-in user belongs to.

Required user role: CONTROLLER

SecurityapiKey and authToken
Responses
200

OK

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

get/v1/linked_accounts
Response samples
application/json
{
  • "linkedAccounts": [
    ],
  • "count": 0,
  • "responseCount": 0
}

Get Linked account

Retrieves a linked account of the buyer that the logged-in user belongs to.

Required user role: CONTROLLER

SecurityapiKey and authToken
Request
path Parameters
linked_account_id
required
string^[0-9a-fA-F]{24}$

The unique identifier of the linked account.

Responses
200

OK

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

404

Not found - The requested resource couldn't be found.

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

get/v1/linked_accounts/{linked_account_id}
Response samples
application/json
{
  • "id": "652d25b73541d8084a88a38d",
  • "accountIdentification": {
    },
  • "currency": "GBP",
  • "institution": {
    },
  • "consent": {
    },
  • "status": "LINKED"
}

Unlink a linked account

Unlinks a linked account identified by the linked_account_id.

This action is not reversible and if the buyer wants to use this linked account again to fund payment runs, they will have to re-link the account. More information on how to link an account can be found here.

Details of an unlinked account, can still be retrieved via the Get linked accounts and Get linked account endpoints.

Required user role: CONTROLLER

SecurityapiKey and authToken
Request
path Parameters
linked_account_id
required
string^[0-9a-fA-F]{24}$

The unique identifier of the linked account.

header Parameters
idempotency-ref
string

A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.

Responses
200

OK

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

404

Not found - The requested resource couldn't be found.

409

Conflict

413

Content Too Large

422

Unprocessable Entity

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

post/v1/linked_accounts/{linked_account_id}/unlink
Response samples
application/json
{
  • "id": "652d25b73541d8084a88a38d",
  • "accountIdentification": {
    },
  • "currency": "GBP",
  • "institution": {
    },
  • "consent": {
    },
  • "status": "LINKED"
}
➔ Next to Institutions