Skip to main content
POST
/
invoice
/
try
Invoice preliminary calculation
curl --request POST \
  --url https://api.m4solutions.io/gateway/v1/invoice/try \
  --header 'Content-Type: application/json' \
  --data '
{
  "shop_id": 1520,
  "shop_order_id": "5b0efa8a-153b-4421-abac-2aba4d772a86",
  "amount": "6320.91",
  "currency": 840,
  "payway": "card_payway_usd",
  "description": "Payment for shop_id=1520"
}
'
{
  "result": true,
  "message": "Ok",
  "error_code": 0,
  "data": {
    "add_ons_config": {
      "email": {
        "comment": {
          "en": "Enter your e-mail",
          "ru": "Введите Ваш e-mail"
        },
        "example": "someone@example.com",
        "label": {
          "en": "E-mail",
          "ru": "Электронная почта"
        },
        "regex": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+.[a-zA-Z0-9-.]+$"
      }
    },
    "payer_price": 227.56,
    "paymethod_id": 4,
    "paymethod_name": "wallet_method",
    "ps_currency": 840,
    "info": {},
    "manual": {
      "en": "Please enter your email we will use it to send you a billing statement",
      "ru": "Пожалуйста укажите свой email, мы вышлем на него квитанцию об оплате"
    },
    "warning": {}
  }
}

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.

Authorizations

​
sign
string
requestBody
required

Every API request must be signed so that we can identify your account.

The signature is transferred in the request body through the sign parameter, for example:

{
    "shop_id": 1520,
    "shop_order_id" : "5b0efa8a-153b-4421-abac-2aba4d772a86",
    "amout": "6320.91",
    "currency": 840,
    "payway": "card_invoice_usd",
    "description": "Payment for shop_id=1520",
    "sign": "77a6f7a30876d480d4e771d08cb83800dd5cb874664c77e515ffc052b20293c6"
}
All further request examples do not include the "sign" parameter, nevertheless your real requests must include it in the request body where required.

Signature line is generated according to the following algorithm: all request parameters involved in signature generation are ordered in the alphabetical order of keys, the values are concatenated with a colon (":") and the account secret key is added at the end (without the: sign), a sha256 hash is generated from the resulting line and its hex representation is passed in the sign request parameter.

Example of signature generation for a method invoice/create:

  1. Determining the list of parameters. It looks as follows for the method in consideration:

Fields involved in request signature generation:

  • shop_id
  • shop_order_id
  • amount
  • currency
  • payway
  1. Let's sort keys in alphabetical sequence:

"amount", "currency", "payway", "shop_id", "shop_order_id"

  1. The line for generating the SHA256 hash will be as follows:

"6320.91:840:card_invoice_usd:1520:5b0efa8a-153b-4421-abac-2aba4d772a86account-secret-key"

Where account-secret-key is the secret identification key for your account. You can request a key from the support service.

  1. Let's get a hash expression of the generated line using Python code:
>>> string_to_sign = '6320.91:840:card_invoice_usd:1520:5b0efa8a-153b-4421-abac-2aba4d772a86account-secret-key'
>>> import hashlib
>>> sign = hashlib.sha256(string_to_sign.encode()).hexdigest()
>>> print(sign)
'77a6f7a30876d480d4e771d08cb83800dd5cb874664c77e515ffc052b20293c6'
You can check whether you have generated the signature correctly using the service https://www.xorbin.com/tools/sha256-hash-calculator.

Body

application/json
​
shop_id
integer
required

Unique shop identifier in the M4 system.

Example:

1520

​
shop_order_id
string
required

Order ID in your system. Must be unique for each new invoice.

Maximum string length: 255
Example:

"5b0efa8a-153b-4421-abac-2aba4d772a86"

​
amount
string
required

Amount received or withdrawn. Example: "227.34"

Example:

"6320.91"

​
currency
number
required

Numeric currency identifier in accordance with ISO 4217. Example: 840

Example:

840

​
payway
string
required

Payment way for payment. Invoice currency depends on the specified payment way.

There are two ways to get a list of all payment directions available to the shop:

  • Execute API request "Receiving payment methods for input" shop_input_config/shop.
  • Request register from the support service.
Maximum string length: 150
Pattern: ^[A-Za-z_,\[\]]+$
Example:

"card_payway_usd"

​
description
string

Optional payment description.

Maximum string length: 255
Example:

"Payment for shop_id=1520"

Response

200 - application/json

OK

​
result
boolean
required

Boolean value, in case of successful response it will be true, in case of error – false

Example:

true

​
message
string
required

A textual description of the error, in case of success - simply Ok

Example:

"Ok"

​
error_code
number
required

If this value is greater than 0, then the request ended with an error. Description of error codes

Example:

0

​
data
Preliminary calculation of the invoice · object
required