Models & Types

Every request and response model, enumeration and error type used by the myPOS Banking API. Any property whose type is itself a model links to that model’s section on this page, and the endpoint pages link back here.

Name	Kind	Description
Account Statement Request	Model	Request to generate an account statement file for one account and date.
Account Response	Model	Summary information for a merchant account.
Account Details Response	Model	Detailed information about a single merchant account.
Paginated List of Accounts	Model	Paginated list of accounts.
Paginated List of Transactions	Model	Paginated list of transactions.
General Details	Model	General flags and type information about a transaction.
Transaction Details	Model	A single key-value detail entry for a transaction. The full set of entries varies by transaction type.
Multiple Transactions Response	Model	Detailed information for a single transaction, returned as part of a multiple-transaction lookup.
Transaction Details Response	Model	Full structured details for a single transaction.
Transaction List Response	Model	Summary information for a single transaction in a paginated list.
Account Statement Document Type	Enum	Output format for generated account statement files.
Account Status	Enum	Current lifecycle status of an account.
Reference Number Type	Enum	Indicates what kind of merchant reference was associated with the transaction.
Transaction Order	Enum	Sort direction for transaction list results.
Transaction Sign	Enum	Indicates the direction of a transaction relative to the merchant account.
Problem Details	Error	The standard error payload (RFC 7807) returned when a request fails.
Validation Problem Details	Error	The error payload returned when a request fails validation, adding a per-field errors map.

Models

Account Statement Request

Request to generate an account statement file for one account and date.

Attribute	Type	Description
`account_number`	`string`	The account number for which to generate the statement.
`document_type`	Account Statement Document Type	Output format for generated account statement files. - `MT940MultiCash` — MT940 format compatible with MultiCash banking software. - `MT940SWIFT` — Standard MT940 SWIFT message format. - `MT940Structured` — MT940 structured format with additional structured data fields. - `MT940StructuredWithIban` — MT940 structured format with the IBAN included in the output.
`date`	`string (date-time)`	The date for which to generate the statement. Only the date portion is used (`yyyy-MM-dd`); the time component is ignored.

Account Response

Summary information for a merchant account.

Attribute	Type	Description
`account_number`	`string`	The account number used for transactions and statements. Example: `50085063456`
`iban`	`string`	IBAN for the account. For some account types this equals `account_number`. Example: `50085063456`
`currency`	`string`	ISO 4217 currency code for the account (e.g., `EUR`, `GBP`). Example: `EUR`
`name`	`string`	Display name of the account as configured by the merchant. Example: `EUR Account`
`is_reserve`	`boolean`	`true` if this is a reserve account — funds held by the platform as a security deposit and not available for immediate withdrawal.
`is_suspense_account`	`boolean`	`true` if this is a suspense account used for temporary holds or pending settlements.

Account Details Response

Detailed information about a single merchant account.

Attribute	Type	Description
`status`	Account Status	Current lifecycle status of an account. - `active` — Account is open and fully operational. - `test` — Account is in test/sandbox mode. - `selfOut` — Account has been self-closed by the holder. - `executed` — Account has been fully executed and settled. - `restructured` — Account has undergone restructuring. - `transferredInArgus` — Account was transferred to the Argus risk management system. - `closedByHolder` — Account was closed at the account holder's request. - `closedByIssuer` — Account was closed by the issuing institution. - `deleted` — Account has been deleted. - `reserved` — Account is reserved but not yet active. - `unknown` — Account status could not be determined.
`date_created`	`string (date-time)`	Date and time the account was created.
`wallet_id`	`integer (int64)`	Internal platform wallet identifier linked to this account.
`account_number`	`string`	The account number.
`account_name`	`string`	Display name of the account.
`modulr_id`	`string`	Account identifier in the Modulr payment platform.
`modulr_currency`	`string`	ISO 4217 currency code of the linked Modulr account.
`balance`	`number (double)`	Current available balance in `currency`.
`balance_sc`	`number (double)`	Current balance expressed in the settlement currency.
`currency`	`string`	ISO 4217 currency code for this account (e.g., `EUR`).

