Models & Types

Every request and response model, enumeration and error type used by the myPOS eCommerce 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
Button Transactions Request	Model	Filter for looking up payment button transactions by button code and date range.
Create Button Request	Model	Request to create a payment button that can be embedded on a website.
Update Button Details Request	Model	Changes to apply to an existing payment button. Omitted fields keep their current value.
Button Link Details Response	Model	The full configuration and current state of a single payment button.
Button Links Response	Model	A payment button as it appears in a list, reduced to its identifying fields.
Button Transactions Response	Model	A transaction taken through a payment button, with its settlement, fee and customer details.
Create Button Response	Model	The URL of the newly created payment button.
Languages Response	Model	A paginated list of the languages a payment page can be displayed in.
Settlement Data Response	Model	A paginated list of the merchant's settlement accounts.
Create Link Request	Model	Request to create a payment link that can be sent to a customer.
Edit Payment Link Request	Model	Changes to apply to an existing payment link. Omitted fields keep their current value.
Create Link Response	Model	The URL of the newly created payment link.
Payment Link List Response	Model	A payment link as it appears in a list, reduced to its identifying fields.
Payment Link Response	Model	The full configuration and current state of a single payment link.
Payment Link Transaction Details	Model	A transaction taken through a payment link, with its settlement, fee and customer details.
Create Payment Request	Model	Request to create a payment request to send to a named customer.
Create Payment Request Response	Model	The code and URL of the newly created payment request.
Payment Request Details	Model	The full details and current status of a single payment request.
Payment Request List Item	Model	A payment request as it appears in a list, reduced to its identifying fields.
Paginated List of Payment Buttons	Model	A paginated page of payment buttons.
Paginated List of Button Transactions	Model	A paginated page of payment button transactions.
Paginated List of Payment Links	Model	A paginated page of payment links.
Paginated List of Payment Link Transactions	Model	A paginated page of payment link transactions.
Paginated List of Payment Requests	Model	A paginated page of payment requests.
Payment Button Size	Enum	Visual size of the payment button widget when embedded on a webpage.
Payment Button Status	Enum	Status of a payment button.
Payment Link Status	Enum	Status of a payment link.
Payment Request Status	Enum	Current lifecycle status of a payment request.
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

Button Transactions Request

Filter for looking up payment button transactions by button code and date range.

Attribute	Type	Description
`code`	`string`	Filter results to transactions for a specific button code. Returns all buttons' transactions if omitted.
`date_from`	`string (date-time)`	Return only transactions on or after this date/time (ISO 8601).
`date_to`	`string (date-time)`	Return only transactions on or before this date/time (ISO 8601).

Create Button Request

Request to create a payment button that can be embedded on a website.

Attribute	Type	Description
`button_size`	Payment Button Size	Visual size of the payment button widget when embedded on a webpage.
`cancel_url`	`string`	URL the customer is redirected to if they cancel the payment.
`return_url`	`string`	URL the customer is redirected to after successful payment.
`item_name`	`string`	Name of the product or service displayed on the payment page. Example: `Creating a button`
`item_price`	`number (double)`	Unit price of the item in `currency`. Example: `0.1`
`pref_language`	`string`	Preferred language for the payment page (ISO 639-1 code, e.g., `en`, `bg`). Example: `en`
`currency`	`string`	ISO 4217 currency code (e.g., `EUR`). Example: `EUR`
`account_number`	`string`	Merchant account number that will receive the settlement for this button. Example: `50480563548`
`custom_name`	`string`	Merchant-assigned internal name for identifying this button. Not shown to customers. Example: `Test Button`
`quantity`	`integer (int32)`	Number of units. The total charge is `item_price × quantity`. Example: `1`
`website`	`string`	URL of the merchant's website, displayed on the payment page. Example: `https://mywebsite.com/`
`ask_for_customer_name`	`boolean`	When `true`, the payment page prompts the customer to enter their name. Defaults to `false`.
`ask_for_shipping_address`	`boolean`	When `true`, the payment page prompts the customer for a shipping address. Defaults to `false`.
`ask_for_customer_email`	`boolean`	When `true`, the payment page prompts the customer for their email address. Defaults to `false`.
`ask_for_customer_phone_number`	`boolean`	When `true`, the payment page prompts the customer for their phone number. Defaults to `false`.
`ask_for_customer_id`	`boolean`	When `true`, the payment page prompts the customer for a customer ID. Defaults to `false`.
`send_sms`	`boolean`	When `true`, an SMS payment confirmation is sent to the customer. Defaults to `false`.
`send_email`	`boolean`	When `true`, an email payment confirmation is sent to the customer. Defaults to `false`.

