Create settlement report

post

https://api.instellix.io/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}/settlement-reports

Create a new settlement report that is a Nitrobox model for various ways of providing the statement of payment settlements by Payment Service Providers or banks. In these different sources it may be called Settlement Report, Settlement Batch, Account Statement, etc.

Path Params

merchantPaymentAccountIdent

string

required

Merchant payment account ident.

Body Params

Create settlement report request body.

fileName

string

required

length between 1 and 255

^\S(.*\S)?$

Unique filename of the settlement statement provided by a Payment Service Provider or a bank.
Must not be null.
Size must be between 1 and 255.
Must match with the regular expression '^\S(.*\S)?$'.

ident

string

required

length between 1 and 255

^\S(.*\S)?$

Identifier that is unique on payment account level. Can be identical to statementReference or fileName.
Must not be null.
Size must be between 1 and 255.
Must match with the regular expression '^\S(.*\S)?$'.

statementCreationDate

date-time

required

A date when the settlement statement was created by a Payment Service Provider or a bank.
Must not be null.

statementReference

string

required

length between 1 and 255

^\S(.*\S)?$

Unique business pointer to the settlement statement provided by a Payment Service Provider or a bank. In case of some PSPs may be identical to the filename.
Must not be null.
Size must be between 1 and 255.
Must match with the regular expression '^\S(.*\S)?$'.

Responses

200Standard response for successful HTTP requests.

4XXerror response for all http error codes in range 4XX

5XXerror response for all http error codes in range 5XX