LinkedAccounts

Get Linked Accounts for User

Retrieves all linked bank accounts for a specific user. These accounts can be used for funding payments by providing the linkedAccountId when creating a payment.

get/api/v1/users/:userId/linked-accounts

Request

Base URL
https://merchant-api.accruesavings.com
Auth
none declared. Required headers: Client-ID, Authorization
TypeScript
https://skmtc.dev/byaccrue/apis/accrue-merchant-api/docs/api/v1/users/:userId/linked-accounts/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

userIdstring uuid required

The ID of the user whose linked accounts to retrieve.

Example:123e4567-e89b-12d3-a456-426614174000

Headers

Client-IDstring uuid required

The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.

Example:123e4567-e89b-12d3-a456-426614174000

Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Response

Example response

{
  "data": [
    {
      "attributes": {
        "accountName": "Plaid Checking",
        "accountMask": "0000",
        "institutionName": "Plaid Bank",
        "institutionId": "ins_109508"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.