Create MerchantPaymentAccount

post

https://api.isx-stage-westeurope.instellix.io/v2/merchant-payment-accounts

Create MerchantPaymentAccount kept by a bank/PSP on behalf of its customer.

Body Params

A CreateMerchantPaymentAccount is used to create a merchant payment account representing an account kept by a bank/PSP on behalf of its customer.

active

boolean

required

Specifies if a merchant payment account is active, that means if payments from this account are processed in system.
Must not be null.

additionallyAcceptedCurrencies

array | null, unique

List of currencies accepted by the MerchantPaymentAccount in addition to the base currency.

country

string

required

Two- or three-letter country code in ISO 3166-1 standard. See Wikipedia.

currency

string

required

Currency code. Three letters ISO-4217 format.

ident

string

required

length between 1 and 100

^[a-zA-Z0-9_.~-]*$

Unique identifier.

name

string

required

length between 1 and 255

^\S(.*\S)?$

Name of the merchant payment account.
Must not be null.
Size must be between 1 and 255.
Must match the regular expression ^\S(.*\S)?$.

paymentCollectionConfig

PaymentCollectionConfig | null

Configuration for payment collection timing.

paymentServiceProviderId

int64

required

Id of the payment service provider.
Must not be null.

settlementConfig

CreateSettlementConfig | null

Settlement configuration for this merchant payment account.

settlementsCreationDisabled

boolean | null

Defaults to false

Specifies if creation of settlements is disabled for a merchant payment account. When set to true, account statement files
of this account are loaded from PSP/bank but settlements are not created in NBX.

settlementsProcessingSchedule

CreateSettlementsProcessingScheduleDto | null

Schedule for loading settlement statements from PSP.

Responses

201The request has been fulfilled, resulting in the creation of a new resource.

4XXClient error

5XXServer error