Paginated List of Accounts

Paginated list of accounts.

Attribute	Type	Description
`items`	array of Account Response	The accounts on the current page.
`page`	`integer`	Current page number. Example: `1`
`page_size`	`integer`	Number of items per page. Example: `20`
`total_pages`	`integer`	Total number of pages. Example: `1`
`total_count`	`integer`	Total number of accounts across all pages. Example: `2`
`has_previous_page`	`boolean`	`true` if there is a page before the current one.
`has_next_page`	`boolean`	`true` if there is a page after the current one.

Paginated List of Transactions

Paginated list of transactions.

Attribute	Type	Description
`items`	array of Transaction List Response	The transactions on the current page.
`page`	`integer`	Current page number.
`page_size`	`integer`	Number of items per page.
`total_pages`	`integer`	Total number of pages.
`total_count`	`integer`	Total number of transactions across all pages.
`has_previous_page`	`boolean`	`true` if there is a page before the current one.
`has_next_page`	`boolean`	`true` if there is a page after the current one.

General Details

General flags and type information about a transaction.

Attribute	Type	Description
`can_request_reversal`	`boolean`	`true` if a reversal can still be requested for this transaction.
`is_fee`	`boolean`	`true` if this transaction is a platform fee charge rather than a card payment.
`is_reversal`	`boolean`	`true` if this transaction is itself a reversal of an earlier transaction.
`transaction_type`	`string`	Transaction type code that categorises the transaction (e.g., `013` for a card payment, `501` for a fee). Example: `501`

Transaction Details

A single key-value detail entry for a transaction. The full set of entries varies by transaction type.

Attribute	Type	Description
`value`	`string`	The detail value. Example: `2722`
`label`	`string`	Human-readable label describing what this detail represents. Example: `Payment from card`

Multiple Transactions Response

Detailed information for a single transaction, returned as part of a multiple-transaction lookup.

Attribute	Type	Description
`payment_reference`	`string`	The payment reference this entry corresponds to.
`general`	General Details	General flags and type information about a transaction.
`details`	array of Transaction Details	Variable list of key-value detail entries for the transaction. Content varies by `transaction_type`.

Transaction Details Response

Full structured details for a single transaction.

Attribute	Type	Description
`general`	General Details	General flags and type information about a transaction.
`details`	array of Transaction Details	Variable list of key-value detail entries for the transaction. Content varies by `transaction_type`.

Transaction List Response

Summary information for a single transaction in a paginated list.

Attribute	Type	Description
`id`	`integer (int64)`	Unique internal transaction ID. Can be used as `start_trn_id` in subsequent requests for cursor-based iteration. Example: `10474587`
`date`	`string (date-time)`	Date and time the transaction occurred. Example: `2025-10-20T10:52:36`
`payment_reference`	`string`	Unique platform-assigned payment reference. Use this value to retrieve full transaction details via the single or multiple detail endpoints. Example: `POSA01525856ITL4`
`transaction_type`	`string`	Transaction type code that categorises the transaction (e.g., `013` for a card payment, `501` for a fee). Example: `013`
`transaction_currency`	`string`	ISO 4217 currency code for the settled transaction amount. Example: `EUR`
`transaction_amount`	`number (double)`	Amount settled in `transaction_currency`. Example: `0.88`
`original_currency`	`string`	ISO 4217 currency code of the original card transaction before Dynamic Currency Conversion (DCC). Equals `transaction_currency` when no conversion occurred. Example: `EUR`
`original_amount`	`number (double)`	Amount in `original_currency` before any DCC conversion. Example: `0.22`
`sign`	Transaction Sign	Indicates the direction of a transaction relative to the merchant account. - `Credit` — Incoming transaction; funds were received into the account (e.g., a card payment). - `Debit` — Outgoing transaction; funds were sent out of the account (e.g., a fee or refund).
`reference_number`	`string`	Merchant-assigned reference number submitted with the original payment (e.g., an invoice or order ID). See `reference_number_type` for the reference category. Example: `REF1234567890`
`reference_number_type`	Reference Number Type	Indicates what kind of merchant reference was associated with the transaction. - `None` — No reference number was provided. - `ReferenceNumber` — A generic merchant reference number. - `InvoiceNumber` — An invoice number. - `ProductID` — A product identifier. - `ReservationNumber` — A reservation or booking number.
`terminal_id`	`string`	Identifier of the POS terminal that processed the transaction. Example: `80026232`
`serial_number`	`string`	Serial number of the POS device. Example: `N96N960WC15224`
`account_number`	`string`	Account number to which this transaction was settled. Example: `50480563548`
`ruid`	`string`	Merchant-assigned Reference Unique ID from the original payment request — typically an order identifier. Can be used to filter the transaction list via the `ruid` query parameter. Example: `ORDER-00123`
`billing_descriptor`	`string`	Merchant billing descriptor — the name that appears on the cardholder's bank statement. Example: `DEMO K300`
`pan`	`string`	Last 4 digits of the card used for the transaction, masked with an asterisk (e.g., `9766`). Example: `9766`
`description`	`string`	Human-readable description of the transaction. Example: `DEMO K300 - 000057 / Payment on TID 80025996, 0.88 EUR`

