/v1/orders

cart

Cart

{
  "externalId": "example",
  "items": [
    {
      "description": "example",
      "discountedUnitPrice": "123.45",
      "productId": "example",
      "quantity": null,
      "receipt": null,
      "subtotal": "123.45",
      "title": "example",
      "total": "123.45",
      "unitPrice": "123.45"
    }
  ],
  "total": {
    "amount": "123.45",
    "label": "example"
  }
}

currencyCode

Type: string

Three-letter code of the order currency code (ISO 4217)

Const: RUB

Max length: 2048

Example: example

orderId

Type: string

Order ID on the merchant side (it should be unique). Further interaction on the payment request will be carried out using this ID. The ID will also be used at reconciliation

Max length: 2048

Example: example

availablePaymentMethods

Type: string[]

Payment methods available in the Yandex Pay payment form.

If you are integrating payments only with one method (for example, Card), specify a single method (["CARD"]). To enable payments by bank cards and using Yandex Split, pass: ["CARD", "SPLIT"].

Default: null

Min items: 1

[
  "CARD"
]

billingPhone

Type: string

Customer phone number.

Used for simplified authorization and may make Split approval more likely.

Recommended phone number format: +71234567890 or 71234567890. The string may contain other characters. However, any characters, except numbers, are ignored. If a phone number starts with 8, it is handled as a similar number where 8 is replaced with +7.

For example, passed values such as 71234567890, +71234567890, 81234567890, and +7 (123) 456-78-90 will be handled as 71234567890.

Max length: 2048

Example: example

extensions

Additional parameters for placing an offline order

Default: null

isPrepayment

Type: boolean

Whether to transfer an order based on the "deferred payment" flow.

If the parameter value is set to true, the order is placed as that with deferred payment. For details, see "Payment methods and payment mechanisms".

metadata

Type: string

Arbitrary order data for internal use

Max length: 2048

Example: example

orderSource

Type: string

Indicates where order creation was initialized

Used for subsequent analysis

WEBSITE: The button is placed on the website. A payment link is generated after certain user actions (clicking the button) on the website

APP: The button is placed in the mobile app. A payment link is generated after certain user actions (tapping the button) in the app

CRM: A payment link is generated by a manager in the CRM system or another admin panel

CASH_REGISTER: A payment link is generated to be displayed in the offline cash register

CMS_PLUGIN: The payment link is generated in the CMS plugin.

Default: null

Enum: WEBSITE, APP, CRM, CASH_REGISTER, CMS_PLUGIN

preferredPaymentMethod

Type: string

Preferred payment method.

The passed method will be selected automatically in the payment form provided that it is on the list of allowed payment methods. Card by default.

Enum: FULLPAYMENT, SPLIT

publicConstructor

Type: string

Constructor of the preselected Split payment plan.

Available only upon approval

Enum: 2, 4, 6, null

Example: 2

purpose

Type: string

Purpose of payment

Max length: 1000

Example: example

redirectUrls

Links for redirecting the user from the payment form. Required for online stores

{
  "onAbort": "example",
  "onError": "example",
  "onSuccess": "example"
}

risk

Additional info specifying which may make Split approval more likely. Fully available for online stores only.

{
  "billingPhone": "example",
  "deviceId": "example",
  "shippingAddress": "example",
  "shippingPhone": "example",
  "shippingType": "COURIER"
}

ttl

Type: integer

The parameter sets the time that the user is given to follow the link to the order payment form.

When expired, the user will see a message saying "Payment time expired".

If the user follows the link before the expiry, they will be given another 15 minutes to make a payment. If no payment is made during the additional time, the order is finally considered unpaid.

This is indicated in the Order.paymentStatus value that changes to FAILED. In addition, a notification about the order payment status change is sent. If the merchant booked the product, the order can be canceled after the status changes.

Time-to-live (seconds): 180 <= ttl <= 604800

Time-to-live (when generating a link in the personal account, seconds): 86400

Default: 1800

uniqrMetadata

Additional uniqr data

{
  "uniQrId": "example"
}

count

Type: string<double>

Product quantity in the order

Example: 123.45

available

Type: string<double>

Maximum available product quantity

Example: 123.45

label

Type: string

Name of measurement units, for example, "kg" or "pcs"

Max length: 2048

Example: example

phones

Type: string[]

[
  "example"
]

address

Type: string

Max length: 2048

Example: example

inn

Type: string

Max length: 2048

Example: example

name

Type: string

Max length: 2048

Example: example

phones

Type: string[]

[
  "example"
]

agentType

Type: integer

Agent type by taxable object. See values

Enum: 1, 2, 3, 4, 5, 6, 7

operation

Type: string

Max length: 2048

Example: example

paymentsOperator

Type: PaymentsOperator

{
  "phones": [
    "example"
  ]
}

phones

Type: string[]

[
  "example"
]

transferOperator

Type: TransferOperator

{
  "address": "example",
  "inn": "example",
  "name": "example",
  "phones": [
    "example"
  ]
}

denominator

Type: integer

numerator

Type: integer

inn

Type: string

Max length: 2048

Example: example

name

Type: string

Max length: 2048

Example: example

phones

Type: string[]

[
  "example"
]

tax

Type: integer

Value description: Link

Enum: 1, 2, 3, 4, 5, 6

agent

Type: Agent

{
  "agentType": 1,
  "operation": "example",
  "paymentsOperator": {
    "phones": [
      "example"
    ]
  },
  "phones": [
    "example"
  ],
  "transferOperator": {
    "address": "example",
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  }
}

