paypal¶

В этой статье

• Методы API
• paypal/charge_vault
• paypal/check_order
• paypal/check_payment
• paypal/check_subscription
• paypal/create_order
• paypal/create_payment_token
• paypal/create_setup_token
• paypal/create_subscription
• paypal/revoke_vault

(описание будет добавлено при генерации)

Методы API¶

| Метод | Действие | Описание | |-------|----------|----------|| charge_vault | списание средств через Vault | Выполняет списание платежа по сохраненному токену (Vault) для указанной инвойса. || check_order | проверка заказа | Проверяет статус захвата (capture) PayPal заказа и завершает процесс оплаты. || check_payment | проверка платежа | Создает подписку или проверяет доступность оплаты для клиента. || check_subscription | проверка подписки | Проверяет наличие недавних транзакций по подписке и подтверждает её. || create_order | создание заказа | Создает заказ PayPal (обычный или с использованием Vault). || create_payment_token | создание токена платежа | Создает токен для привязки карты (Vault) к аккаунту. || create_setup_token | создание токена настройки | Инициирует процесс создания Setup Token в PayPal для последующего сохранения карты. || create_subscription | создание подписки | Инициирует процесс создания PayPal-подписки для клиента на основе существующего счета (invoice). || revoke_vault | удаление платежного токена (Vault) | Удаляет сохраненный способ оплаты (PayPal Vault) из профиля клиента. |

paypal/charge_vault¶

Выполняет списание платежа по сохраненному токену (Vault) для указанной инвойса.

HTTP-метод: POST

Параметры:

curl -s "https://invapi.hostkey.ru/paypal.php" -X POST \
--data "action=charge_vault" \
--data "invoice_id=12345" \
--data "vault_id=vlt_abc123" \
--data "billing=my_billing_system"

{
"result": "OK",
"action": "charge_vault",
"data": {
"captured": true,
"amount": {
"value": "10.00",
"currency_code": "EUR"
},
"transaction_id": "PAYID-XXXXXXXXXXXX"
}
}

{
"code": -1,
"message": "$module/charge_vault: missing invoice_id or vault_id"
}

paypal/check_order¶

Проверяет статус захвата (capture) PayPal заказа и завершает процесс оплаты.

HTTP-метод: POST

Параметры:

curl -s "https://invapi.hostkey.ru/paypal.php" -X POST \
--data "action=check_order" \
--data "error_description=VALUE" \
--data "purchase_units=VALUE" \
--data "status=VALUE" \
--data "payment_source=VALUE"

{
"result": "OK",
"action": "check_order",
"data": {
"id": "ORDER_ID",
"status": "COMPLETED",
"purchase_units": [
{
"payments": {
"captures": [
{
"status": "COMPLETED"
}
]
}
}
],
"payment_source": {
"paypal": {
"attributes": {
"vault": {
"id": "vault_id_123"
}
}
}
}
}
}

{
"code": -1,
"message": "failed to confirm order: error_details"
}

paypal/check_payment¶

Создает подписку или проверяет доступность оплаты для клиента.

HTTP-метод: POST

Параметры:

curl -s "https://invapi.hostkey.ru/paypal.php" -X POST \
--data "action=check_payment"

{
"result": "OK",
"action": "check_payment",
"data": {
"subscription_id": "sub_12345",
"status": "active"
}
}

{
"code": -1,
"message": "PayPal is not available for USD customers"
}

paypal/check_subscription¶

Проверяет наличие недавних транзакций по подписке и подтверждает её.

HTTP-метод: POST

Параметры:

curl -s "https://invapi.hostkey.ru/paypal.php" -X POST \
--data "action=check_subscription" \
--data "error_description=VALUE" \
--data "subscription_id=VALUE" \
--data "transactions=VALUE"

{
"resource": {
"invoice_id": 123,
"custom_id": "whmcs",
"seller_receivable_breakdown": {
"paypal_fee": {
"value": "0.50"
}
},
"amount": {
"value": "50.00",
"currency_code": "EUR"
},
"id": "txn_abc123",
"status": "COMPLETED",
"origin": "new subscription sub_abc123",
"subscription_id": "sub_abc123"
}
}

{
"code": -1,
"message": "no recent transaction for subscription"
}

paypal/create_order¶

Создает заказ PayPal (обычный или с использованием Vault).

HTTP-метод: POST

Параметры:

curl -s "https://invapi.hostkey.ru/paypal.php" -X POST \
--data "action=create_order" \
--data "invoice_id=12345"

{
"result": "OK",
"action": "create_order",
"data": {
"id": "ORDER_ID",
"status": "APPROVAL_REQUIRED",
"purchase_units": []
}
}

{
"code": -1,
"message": "PayPal is not available for USD customers"
}

paypal/create_payment_token¶

Создает токен для привязки карты (Vault) к аккаунту.

HTTP-метод: POST

Параметры:

curl -s "https://invapi.hostkey.ru/paypal.php" -X POST \
--data "action=create_payment_token" \
--data "setup_token_id=VALUE"

{
"result": "OK",
"vault_id": "vault_abc123"
}

{
"code": -1,
"message": "missing setup_token_id"
}

paypal/create_setup_token¶

Инициирует процесс создания Setup Token в PayPal для последующего сохранения карты.

HTTP-метод: POST

Параметры:

curl -s "https://invapi.hostkey.ru/paypal.php" -X POST \
--data "action=create_setup_token"

{
"result": -1,
"error": "PayPal is not available for USD customers"
}

{
"code": -1,
"message": "PayPal is not available for USD customers"
}

paypal/create_subscription¶

Инициирует процесс создания PayPal-подписки для клиента на основе существующего счета (invoice).

HTTP-метод: POST

Параметры:

curl -s "https://invapi.hostkey.ru/paypal.php" -X POST \
--data "action=create_subscription"

{
"result": "OK",
"action": "create_subscription",
"data": {
"resource": {
"invoice_id": 123,
"custom_id": "whmcs",
"seller_receivable_breakdown": {
"paypal_fee": {
"value": "0.50"
}
},
"amount": {
"value": "49.99",
"currency_code": "EUR"
},
"id": "sub_123456789",
"status": "active",
"origin": "new subscription sub_123456789",
"subscription_id": "sub_123456789"
}
}
}

{
"code": -1,
"message": "PayPal is not available for USD customers"
}

paypal/revoke_vault¶

Удаляет сохраненный способ оплаты (PayPal Vault) из профиля клиента.

HTTP-метод: POST

Параметры:

curl -s "https://invapi.hostkey.ru/paypal.php" -X POST \
--data "action=revoke_vault" \
--data "vault_id=12345"

{
"result": "OK",
"action": "revoke_vault",
"data": {}
}

{
"code": -1,
"message": "PayPal/revoke_vault: vault [id] is not owned by client [user_id]"
}