Счёт

GET

api

partner

payments

{payment_id}

Счёт

curl --request GET \
  --url https://api.vargopartners.com/api/partner/v1/payments/{payment_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.vargopartners.com/api/partner/v1/payments/{payment_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vargopartners.com/api/partner/v1/payments/{payment_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "purpose": "subscription",
  "client_id": "user-42",
  "plan_id": 123,
  "devices": 123,
  "method": "sbp",
  "amount": "150.00",
  "platform_amount": "100.00",
  "partner_share": "50.00",
  "currency": "RUB",
  "payment_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "paid_at": "2023-11-07T05:31:56Z",
  "client": {
    "client_id": "user-42",
    "created_at": "2023-11-07T05:31:56Z",
    "subscription": {
      "status": "active",
      "is_trial": true,
      "expires_at": "2023-11-07T05:31:56Z",
      "days_left": 30,
      "subscription_url": "<string>",
      "connect": [
        {
          "app_id": "happ",
          "app_name": "Happ",
          "connect_url": "<string>",
          "qr_payload": "<string>",
          "supports_manual_url": true
        }
      ],
      "devices_limit": 123
    },
    "trial_available": true
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "<string>",
    "fields": {}
  }
}

Authorizations

Authorization

string

header

required

Ключ партнёра vgo_live_…, его выдаёт платформа. Хранится только на сервере партнёра.

Path Parameters

payment_id

string<uuid>

required

Id счёта из ответа POST /payments

Response

Счёт

payment_id

string<uuid>

required

Id счёта

status

enum<string>

required

pending — ждёт оплаты; succeeded — оплачен, доступ выдан; expired — срок оплаты вышел, но статус не окончательный: поздняя оплата переводит счёт в succeeded; failed — оплата не прошла, бывает и после succeeded, если банк отозвал платёж

Available options:

pending,

succeeded,

failed,

expired

purpose

enum<string>

required

Что оплачивается

Available options:

subscription,

devices

client_id

string

required

Id клиента в вашей системе

Example:

"user-42"

plan_id

integer | null

required

Тариф — у purpose: subscription

devices

integer | null

required

Сколько устройств — у purpose: devices

method

string

required

Способ оплаты

Example:

"sbp"

amount

string

required

Сумма к оплате клиентом

Example:

"150.00"

platform_amount

string

required

Часть платформы

Example:

"100.00"

Наценка партнёра: после оплаты ложится на его баланс

Example:

"50.00"

currency

string

required

Валюта

Example:

"RUB"

payment_url

string | null

required

Страница оплаты для клиента; есть только у pending

created_at

string<date-time>

required

Когда счёт выставлен, UTC

expires_at

string<date-time>

required

Ориентир срока оплаты, UTC: статус меняется с задержкой до часа, поздняя оплата проходит

paid_at

string<date-time> | null

required

Когда счёт оплачен, UTC

client

ApiClient · object | null

required

Клиент со ссылкой подписки; заполнен у succeeded

Show child attributes

Счёт

curl --request GET \
  --url https://api.vargopartners.com/api/partner/v1/payments/{payment_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.vargopartners.com/api/partner/v1/payments/{payment_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vargopartners.com/api/partner/v1/payments/{payment_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "purpose": "subscription",
  "client_id": "user-42",
  "plan_id": 123,
  "devices": 123,
  "method": "sbp",
  "amount": "150.00",
  "platform_amount": "100.00",
  "partner_share": "50.00",
  "currency": "RUB",
  "payment_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "paid_at": "2023-11-07T05:31:56Z",
  "client": {
    "client_id": "user-42",
    "created_at": "2023-11-07T05:31:56Z",
    "subscription": {
      "status": "active",
      "is_trial": true,
      "expires_at": "2023-11-07T05:31:56Z",
      "days_left": 30,
      "subscription_url": "<string>",
      "connect": [
        {
          "app_id": "happ",
          "app_name": "Happ",
          "connect_url": "<string>",
          "qr_payload": "<string>",
          "supports_manual_url": true
        }
      ],
      "devices_limit": 123
    },
    "trial_available": true
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "<string>",
    "fields": {}
  }
}

Начало

Справочник API

Как это работает

Подключение

Authorizations

Path Parameters

Response