/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": "string",
    "force": false,
    "merchantAuthToken": "string",
    "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b"
}

Name	Description
apiKey*	Type: string
merchantAuthToken*	Type: string Authorization token generated by the merchant
force	Type: boolean Default:
merchantId	Type: string<uuid>

success

application/json

{
    "status": "success"
}

Name

Description

status

Type: string

Default: success

bad request

application/json

{
    "reason": "string",
    "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
status	Type: string Default: `fail`