/v1/onboard

Request to confirm registration in the Yandex Pay console.

Request

POST

https://example.merchant.ru/v1/onboard

Production

POST

https://sandbox.example.merchant.ru/v1/onboard

Sandbox

application/json

{
  "apiKey": "example",
  "force": false,
  "merchantAuthToken": "example",
  "merchantId": "123e4567-e89b-12d3-a456-426614174000"
}

Name	Description
apiKey	Type: string Example: `example`
merchantAuthToken	Type: string Authorization token generated by the merchant Example: `example`
force	Type: boolean Default: `false`
merchantId	Type: string<uuid> Example: `123e4567-e89b-12d3-a456-426614174000`

success

application/json

{
  "status": "success"
}

Name

Description

status

Type: string

Default: success

bad request

application/json

{
  "reason": "example",
  "reasonCode": "FORBIDDEN",
  "status": "fail"
}

Name	Description
reasonCode	Type: string Enum: `FORBIDDEN`, `ITEM_NOT_FOUND`, `ORDER_NOT_FOUND`, `ORDER_AMOUNT_MISMATCH`, `ORDER_DETAILS_MISMATCH`, `OUT_OF_INVENTORY`, `PICKUP_POINT_NOT_FOUND`, `SHIPPING_DETAILS_MISMATCH`, `OTHER`, `UNAUTHORIZED`, `TOKEN_EXPIRED`, `CONFLICT`
reason	Type: string Example: `example`
status	Type: string Default: `fail`