BRbrale
Financial Institutions

Register financial institution account via Plaid and return address ID

Changed on

Registers a financial institution account using Plaid public token and returns the address ID

post/accounts/{account_id}/plaid/register-account

Request

  • Base URL
    https://api.brale.xyz
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.brale.xyz/oauth2/token scopes: financial-institutions:write

Path parameters

account_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Account ID

Request body

account_holder_type'individual' | 'business'

Whether the bank account belongs to an individual or a business. Used when Plaid does not report it.

customer_webhook_urlstring uri required

URL where customer will receive webhook notifications when Plaid items need updates (required for account registration)

ownership'first_party' | 'third_party'

Ownership type of the financial institution. Defaults to third_party when not provided.

public_tokenstring required

The public token returned from Plaid Link

transfer_typesstring[] required

Transfer types to support for this financial institution. fednow_credit is available only to accounts it has been enabled for.

Example request

{
  "customer_webhook_url": "https://customer.com/webhooks/plaid-updates",
  "public_token": "public-sandbox-123456789",
  "transfer_types": [
    "ach_credit",
    "wire"
  ]
}

Response

Created

address_idstring required

The ID of the created address

Example response

{
  "address_id": "addr_123456789"
}

Changes

  • 5648b7f3a014Revision changes
    • info

      added the new optional request property

  • d934fd29acc3Revision changes
    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status