Update Button Details Request

Changes to apply to an existing payment button. Omitted fields keep their current value.

Attribute	Type	Description
`website`	`string`	URL of the merchant's website, displayed on the payment page. Omit to keep the current value. Example: `https://mywebsite.com/`
`cancel_url`	`string`	URL the customer is redirected to if they cancel the payment. Omit to keep the current value. Example: `https://mywebsite.com/cancel`
`return_url`	`string`	URL the customer is redirected to after a successful payment. Omit to keep the current value. Example: `https://mywebsite.com/thank-you`
`button_size`	Payment Button Size	Visual size of the payment button widget when embedded on a webpage. Omit to keep the current value.
`pref_lang`	`string`	Preferred language for the payment page (ISO 639-1 code, e.g., `en`, `bg`). Omit to keep the current value. Example: `en`
`custom_name`	`string`	Merchant-assigned internal name for the button. Not shown to customers. Omit to keep the current value.
`send_sms`	`boolean`	When `true`, an SMS payment confirmation is sent to the customer. Omit to keep the current value.
`send_email`	`boolean`	When `true`, an email payment confirmation is sent to the customer. Omit to keep the current value.
`ask_for_customer_name`	`boolean`	When `true`, the payment page prompts the customer to enter their name. Omit to keep the current value.
`ask_for_shipping_address`	`boolean`	When `true`, the payment page prompts the customer for a shipping address. Omit to keep the current value.
`ask_for_customer_email`	`boolean`	When `true`, the payment page prompts the customer for their email address. Omit to keep the current value.
`ask_for_customer_phone_number`	`boolean`	When `true`, the payment page prompts the customer for their phone number. Omit to keep the current value.
`ask_for_customer_id`	`boolean`	When `true`, the payment page prompts the customer for a customer ID. Omit to keep the current value.
`enable`	`boolean`	When `true`, the button is active and accepts payments. Set to `false` to disable the button. Omit to keep the current value.

Button Link Details Response

The full configuration and current state of a single payment button.

Attribute	Type	Description
`created_on`	`string`	Date and time the button was created. Example: `2025-10-30T14:19:13`
`code`	`string`	Unique identifier for this payment button. Example: `B6T9KPKY3BQ98`
`url`	`string`	Public URL of the payment button. Example: `https://demo.mypos.eu/vmp/btn/BE2J9AR8AMB52`
`custom_name`	`string`	Merchant-assigned internal name. Example: `Test Button`
`item_name`	`string`	Name of the product or service displayed on the payment page. Example: `Creating a button`
`enable`	`boolean`	`true` if the button is currently active and can accept payments.
`item_price`	`number (double)`	Unit price of the item. Example: `0.1`
`total_amount`	`number (double)`	Total charge amount (item_price × quantity). Example: `0.2`
`quantity`	`integer`	Number of units. Example: `2`
`button_size`	`integer`	Visual size of the button (0 = Small, 1 = Big). Example: `0`
`button_type`	`integer`	Type code for the button (0 = None, 1 = Button, 2 = Link, 3 = Paytag). Example: `1`
`send_sms`	`boolean`	Whether SMS confirmation is sent to the customer after payment.
`send_email`	`boolean`	Whether email confirmation is sent to the customer after payment.
`hide_quantity`	`boolean`	When `true`, the quantity field is hidden from the customer on the payment page.
`ask_for_customer_name`	`boolean`	Whether the payment page prompts the customer to enter their name.
`ask_for_shipping_address`	`boolean`	Whether the payment page prompts the customer for a shipping address.
`ask_for_customer_email`	`boolean`	Whether the payment page prompts the customer for their email address.
`ask_for_customer_phone_number`	`boolean`	Whether the payment page prompts the customer for their phone number.
`ask_for_customer_id`	`boolean`	Whether the payment page prompts the customer for a customer ID.
`currency`	`string`	ISO 4217 currency code (e.g., `EUR`). Example: `EUR`
`pref_language`	`string`	ISO 639-1 language code for the payment page (e.g., `en`, `bg`). Example: `en`
`website`	`string`	Merchant website URL displayed on the payment page. Example: `https://mywebsite.com/`
`cancel_url`	`string`	URL the customer is redirected to if they cancel the payment. Example: `https://mywebsite.com/cancel`
`return_url`	`string`	URL the customer is redirected to after successful payment. Example: `https://mywebsite.com/thank-you`
`expire_date`	`string`	Date after which the button can no longer accept payments. Null if no expiry is set. Example: `2025-11-30T14:19:13`
`account_number`	`string`	Merchant account number that receives settlement for this button. Example: `50480563548`

