For the complete documentation index, see llms.txt. This page is also available as Markdown.

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

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

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

post
Header parameters
x-api-public-keystringOptional

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

x-api-signaturestringOptional

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

Content-typestringOptional

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

Example: application/json
Body

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

merchantIdstringRequired

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

Example: 6c3428c6-c8b8-444f-9ab0-78c864df1719
clientIdstringRequired

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

Example: merchant_client_unique_id
clientEmailstringRequired

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

Example: client-email@example.com
clientNamestringOptional

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

Example: John Doe
returnUrlstringOptional

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

Example: https://merchant.domain/
webhookUrlstringOptional

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

Example: https://merchant.domain/webhooks/subscription
Responses
200Success
application/json

Успешный ответ

successbooleanRequired

Признак успешности запроса

post/api-gateway/recurrents/create-subscriber-billing-link
POST /api-gateway/recurrents/create-subscriber-billing-link HTTP/1.1
Host: app.apollopayment.io
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "merchantId": "6c3428c6-c8b8-444f-9ab0-78c864df1719",
  "clientId": "merchant_client_unique_id",
  "clientEmail": "client-email@example.com",
  "clientName": "John Doe",
  "returnUrl": "https://merchant.domain/",
  "webhookUrl": "https://merchant.domain/webhooks/subscription"
}
200Success
{
  "success": true,
  "response": {
    "merchantId": "6c3428c6-c8b8-444f-9ab0-78c864df1719",
    "clientId": "merchant_client_unique_id",
    "clientEmail": "client-email@example.com",
    "clientName": "John Doe",
    "returnUrl": "https://merchant.domain/",
    "webhookUrl": "https://merchant.domain/webhooks/subscription",
    "link": "https://subscriptions.domain/8a19100c-e2ec-46ba-932f-682d2df79d8b"
  }
}

Last updated