API Documentation

Create product

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

API endpoint to create a new product.

Body Params

Data Contract used to create a new Product

string | null

Name of the Product to Create

string | null

Defines the default Tax exempt state for this product. When generating a service of this product, it will get this TaxExemptState by default.

string | null

Defines the default Charge Handling Method. When generating a service of this product, it will get this ChargHandlingMethod by default.

string | null

Defines the default StatementForm. When generating a service of this product, it will get this StatementForm by default.

int32

List of features this Product has.

schemes
object

Data container for a Product's schemes

allowedCurrencies
array of strings | null

Currencies allowed for this product.

allowedCurrencies
generalInstructions
array of objects | null

List of general instructions for this product.

generalInstructions
statementFrequency
object

An interval expressed as a number of time units.

productServiceBehaviors
array of strings | null

List of service behaviors to add to the product.

productServiceBehaviors
string | null

Account identifier for the fallback error account of the product.

string | null

Account identifier for the fallback counter account of the product.

string | null

The service state, all new services, under this product, will get initially.

bbanFormat
object

Product BBAN format item

featureParameters
array of objects | null

Feature parameters

featureParameters
boolean

Incoming payments must come from nominated accounts.

boolean

Outgoing payments must go to nominated accounts.

boolean

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

int32

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

int32

Default general ledger account for booking unpaid accrued interest.

string | null

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

string | null

External product identifier, provided by the caller. Must be unique within the center.

Headers
string
required
Defaults to v1

API versioning

uuid
required

Correlates HTTP requests between a client and server

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

500

Internal Server Error

Updated 13 days ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json

Updated 13 days ago

Did this page help you?