Skip to content
/
Unlink a linked account

Unlink a linked account

Request

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

Security
apiKey and authToken
Path
linked_account_idstring^[0-9a-fA-F]{24}$read-onlyrequired

The unique identifier of the linked account.

Headers
idempotency-refstring

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.

curl -i -X POST \
  'https://sandbox.weavr.io/payment-run/v1/linked_accounts/{linked_account_id}/unlink' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -H 'idempotency-ref: string'

Responses

OK

Bodyapplication/json
idstring^[0-9a-fA-F]{24}$required

The unique identifier of the linked account

Example:"652d25b73541d8084a88a38d"
accountIdentificationFasterPaymentsBankDetails (object) or SepaBankDetails (object)required
One of:

Bank details used in case the wire transfer is executed over Faster Payments.

currencystring, = 3 charactersrequired

The primary currency associated with the account

Enum:"GBP""EUR"
institutionobjectrequired
consentobjectrequired
statusstringrequired

The status of the linked account. The status can be one of the following:

  • PENDING_CHALLENGE: The Linked Account is pending challenge
  • PENDING_VERIFICATION: The Linked Account is pending the completion of the required verification steps
  • PENDING_FUNDING: Awaiting a wire transfer as part of the verification process when adding an account without Open Banking
  • REJECTED: The Linked Account did not pass one or more verification steps and is not eligible for use
  • LINKED: The linked account is linked and ready for use
  • UNLINKED: The linked account is not linked and cannot be used
Enum:"LINKED""UNLINKED""PENDING_CHALLENGE""PENDING_FUNDING""PENDING_VERIFICATION""REJECTED"
friendlyNamestring, <= 80 characters

A user-friendly name for the linked account

Response
{
  "id": "652d25b73541d8084a88a38d",
  "accountIdentification": {
    "accountNumber": "stringst",
    "sortCode": "string",
    "secondaryReference": "string"
  },
  "currency": "GBP",
  "institution": {
    "displayName": "string",
    "countries": [ … ],
    "images": { … },
    "info": { … }
  },
  "consent": {
    "expiresAt": "2019-08-24T14:15:22Z",
    "expiresIn": 0,
    "status": "ACTIVE"
  },
  "status": "LINKED",
  "friendlyName": "string"
}