Skip to main content
PATCH
/
accounts
/
products
/
{product_id}
Patch account product
curl --request PATCH \
  --url https://api-sandbox.synctera.com/v0/accounts/products/{product_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accrual_payout_schedule": "MONTHLY",
  "calculation_method": "COMPOUNDED_DAILY",
  "description": "The rate is designed for high interest saving account.",
  "product_type": "INTEREST",
  "rates": [
    {
      "accrual_period": "DAILY",
      "rate": 1,
      "valid_from": "2023-12-25",
      "valid_to": "2023-12-25"
    }
  ]
}'
{
  "accrual_payout_schedule": "MONTHLY",
  "calculation_method": "COMPOUNDED_DAILY",
  "description": "The rate is designed for high interest saving account.",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "product_type": "FEE",
  "rates": [
    {
      "accrual_period": "DAILY",
      "rate": 1,
      "valid_from": "2023-12-25",
      "valid_to": "2023-12-25"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Path Parameters

​
product_id
string<uuid>
required

Account Product ID

Example:

"92113c51-e4ff-4e57-9558-08cab6b963dd"

Body

application/json

Account product fields to be patched

  • Option 1
  • Option 2
​
product_type
enum<string>
required
Available options:
INTEREST
​
accrual_payout_schedule
enum<string>
Available options:
MONTHLY,
NONE
​
calculation_method
enum<string>
Available options:
COMPOUNDED_DAILY,
COMPOUNDED_MONTHLY
​
description
string

User provided description for the current interest.

Example:

"The rate is designed for high interest saving account."

​
rates
object[]

A list of interest rate. Date intervals between valid_from and valid_to expect to have no overlap.

Response

Updated account product

  • Option 1
  • Option 2
​
accrual_payout_schedule
enum<string>
required
Available options:
MONTHLY,
NONE
​
calculation_method
enum<string>
required
Available options:
COMPOUNDED_DAILY,
COMPOUNDED_MONTHLY
​
product_type
enum<string>
required
Available options:
FEE,
INTEREST
​
rates
object[]
required

A list of interest rate. Date intervals between valid_from and valid_to expect to have no overlap.

​
description
string

User provided description for the current interest.

Example:

"The rate is designed for high interest saving account."

​
id
string<uuid>

Interest ID