excise

Type: string<double>

It shouldn't include more than two decimal digits. For example: 1.12, 5.1, 10, 11.00 .

Example: 123.45

markQuantity

Type: MarkQuantity

{
  "denominator": 0,
  "numerator": 0
}

measure

Type: integer

Value description: Link

Enum: 0, 10, 11, 12, 20, 21, 22, 30, 31, 32, 40, 41, 42, 50, 51, 70, 71, 72, 73, 80, 81, 82, 83, 255, null

paymentMethodType

Type: integer

Value description: Link

Enum: 1, 2, 3, 4, 5, 6, 7, null

paymentSubjectType

Type: integer

Value description: Link

Enum: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, null

productCode

Type: string<base64>

Product code (a base64-encoded array of 1 to 32 bytes)

Example: example

supplier

Type: Supplier

{
  "inn": "example",
  "name": "example",
  "phones": [
    "example"
  ]
}

title

Type: string

Max length: 2048

Example: example

productId

Type: string

Product ID in the merchant system Make sure that each productId in the request parameters is unique.

Max length: 2048

Example: example

quantity

Product quantity in the order

{
  "available": "123.45",
  "count": "123.45",
  "label": "example"
}

title

Type: string

Product name

Max length: 2048

Example: example

total

Type: string<double>

Total price per item with item discount

Example: 123.45

description

Type: string

Product description

Max length: 2048

Example: example

discountedUnitPrice

Type: string<double>

Price per product unit with discount per item

Example: 123.45

receipt

Data for receipt generation

{
  "agent": {
    "agentType": 1,
    "operation": "example",
    "paymentsOperator": {
      "phones": [
        "example"
      ]
    },
    "phones": [
      "example"
    ],
    "transferOperator": {
      "address": "example",
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    }
  },
  "excise": "123.45",
  "markQuantity": {
    "denominator": 0,
    "numerator": 0
  },
  "measure": 0,
  "paymentMethodType": 1,
  "paymentSubjectType": 1,
  "productCode": "example",
  "supplier": {
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  },
  "tax": 1,
  "title": "example"
}

subtotal

Type: string<double>

Total price per item without discount

Example: 123.45

unitPrice

Type: string<double>

Total price per product unit without discount

Example: 123.45

amount

Type: string<double>

Cart cost with all discounts

Example: 123.45

label

Type: string

Name of measurement units, for example, "kg" or "pcs"

Max length: 2048

Example: example

items

Type: RenderedCartItem[]

Cart items that the customer pays for.

[
  {
    "description": "example",
    "discountedUnitPrice": "123.45",
    "productId": "example",
    "quantity": {
      "available": "123.45",
      "count": "123.45",
      "label": "example"
    },
    "receipt": {
      "agent": {
        "agentType": 1,
        "operation": "example",
        "paymentsOperator": {},
        "phones": [
          null
        ],
        "transferOperator": {}
      },
      "excise": "123.45",
      "markQuantity": {
        "denominator": 0,
        "numerator": 0
      },
      "measure": 0,
      "paymentMethodType": 1,
      "paymentSubjectType": 1,
      "productCode": "example",
      "supplier": {
        "inn": "example",
        "name": "example",
        "phones": [
          null
        ]
      },
      "tax": 1,
      "title": "example"
    },
    "subtotal": "123.45",
    "title": "example",
    "total": "123.45",
    "unitPrice": "123.45"
  }
]

total

Final order cost.

{
  "amount": "123.45",
  "label": "example"
}

externalId

Type: string

Cart ID passed by the merchant

Max length: 2048

Example: example

branchId

Type: string

The field is required for offline stores only. ID of the point of sale

Default: null

Max length: 2048

managerId

Type: string

The field is required for offline stores only. Manager ID

Default: null

Max length: 2048

token

Type: string

QR token

Max length: 2048

Example: example

phone

Type: string

Customer phone number (e.g., +71234567890) for SMS notification. For offline store merchantId only.

Max length: 2048

Pattern: ^\+\d+$

Example: example

billingReport

Information about where the order was placed and who placed it.

{
  "branchId": "null",
  "managerId": "null"
}

qrData

Additional parameters for sending a link for payment via QR code

{
  "token": "example"
}

smsOffer

Additional parameters for sending a link for payment via SMS.

The field is required for offline stores only.

{
  "phone": "example"
}

onError

Type: string

The field is required for online stores only. A link to redirect the user in case of a payment error or TTL expiry for a payment link

Max length: 2048

Example: example

onSuccess

Type: string

The field is required for online stores only. Link to redirect the user on payment success.

Max length: 2048

Example: example

onAbort

Type: string

Link to redirect the user on payment cancellation. Payment can be canceled by the user in the payment form.

Max length: 2048

Example: example

billingPhone

Type: string

DEPRECATED Customer phone number.
Use the same-name field one level up instead.

Max length: 2048

Example: example

deviceId

Type: string

Customer device ID (device_id/gaid/idfa/ifv)

Max length: 2048

Example: example

shippingAddress

Type: string

Delivery address

Max length: 2048

Example: example

shippingPhone

Type: string

Recipient phone number (e.g., +71234567890)

Max length: 2048

Example: example

shippingType

Type: string

Order delivery method

Enum: COURIER, PICKUP, null

Example: COURIER

uniQrId

Type: string

Max length: 2048

Example: example