Update an account under a specific customer

Suggest Edits

You may need to update a customer's account on your platform. Use the PATCH {URI}/customers/{customerIdentifier}/accounts/{accountIdentifier} endpoint to update an account under a specific customer:

Endpoint	Purpose
`PATCH {URI}/customers/{customerIdentifier}/accounts/{accountIdentifier}`	Update an account under a specific customer on this platform.

The following path parameters are used with this endpoint:

Path params	Data type	Description
customerIdentifier	string	(Required) A unique identifier for the customer under which you are creating a new account. The string must have 5-100 characters.
accountIdentifier	string	The accountIdentifier for the account you are updating.

The following body parameters are used with this endpoint:

Body params	Data type	Description
displayName	string	(Optional) Update the friendly name for this account. The string must be between 5-100 characters. Emojis are not accepted for `displayName` or any text entry.
contactEmail	string	(Optional) Update the designated representative email address for this account. The string may have up to 100 characters.
fundingNotification	array of objects	(Optional) Update the funding notification email address(es).
- emailAddress	string	(Required when using `fundingNotification`) Update or add email addresses for funding notifications on this account. A provided list replaces the existing list, an empty list clears all existing emails, and a null/omitted value leaves the list unchanged.

The following payload is an example for when you use PATCH {URI}/customers/{customerIdentifier}/accounts/{accountIdentifier} :

{
  "currentBalance": 0,
  "contactEmail": "string",
  "fundingNotification": [
    {
      "emailAddress": "string"
    }
  ],
  "accountIdentifier": "string",
  "accountNumber": "string",
  "displayName": "string",
  "createdAt": "2024-03-14T16:18:41.061Z",
  "status": "string",
  "currencyCode": "string"
}

Here's an example payload for when you receive an error:

{
  "timestamp": "2025-02-21T23:23:13.930Z",
  "requestId": "string",
  "path": "string",
  "httpCode": 0,
  "httpPhrase": "string",
  "i18nKey": "string",
  "message": "The error message will show here for error codes ",
  "errors": [
    {}
  ]
}

The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:

200 OK
400 Bad request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
503 Service Unavailable

Updated 3 months ago