/v1/orders

Request to create a link for order payment.

The request is used to create and obtain a link to pay for the order.

Request

POST

https://pay.yandex.ru/api/merchant/v1/orders

Production

POST

https://sandbox.pay.yandex.ru/api/merchant/v1/orders

Sandbox

Body

application/json

{
    "availablePaymentMethods": null,
    "billingPhone": "string",
    "cart": {
        "externalId": "string",
        "items": [
            {
                "description": "string",
                "discountedUnitPrice": "123.45",
                "pointsAmount": "123.45",
                "productId": "string",
                "quantity": {
                    "available": "123.45",
                    "count": "123.45",
                    "label": "string"
                },
                "receipt": {
                    "agent": {
                        "agentType": 1,
                        "operation": "string",
                        "paymentsOperator": {
                            "phones": [
                                "string"
                            ]
                        },
                        "phones": [
                            "string"
                        ],
                        "transferOperator": {
                            "address": "string",
                            "inn": "string",
                            "name": "string",
                            "phones": [
                                "string"
                            ]
                        }
                    },
                    "excise": "123.45",
                    "markQuantity": {
                        "denominator": 0,
                        "numerator": 0
                    },
                    "measure": 0,
                    "paymentMethodType": 1,
                    "paymentSubjectType": 1,
                    "productCode": "string",
                    "supplier": {
                        "inn": "string",
                        "name": "string",
                        "phones": [
                            "string"
                        ]
                    },
                    "tax": 1,
                    "title": "string"
                },
                "subtotal": "123.45",
                "title": "string",
                "total": "123.45",
                "unitPrice": "123.45"
            }
        ],
        "total": {
            "amount": "123.45",
            "label": "string",
            "pointsAmount": "123.45"
        }
    },
    "currencyCode": "RUB",
    "extensions": {
        "billingReport": {
            "branchId": null,
            "managerId": null
        },
        "qrData": {
            "token": "string"
        },
        "smsOffer": {
            "phone": "string"
        }
    },
    "isPrepayment": false,
    "metadata": "string",
    "orderId": "string",
    "orderSource": "WEBSITE",
    "preferredPaymentMethod": "FULLPAYMENT",
    "publicConstructor": "2",
    "purpose": "string",
    "redirectUrls": {
        "onAbort": "string",
        "onError": "string",
        "onSuccess": "string"
    },
    "risk": {
        "billingPhone": "string",
        "deviceId": "string",
        "shippingAddress": "string",
        "shippingPhone": "string",
        "shippingType": "COURIER"
    },
    "ttl": 1800,
    "uniqrMetadata": {
        "uniQrId": "string"
    }
}