Enumerations

Account Statement Document Type

Output format for generated account statement files.

Value	Description
`MT940MultiCash`	MT940 format compatible with MultiCash banking software.
`MT940SWIFT`	Standard MT940 SWIFT message format.
`MT940Structured`	MT940 structured format with additional structured data fields.
`MT940StructuredWithIban`	MT940 structured format with the IBAN included in the output.

Account Status

Current lifecycle status of an account.

Value	Description
`active`	Account is open and fully operational.
`test`	Account is in test/sandbox mode.
`selfOut`	Account has been self-closed by the holder.
`executed`	Account has been fully executed and settled.
`restructured`	Account has undergone restructuring.
`transferredInArgus`	Account was transferred to the Argus risk management system.
`closedByHolder`	Account was closed at the account holder's request.
`closedByIssuer`	Account was closed by the issuing institution.
`deleted`	Account has been deleted.
`reserved`	Account is reserved but not yet active.
`unknown`	Account status could not be determined.

Reference Number Type

Indicates what kind of merchant reference was associated with the transaction.

Value	Description
`None`	No reference number was provided.
`ReferenceNumber`	A generic merchant reference number.
`InvoiceNumber`	An invoice number.
`ProductID`	A product identifier.
`ReservationNumber`	A reservation or booking number.

Transaction Order

Sort direction for transaction list results.

Value	Description
`Ascending`	Return results oldest-first (earliest date first).
`Descending`	Return results newest-first (latest date first).

Transaction Sign

Indicates the direction of a transaction relative to the merchant account.

Value	Description
`Credit`	Incoming transaction; funds were received into the account (e.g., a card payment).
`Debit`	Outgoing transaction; funds were sent out of the account (e.g., a fee or refund).

Error responses

Failed requests return a Problem Details object (RFC 7807). Validation failures (400 Bad Request) return Validation Problem Details, which adds a per-field errors map.

Problem Details

The standard error payload (RFC 7807) returned when a request fails.

Attribute	Type	Description
`type`	`string`	—
`title`	`string`	—
`status`	`integer`	—
`detail`	`string`	—
`instance`	`string`	—
`additionalProp1`	`string`	—
`additionalProp2`	`string`	—
`additionalProp3`	`string`	—

Validation Problem Details

The error payload returned when a request fails validation, adding a per-field errors map.

Has the same shape as Problem Details.

Attribute	Type	Description
`type`	`string`	—
`title`	`string`	—
`status`	`integer`	—
`detail`	`string`	—
`instance`	`string`	—
`additionalProp1`	`string`	—
`additionalProp2`	`string`	—
`additionalProp3`	`string`	—