Button Links Response

A payment button as it appears in a list, reduced to its identifying fields.

Attribute	Type	Description
`code`	`string`	Unique identifier of the payment button. Used in all other button endpoints. Example: `B6T9KPKY3BQ98`
`url`	`string`	Public URL where the payment button can be accessed by customers. Example: `https://demo.mypos.eu/vmp/btn/B6T9KPKY3BQ9`
`custom_name`	`string`	Merchant-assigned display name for this button. Example: `Test Button`
`amount`	`number (double)`	Total charge amount (item price × quantity). Example: `0.2`
`currency`	`string`	ISO 4217 currency code (e.g., `EUR`). Example: `EUR`
`status`	Payment Button Status	Status of a payment button. - `None` — No status; used when filtering is not applied. - `Active` — Button is live and can receive payments. - `Disabled` — Button has been manually disabled and cannot accept payments. - `Expired` — Button has passed its expiry date and can no longer receive payments. - `Forbidden` — Button has been blocked by the platform. Example: `Active`

Button Transactions Response

A transaction taken through a payment button, with its settlement, fee and customer details.

Attribute	Type	Description
`date`	`string`	Date and time the transaction occurred. Example: `2025-05-16T17:37:17`
`code`	`string`	Code of the payment button that received the payment. Example: `BDYZC4KBNFG98`
`custom_name`	`string`	Merchant-assigned name of the button at time of transaction. Example: `test`
`amount`	`number (double)`	Transaction amount in `currency`. Example: `1`
`currency`	`string`	ISO 4217 currency code of the original transaction. Example: `EUR`
`settlement_date`	`string`	Date and time the transaction was settled to the merchant's account. Example: `2025-05-16T17:37:17`
`settlement_amount`	`string`	Net amount received after fees and currency conversion. Example: `1`
`settlement_currency`	`string`	ISO 4217 currency code of the settled amount. Example: `EUR`
`fee`	`number (double)`	Platform fee charged for this transaction. Example: `0.14`
`customer_name`	`string`	Customer name collected during checkout. Null if not collected. Example: `TEST`
`customer_address`	`string`	Customer shipping address collected during checkout. Null if not collected. Example: `test address`
`customer_email`	`string`	Customer email address collected during checkout. Null if not collected. Example: `test@mypos.com`
`customer_phone`	`string`	Customer phone number collected during checkout. Null if not collected. Example: `359888888888`
`payment_reference`	`string`	Unique platform-assigned reference for this transaction. Example: `MTCOR15253S5OFPX`

Create Button Response

The URL of the newly created payment button.

Attribute	Type	Description
`url`	`string`	URL of the newly created payment button page. Example: `https://demo.mypos.eu/vmp/btn/B8MQEGCFBG638`

Languages Response

A paginated list of the languages a payment page can be displayed in.

Attribute	Type	Description
`items`	`array of object`	List of supported languages for the current page.
`page`	`integer`	Current page number (1-based). Example: `1`
`page_size`	`integer`	Number of items returned per page. Example: `20`
`total_pages`	`integer`	Total number of pages available. Example: `1`
`total_count`	`integer`	Total number of items across all pages. Example: `12`
`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.

Languages Response › items (each item)

Attribute	Type	Description
`code`	`string`	ISO 639-1 language code (e.g., `EN`, `BG`). Example: `EN`
`description`	`string`	Human-readable name of the language (e.g., `English`). Example: `English`

Settlement Data Response

A paginated list of the merchant's settlement accounts.

Attribute	Type	Description
`items`	`array of object`	List of settlement accounts for the current page.
`page`	`integer`	Current page number (1-based). Example: `1`
`page_size`	`integer`	Number of items per page. Example: `20`
`total_pages`	`integer`	Total number of pages available. Example: `1`
`total_count`	`integer`	Total number of items across all pages. Example: `5`
`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.

Settlement Data Response › items (each item)