Name	Description
cart*	Type: RenderedCart Cart
currencyCode*	Type: string Three-letter code of the order currency code (ISO 4217) Max length: `2048` Enum: `RUB`
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`
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"]`. Enum: `CARD`, `SPLIT` Default: `null` Min items: `1`
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`
extensions	Type: OrderExtensions Additional parameters for placing an offline order
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`
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. Default: `null` Enum: `WEBSITE`, `APP`, `CRM`, `CASH_REGISTER`
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`
purpose	Type: string Purpose of payment Max length: `1000`
redirectUrls	Type: MerchantRedirectUrls Links for redirecting the user from the payment form. Required for online stores
risk	Type: MerchantRiskInfo Additional info specifying which may make Split approval more likely. Fully available for online stores only.
ttl	Type: integer<int32> 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	Type: UniqrMetadata Additional uniqr data

RenderedCart

Name	Description
items*	Type: RenderedCartItem[] Cart items that the customer pays for.
total*	Type: CartTotal Final order cost.
externalId	Type: string Cart ID passed by the merchant Max length: `2048`

OrderExtensions

Name	Description
billingReport	Type: BillingReport Information about where the order was placed and who placed it.
qrData	Type: QRData Additional parameters for sending a link for payment via QR code
smsOffer	Type: SMSOffer Additional parameters for sending a link for payment via SMS. The field is required for offline stores only.

MerchantRedirectUrls

Name	Description
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`
onSuccess*	Type: string The field is required for online stores only. Link to redirect the user on payment success. Max length: `2048`
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`

MerchantRiskInfo

Name	Description
billingPhone	Type: string DEPRECATED Customer phone number. Use the same-name field one level up instead. Max length: `2048`
deviceId	Type: string Customer device ID (device_id/gaid/idfa/ifv) Max length: `2048`
shippingAddress	Type: string Delivery address Max length: `2048`
shippingPhone	Type: string Recipient phone number (e.g., +71234567890) Max length: `2048`
shippingType	Type: string Order delivery method Enum: `COURIER`, `PICKUP`, `null`

UniqrMetadata

Name

Description

uniQrId*

Type: string

Max length: 2048

RenderedCartItem

Name	Description
productId*	Type: string Product ID in the merchant system Make sure that each `productId` in the request parameters is unique. Max length: `2048`
quantity*	Type: ItemQuantity Product quantity in the order
title*	Type: string Product name Max length: `2048`
total*	Type: string<double> Total price per item with item discount Example: `123.45`
description	Type: string Product description Max length: `2048`
discountedUnitPrice	Type: string<double> Price per product unit with discount per item Example: `123.45`
pointsAmount	Type: string<double> Number of Plus points Example: `123.45`
receipt	Type: ItemReceipt Data for receipt generation
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`

CartTotal

Name	Description
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`
pointsAmount	Type: string<double> Number of plus points Example: `123.45`

BillingReport

Name

Description

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

QRData

Name

Description

token*

Type: string

QR token

Max length: 2048

SMSOffer

Name

Description

phone*

Type: string

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

Max length: 2048

Pattern: ^\+\d+$

ItemQuantity

Name	Description
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`

ItemReceipt

Name	Description
tax*	Type: integer Value description: Link Enum: `1`, `2`, `3`, `4`, `5`, `6`
agent	Type: Agent
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
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)
supplier	Type: Supplier
title	Type: string Max length: `2048`

Agent

Name	Description
agentType*	Type: integer Agent type by taxable object. See values Enum: `1`, `2`, `3`, `4`, `5`, `6`, `7`
operation	Type: string Max length: `2048`
paymentsOperator	Type: PaymentsOperator
phones	Type: string[] Max length: `2048`
transferOperator	Type: TransferOperator

MarkQuantity

Name	Description
denominator*	Type: integer<int32>
numerator*	Type: integer<int32>

Supplier

Name	Description
inn	Type: string Max length: `2048`
name	Type: string Max length: `2048`
phones	Type: string[] Max length: `2048`

PaymentsOperator

Name

Description

phones

Type: string[]

Max length: 2048

TransferOperator

Name	Description
address	Type: string Max length: `2048`
inn	Type: string Max length: `2048`
name	Type: string Max length: `2048`
phones	Type: string[] Max length: `2048`

Responses

200 OK

Body

application/json

{
    "code": 200,
    "data": {
        "paymentUrl": "string"
    },
    "status": "success"
}

Name	Description
data*	Type: CreateOrderResponseData
code	Type: number Default: `200`
status	Type: string Default: `success` Enum: `success`

CreateOrderResponseData

Name

Description

paymentUrl*

Type: string

Link to paying for the order

Max length: 2048

/v1/orders

Request

Body

RenderedCart

OrderExtensions

MerchantRedirectUrls

MerchantRiskInfo

UniqrMetadata

RenderedCartItem

CartTotal

BillingReport

QRData

SMSOffer

ItemQuantity

ItemReceipt

Agent

MarkQuantity

Supplier

PaymentsOperator

TransferOperator

Responses

200 OK

Body

CreateOrderResponseData

Was the article helpful?