Update an account under a specific customer
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. |
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 example shows the response 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"
}
The possible response codes for this endpoint are:
- 200 OK
- 400 Bad request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
Updated 6 days ago