Attribute	Type	Description
`settlement_currency`	`string`	ISO 4217 currency code of the settlement (e.g., `EUR`). Example: `EUR`
`account`	`object`	Merchant account that will receive settlement funds in `settlement_currency`.

Create Link Request

Request to create a payment link that can be sent to a customer.

Attribute	Type	Description
`hide_quantity`	`boolean`	When `true`, the quantity field is hidden on the payment page. Defaults to `false`.
`expired_date`	`string`	Optional expiry date/time after which the link can no longer be used (ISO 8601 format). Omit for a non-expiring link. Example: `2025-05-16T17:37:17`
`item_name`	`string`	Name of the product or service displayed on the payment page. Example: `Test Payment Link`
`item_price`	`number (double)`	Unit price of the item in `currency`. The total charge is `item_price × quantity`. Example: `1`
`pref_language`	`string`	Preferred language for the payment page (ISO 639-1 code, e.g., `en`, `bg`). Example: `en`
`currency`	`string`	ISO 4217 currency code (e.g., `EUR`). Example: `EUR`
`account_number`	`string`	Merchant account number that will receive settlement for this payment link. Example: `50480563548`
`custom_name`	`string`	Merchant-assigned internal name for this link. Not shown to customers. Example: `Summer Sale Link`
`quantity`	`integer (int32)`	Number of units. The total charge is `item_price × quantity`. Example: `1`
`website`	`string`	URL of the merchant's website, displayed on the payment page. Example: `https://mywebsite.com/`
`ask_for_customer_name`	`boolean`	When `true`, the payment page prompts the customer to enter their name. Defaults to `false`.
`ask_for_shipping_address`	`boolean`	When `true`, the payment page prompts the customer for a shipping address. Defaults to `false`.
`ask_for_customer_email`	`boolean`	When `true`, the payment page prompts the customer for their email address. Defaults to `false`.
`ask_for_customer_phone_number`	`boolean`	When `true`, the payment page prompts the customer for their phone number. Defaults to `false`.
`ask_for_customer_id`	`boolean`	When `true`, the payment page prompts the customer for a customer ID. Defaults to `false`.
`send_sms`	`boolean`	When `true`, an SMS payment confirmation is sent to the customer. Defaults to `false`.
`send_email`	`boolean`	When `true`, an email payment confirmation is sent to the customer. Defaults to `false`.

Edit Payment Link Request

Changes to apply to an existing payment link. Omitted fields keep their current value.

Attribute	Type	Description
`pref_lang`	`string`	Preferred language for the payment page (ISO 639-1 code, e.g., `en`, `bg`). Omit to keep the current value. Example: `en`
`custom_name`	`string`	Merchant-assigned internal name for this link. Not shown to customers. Omit to keep the current value. Example: `Set Custom Name`
`send_sms`	`boolean`	When `true`, an SMS confirmation is sent to the customer after payment. Omit to keep the current value.
`sens_email`	`boolean`	⚠️ Field name typo in source — should be `send_email`. When `true`, an email confirmation is sent to the customer after payment. Omit to keep the current value.
`ask_for_customer_name`	`boolean`	When `true`, the payment page prompts the customer to enter their name. Omit to keep the current value.
`ask_for_shipping_address`	`boolean`	When `true`, the payment page prompts the customer for a shipping address. Omit to keep the current value.
`ask_for_customer_email`	`boolean`	When `true`, the payment page prompts the customer for their email address. Omit to keep the current value.
`ask_for_customer_phone_number`	`boolean`	When `true`, the payment page prompts the customer for their phone number. Omit to keep the current value.
`ask_for_customer_id`	`boolean`	When `true`, the payment page prompts the customer for a customer ID. Omit to keep the current value.
`enable`	`boolean`	When `true`, the link is active and accepts payments. Set to `false` to disable the link. Omit to keep the current value.
`hide_quantity`	`boolean`	When `true`, the quantity field is hidden on the payment page. Omit to keep the current value.
`website`	`string`	URL of the merchant's website, displayed on the payment page. Omit to keep the current value. Example: `https://mywebsite.com/`
`expired_date`	`string`	Expiry date/time after which the link can no longer be used (ISO 8601). Omit to keep the current value. Example: `2025-11-19T12:00:00`

Create Link Response

The URL of the newly created payment link.

Attribute	Type	Description
`url`	`string`	URL of the newly created payment link page. Example: `https://demo.mypos.eu/vmp/btn/BGOBAFZ65QS08`

Payment Link List Response

