PIpismo
Account attachment

Update payout account for deposit account

Update the payout account configuration for an attached deposit account. The payout account specifies where interest payments and maturity proceeds are sent.

patch/v1/deposits/accounts/{accountId}

Request

  • Base URL
    https://sandbox.pismolabs.io/savings-products
  • URL
    https://sandbox.pismolabs.io/savings-products/v1/deposits/accounts/{accountId}
  • Auth
    HTTP bearer

Path parameters

accountIdstring required

Account ID. Accepts either the Pismo account_id or your external_account_id. Send the same ID used to generate the access token.

Request body

Example request

{
  "payout_account": {
    "label": "My payout account",
    "type": "INTERNAL",
    "internal_account_id": 123456,
    "external_account": {
      "key": "value"
    }
  }
}

Response

Payout account updated successfully

updated_atstring date-time

The date and time when the payout account was updated

external_account_idstring

External account ID. Returned only when the account has an external account identifier.

Example response

{
  "payout_account": {
    "label": "My payout account",
    "type": "INTERNAL",
    "internal_account_id": 123456,
    "external_account": {
      "key": "value"
    }
  },
  "updated_at": "2024-01-23T13:26:25.000Z",
  "external_account_id": "ext-acct-001"
}

Changes

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