Создание платежной связки

Метод создает временную ссылку для подключения пользователя. Пользователь должен перейти по ссылку и дать разрешение на трату монет с его адреса. После этого вы получите вебхук со статусом и идентификатором платежной связки

Создание платежной связки

post

Header parameters

x-api-public-keystringoptional

Публичный API-ключ

x-api-signaturestringoptional

Подпись тела запроса приватным API-ключем

Content-typestringoptional

Тип тела запроса

Example: application/json

Body

Тело запроса создания ссылки для подключения пользователя

merchantIdstringrequired

Идентификатор мерчанта в системе

Example: 2612ad7b-ed3d-45e4-aab2-6a13e2ecd0e0

clientIdstringrequired

Идентификатор клиента в системе мерчанта

Example: merchant_client_unique_id

clientEmailstringrequired

Почта клиента в системе мерчанта

Example: [e-mail]

clientNamestringoptional

Имя клиента в системе мерчанта

Example: John Doe

returnUrlstringoptional

URL который будет использоватеться в качестве ссылки "Вернуться в магазин"

Example: https://merchant.domain/

webhookUrlstringoptional

URL для уведомления о подключении или отклонении запроса на подключение клиента

Example: https://merchant.domain/webhooks/subscription

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://ocp.onchainpay.io/api-gateway/recurrents/create-subscriber-billing-link' \
  --header 'Content-Type: application/json' \
  --data '{
    "merchantId": "2612ad7b-ed3d-45e4-aab2-6a13e2ecd0e0",
    "clientId": "merchant_client_unique_id",
    "clientEmail": "[e-mail]",
    "clientName": "John Doe",
    "returnUrl": "https://merchant.domain/",
    "webhookUrl": "https://merchant.domain/webhooks/subscription"
  }'

200

200

{
  "success": true,
  "response": {
    "merchantId": "2612ad7b-ed3d-45e4-aab2-6a13e2ecd0e0",
    "clientId": "merchant_client_unique_id",
    "clientEmail": "[e-mail]",
    "clientName": "John Doe",
    "returnUrl": "https://merchant.domain/",
    "webhookUrl": "https://merchant.domain/webhooks/subscription",
    "link": "https://subscriptions.domain/e34d0746-b972-4b07-a9be-931f1578e898"
  }
}