A payment link as it appears in a list, reduced to its identifying fields.

Attribute	Type	Description
`code`	`string`	Unique identifier for the payment link. Example: `BGOBAFZ65QS08`
`url`	`string`	URL of the payment page customers visit to complete the payment. Example: `https://demo.mypos.eu/vmp/btn/BGOBAFZ65QS08`
`custom_name`	`string`	Merchant-assigned internal name for this link. Example: `Create a Payment Link`
`amount`	`number (double)`	Total charge amount for this link. Example: `0.2`
`currency`	`string`	ISO 4217 currency code (e.g., `EUR`). Example: `EUR`
`status`	Payment Link Status	Current status of the payment link. Example: `Active`

Payment Link Response

The full configuration and current state of a single payment link.

Attribute	Type	Description
`created_on`	`string`	ISO 8601 timestamp when the payment link was created. Example: `2025-10-20T14:31:50`
`code`	`string`	Unique identifier for the payment link. Example: `BLQ2IYI5LQV79`
`url`	`string`	URL of the payment page customers visit to complete the payment. Example: `https://demo.mypos.eu/vmp/btn/BLQ2IYI5LQV79`
`custom_name`	`string`	Merchant-assigned internal name for this link. Example: `Set Custom Name`
`item_name`	`string`	Name of the product or service displayed on the payment page. Example: `Summer Offer`
`enable`	`boolean`	`true` if the link is active and can accept payments; `false` if it has been disabled.
`item_price`	`number (double)`	Unit price of the item. Example: `0.2`
`total_amount`	`number (double)`	Total charge amount (item_price × quantity). Example: `0.4`
`quantity`	`integer`	Number of units. Example: `2`
`button_size`	`integer`	Visual size of the button widget (0 = Small, 1 = Big). Example: `0`
`button_type`	`integer`	Object type code. `2` indicates a payment link (as opposed to a button or paytag). Example: `2`
`send_sms`	`boolean`	`true` if an SMS confirmation is sent to the customer after payment.
`send_email`	`boolean`	`true` if an email confirmation is sent to the customer after payment.
`hide_quantity`	`boolean`	`true` if the quantity field is hidden on the payment page.
`ask_for_customer_name`	`boolean`	`true` if the payment page prompts the customer to enter their name.
`ask_for_shipping_address`	`boolean`	`true` if the payment page prompts the customer for a shipping address.
`ask_for_customer_email`	`boolean`	`true` if the payment page prompts the customer for their email address.
`ask_for_customer_phone_number`	`boolean`	`true` if the payment page prompts the customer for their phone number.
`ask_for_customer_id`	`boolean`	`true` if the payment page prompts the customer for a customer ID.
`currency`	`string`	ISO 4217 currency code (e.g., `EUR`). Example: `EUR`
`pref_language`	`string`	Preferred language code for the payment page (ISO 639-1, e.g., `en`). Example: `en`
`website`	`string`	URL of the merchant's website, displayed on the payment page. Example: `https://mywebsite.com/`
`cancel_url`	`string`	URL the customer is redirected to if they cancel the payment. Example: `https://mywebsite.com/cancel`
`return_url`	`string`	URL the customer is redirected to after a successful payment. Example: `https://mywebsite.com/thank-you`
`expire_date`	`string`	ISO 8601 expiry date/time after which the link can no longer be used. `null` if the link has no expiry. Example: `2025-11-19T12:00:00`
`account_number`	`string`	Merchant account number receiving settlement for this link. Example: `50480563548`

Payment Link Transaction Details

A transaction taken through a payment link, with its settlement, fee and customer details.

