Update product

put

https://apim.demo01.my.fivedegrees.cloud/sbx/account-configuration/products

API endpoint to update an existing product.

Body Params

Data Contract used to update a Product

string | null

The product identifier.

name

string | null

Product Name. Must be unique within the center.

defaultTaxExemptState

string | null

Default tax exempt state.

chargeHandlingMethod

string | null

Charge handling method.

statementForm

string | null

Statement form.

featureId

int32

Product feature identifier.

schemes

object

Data container for a Product's schemes

allowedCurrencies

array of strings | null

A list of allowed currencies for the product. Standard three letter currency codes in upper case.

allowedCurrencies

generalInstructions

array of objects | null

A list of general instructions.

generalInstructions

statementFrequency

object

An interval expressed as a number of time units.

productServiceBehaviors

array of strings | null

A list of service behaviors linked to this product.

productServiceBehaviors

fallbackErrorAccount

string | null

Fallback error account identifier

fallbackCounterAccount

string | null

Fallback counter account identifier

initialServiceState

string | null

Initial service state of services.

bbanFormat

object

Product BBAN format item

featureParameters

array of objects | null

List of feature parameters

featureParameters

nominatedAccountIncoming

boolean

Incoming payments must come from nominated accounts.

nominatedAccountOutgoing

boolean

Outgoing payments must go to nominated accounts.

nominatedAccountFirstPaymentOnly

boolean

Only the first incoming payment must come from a nominated account.

defaultGlAccountId

int32

Identifies the general ledger account to be used for this product, as a default.

defaultAccruedInterestGlAccountId

int32

Default general ledger account identifier for booking of unpaid accrued interest.

afterAwaitingTransactionState

string | null

The state the service will be set to after beeing in state 5-AwaitingTransaction.

updateGeneralInstructions

boolean

Required to be true to update product general instructions, if false general instructions won't update even if there are pending changes.

updateServiceBehaviors

boolean

Required to be true to update product service behaviors, if false service behaviors won't update even when if there are pending changes.

externalProductId

string | null

The external product identifier.

Headers

accept-version

string

required

Defaults to v1

API versioning

x-request-id

uuid

required

Correlates HTTP requests between a client and server

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

500

Internal Server Error

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

200OK

400Bad Request

401Unauthorized

403Forbidden