Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.m4psp.com/llms.txt

Use this file to discover all available pages before exploring further.

​
shop_refund_id
string
required

The refund ID in your system. Must be unique for each new refund.

Maximum string length: 255
Example:

"dc4ad503-d97a-4fec-adeb-ba51d43a7191"

​
status
enum<string>
required

Refund status:

  • WAITING - return in process;
  • SUCCESS - return successfully processed;
  • FAILED - the return has not been processed.
Available options:
WAITING,
SUCCESS,
FAILED
Example:

"SUCCESS"

​
invoice_id
number<integer>
required

Invoice ID in the M4 system.

Example:

108744

​
amount
string
required

Refund amount, calculated in currency.

Example:

"95.50"

​
currency
enum<string>
required

Alphabetic currency identifier in accordance with ISO 4217.

Available options:
USD,
EUR
Example:

"USD"

​
error_code
number<integer>
required

M4 API error code. 0 in cases there is no any error. Other codes can be found here: Description of error codes

Example:

0

​
created_at
string<date-time>
required

Date and time when the refund was created

​
processed_at
string<date-time> | null
required

Date and time of actual processing of the refund in the payment system

​
sign
string
required

Request signature

​
addons
string
required