Attribute	Type	Description
`date`	`string`	ISO 8601 timestamp when the payment transaction was made. Example: `2025-05-29T14:21:10`
`code`	`string`	Payment link code associated with this transaction. Example: `BIE589ACVLD43`
`custom_name`	`string`	Merchant-assigned internal name of the payment link at the time of payment. Example: `DEMO`
`amount`	`number (double)`	Transaction amount in `currency`. Example: `1`
`currency`	`string`	ISO 4217 currency code of the transaction. Example: `EUR`
`settlement_date`	`string`	ISO 8601 timestamp when the funds were settled to the merchant's account. `null` if settlement is pending. Example: `2025-05-29T14:21:11`
`settlement_amount`	`string`	Amount settled to the merchant account (may differ from `amount` after fees are applied). `null` if settlement is pending. Example: `1`
`settlement_currency`	`string`	ISO 4217 currency code of the settled amount. May differ from `currency` if the merchant account uses a different currency. Example: `EUR`
`fee`	`number (double)`	Platform fee charged for this transaction. Example: `0.29`
`customer_name`	`string`	Name provided by the customer during checkout. `null` if not collected. Example: `Jane Doe`
`customer_address`	`string`	Shipping address provided by the customer during checkout. `null` if not collected. Example: `1 Example Street, Dublin`
`customer_email`	`string`	Email address provided by the customer during checkout. `null` if not collected. Example: `jane.doe@example.com`
`customer_phone`	`string`	Phone number provided by the customer during checkout. `null` if not collected. Example: `+35312345678`
`payment_reference`	`string`	Unique platform-assigned payment reference for this transaction. Example: `MTCOS0224461F39K`

Create Payment Request

Request to create a payment request to send to a named customer.

Attribute	Type	Description
`amount`	`number (double)`	Requested payment amount in `currency`. Example: `28.78`
`currency`	`string`	ISO 4217 currency code (e.g., `EUR`). Example: `EUR`
`client_name`	`string`	Name of the client to whom the payment request is being sent. Example: `John Smith`
`reason`	`string`	Reason for the payment request, shown to the customer on the payment page. Example: `Invoice #1042`
`booking_text`	`string`	Additional booking or memo text attached to the payment request. Example: `Order ref: ORD-2025-001`
`dba`	`string`	Doing-Business-As name displayed to the customer on the payment page. Example: `My Company Ltd`
`expiry_date`	`string`	Date after which the payment request expires and can no longer be paid. Format: `yyyy-MM-dd`. Example: `2025-08-18`
`payment_request_lang`	`string`	Language for the payment request page (ISO 639-1 code, e.g., `en`, `bg`). Example: `en`
`notify_gsm`	`string`	Phone number to notify by SMS when the payment request is viewed or paid (E.164 format, e.g., `+359885885885`). Example: `+359885885885`
`qr_generated`	`boolean`	When `true`, a QR code is generated for the payment request. Defaults to `true`.

Create Payment Request Response

The code and URL of the newly created payment request.

Attribute	Type	Description
`code`	`string`	Unique identifier for the created payment request. Example: `B9UU2SESPY5Y42`
`payment_request_url`	`string`	URL of the payment page the customer visits to complete the payment. Example: `https://demo.mypos.eu/bg/qr-pr/B9UU2SESPY5Y42`

Payment Request Details

The full details and current status of a single payment request.

Attribute	Type	Description
`code`	`string`	Unique identifier for the payment request. Example: `B9UU2SESPY5Y42`
`url`	`string`	URL of the payment page the customer visits to complete the payment. Example: `https://demo.mypos.eu/bg/qr-pr/B9UU2SESPY5Y42`
`added_on`	`string`	ISO 8601 timestamp when the payment request was created. Example: `2025-10-31T09:00:00`
`client_name`	`string`	Name of the client to whom the payment request was sent. Example: `Test Client`
`amount`	`number (double)`	Requested payment amount in `currency`. Example: `28.78`
`currency`	`string`	ISO 4217 currency code (e.g., `EUR`). Example: `EUR`
`reason`	`string`	Reason for the payment request, as shown to the customer. Example: `Test Reason`
`booking_text`	`string`	Additional booking or memo text attached to the request. Example: `Test booking text`
`attempts`	`integer (int32)`	Number of times the customer has opened the payment page. Example: `0`
`expiry_on`	`string`	ISO 8601 timestamp after which the payment request expires. `null` if no expiry was set. Example: `2025-11-30T23:59:59`
`qr_generated`	`boolean`	`true` if a QR code was generated for this payment request.
`email`	`string`	Email address associated with the payment request. `null` if not provided. Example: `test@mypos.com`
`gsm`	`string`	Phone number associated with the payment request. `null` if not provided. Example: `+359888888888`
`status`	Payment Request Status	Current status of the payment request. Example: `Pending`

Payment Request List Item

A payment request as it appears in a list, reduced to its identifying fields.

Attribute	Type	Description
`code`	`string`	Unique identifier for the payment request. Example: `BF4FWKWIQXPV30`
`url`	`string`	URL of the payment page the customer visits to complete the payment. Example: `https://demo.mypos.eu/bg/qr-pr/BF4FWKWIQXPV30`
`added_on`	`string`	ISO 8601 timestamp when the payment request was created. Example: `2025-10-31T09:03:03`
`client_name`	`string`	Name of the client to whom the payment request was sent. Example: `Test Client Name`
`amount`	`number (double)`	Requested payment amount in `currency`. Example: `28.78`
`currency`	`string`	ISO 4217 currency code (e.g., `EUR`). Example: `EUR`
`reason`	`string`	Reason for the payment request, as shown to the customer. Example: `Test Reason`
`booking_text`	`string`	Additional booking or memo text attached to the request. Example: `Test booking text`
`status`	Payment Request Status	Current status of the payment request. Example: `Pending`

Paginated List of Payment Buttons

A paginated page of payment buttons.

Attribute	Type	Description
`items`	array of Button Links Response	Paginated list of payment buttons.
`page`	`integer (int32)`	Current page number (1-based). Example: `1`
`page_size`	`integer (int32)`	Number of items per page. Example: `20`
`total_pages`	`integer (int32)`	Total number of pages available. Example: `1`
`total_count`	`integer (int32)`	Total number of items across all pages. Example: `0`
`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 Button Transactions

A paginated page of payment button transactions.

Attribute	Type	Description
`items`	array of Button Transactions Response	Paginated list of button transactions.
`page`	`integer (int32)`	Current page number (1-based). Example: `1`
`page_size`	`integer (int32)`	Number of items per page. Example: `20`
`total_pages`	`integer (int32)`	Total number of pages available. Example: `1`
`total_count`	`integer (int32)`	Total number of items across all pages. Example: `0`
`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 Payment Links

A paginated page of payment links.

Attribute	Type	Description
`items`	array of Payment Link List Response	Paginated list of payment links.
`page`	`integer (int32)`	Current page number (1-based).
`page_size`	`integer (int32)`	Number of items per page.
`total_pages`	`integer (int32)`	Total number of pages available.
`total_count`	`integer (int32)`	Total number of items 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.

Paginated List of Payment Link Transactions

A paginated page of payment link transactions.

Attribute	Type	Description
`items`	array of Payment Link Transaction Details	Paginated list of link transactions.
`page`	`integer (int32)`	Current page number (1-based). Example: `1`
`page_size`	`integer (int32)`	Number of items per page. Example: `20`
`total_pages`	`integer (int32)`	Total number of pages available. Example: `1`
`total_count`	`integer (int32)`	Total number of items across all pages. Example: `0`
`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 Payment Requests

A paginated page of payment requests.

Attribute	Type	Description
`items`	array of Payment Request List Item	Paginated list of payment requests.
`page`	`integer (int32)`	Current page number (1-based). Example: `1`
`page_size`	`integer (int32)`	Number of items per page. Example: `20`
`total_pages`	`integer (int32)`	Total number of pages available. Example: `1`
`total_count`	`integer (int32)`	Total number of items 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.

Enumerations

Payment Button Size

Visual size of the payment button widget when embedded on a webpage.

Value	Description
`Small`	Compact button, suitable for inline or constrained layouts.
`Big`	Full-size button, suitable for prominent call-to-action placement.

Payment Button Status

Status of a payment button.

Value	Description
`None`	No status; used when filtering is not applied.
`Active`	Button is live and can receive payments.
`Disabled`	Button has been manually disabled and cannot accept payments.
`Expired`	Button has passed its expiry date and can no longer receive payments.
`Forbidden`	Button has been blocked by the platform.

Payment Link Status

Status of a payment link.

Value	Description
`None`	No status; used when filtering is not applied.
`Active`	Link is live and can receive payments.
`Disabled`	Link has been manually disabled and cannot accept payments.
`Expired`	Link has passed its expiry date and can no longer receive payments.
`Forbidden`	Link has been blocked by the platform.

Payment Request Status

Current lifecycle status of a payment request.

Value	Description
`None`	No status; used when filtering is not applied.
`Pending`	Payment request has been sent; awaiting customer action.
`Seen`	Customer has opened or viewed the payment request.
`Failed`	A payment attempt was made but failed.
`Paid`	Payment has been completed successfully.
`Expired`	Payment request expired before payment was received.
`Cancelled`	Payment request was cancelled before completion.

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.

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

Validation Problem Details › errors

Attribute	Type	Description
`additionalProp1`	`array of string`	—
`additionalProp2`	`array of string`	—
`additionalProp3`	`array of string`	—