Unitpay
en
en
  • Home
  • First steps
    • Registration
    • Adding a Project
      • Adding a VK Community Project
    • Project Moderation
    • Transfer of the Project
    • Video tutorials
  • Payments
    • Creating a payment (easy way)
    • Creating a Payment
    • Creating a payment (widget)
    • Parameters for receipts
    • Creating Payment Links in Your Personal Account
    • Payment Handler
    • Payment information
    • Payment Refund
    • Payments with Pre-authorization
    • Recurring payments
      • Creating a Subscription
      • Getting Information About Subscription
      • Getting a List of Active Subscriptions
      • Closing a Subscription
  • Mass payouts
    • Creating a payout
    • Information about Payout
    • Card information by BIN
    • Payments based on a CSV registry
  • Online cash desk
    • Parameters for generating a receipt
    • Unit.Reciepts
    • Adding online cash desk
    • Types of Online Cash Register Receipt Items
    • Advance credit reciepts
  • Modules
    • Payment handler
    • Unitpay SDK
    • CMS modules
      • Amiro
      • PHPShop
      • 1C Bitrix
      • CS-Cart
      • DIAFAN.CMS
      • Drupal 7 (commerce)
      • Drupal 7 (ubercart 3)
      • Drupal 8, 9 (commerce)
      • Ecwid by Lightspeed
      • HostCMS
      • InSales
      • Joomshopping 4 (joomla 3)
      • LogicBoxes
      • Magento
      • Magento 2
      • OpenCart
      • osCommerce
      • Prestashop
      • ReadyScript
      • ShopCMS
      • Simpla
      • Tilda
      • Netcat CMS
      • UMI.CMS
      • VamShop 2
      • VirtueMart 3 (joomla 3)
      • Webasyst Shop Script 7 (8)
      • Wix
      • Woocommerce Wordpress
      • Zen Cart
      • Amiro CMS
      • CMS NWICODE
      • MODX (miniShop2)
  • Manage Unitpay
    • Interface Instructions
    • SP documents
    • Legal entity documents
    • Current Balance
    • Commissions
    • Currency Conversion Rates
  • Book of reference
    • System IP addresses
    • Payment Form Appearance
    • Using the Test API
    • Operator Codes
    • Payment System Codes
    • Currency codes
    • Qiwi Country Codes
  • Referral program
    • Interface of Referrer's (Agent's) Account
  • Support
  • Other
    • Telegram bot
    • Using the Test API
  • Google Pay™
Powered by GitBook
On this page

Was this helpful?

  1. Payments

Payment information

PreviousPayment HandlerNextPayment Refund

Last updated 24 days ago

Was this helpful?

To interact with the API, use the library.

To get information about the payment, run GET query:

GET https://unitpay.ru/api?method=getPayment&params[paymentId]=153091501&params[secretKey]=x6bh0qbewehfppogkz6lufartkzyv7o0

Value

Description

paymentId

number

Payment ID in the UnitPay system.

secretKey

line

Project secret key.

Value

Description

paymentId

number

Payment ID in the UnitPay system.

secretKey

line

Project secret key.

You can run the query in test mode.

Successful response

{
   "result": {
      "paymentId": 153091501,
      "status": "success",
      "paymentType": "card",
      "date": "2020-02-16 09:22:22",
      "purse": "1234566xxxxxx0236",
      "account": "demo",
      "profit": "9.80",
      "projectId": 135,
      "orderSum": "10.00",
      "orderCurrency": "RUB",
      "payerSum": "10.00",
      "payerCurrency": "RUB",
      "availableForRefund": "10.00",
      "isPreauth": 0,
      "refunds": [],
      "receiptUrl": "https://consumer.1-ofd.ru/v1?fn=9282000100367629&fp=2120704629&i=101164&t=20200216T092200&s=26&n=1"
   }
}

Value

Description

status

line

success — successful payment; wait — payment is pending; error — payment error; error_pay — error/failure of the store at the PAY stage; in statistics, it is displayed as "incomplete"; error_check — error/failure of the store at the CHECK stage, in statistics it is displayed as "rejected"; refund — refund to the buyer; secure — being verified by the Bank's security service.

paymentId

number

Payment ID in the UnitPay system

projectId

number

Project ID in the UnitPay system

account

line

Client (order) ID in the partner's system

purse

line

Purse (account number) from which the payment was made

profit

number

Your income from this payment, rubles

paymentType

line

orderSum

number

Order amount. Make sure to check this value against the original order amount

orderCurrency

line

Order currency (RUB, UAH, BYN, EUR, USD). Make sure to check this value with the original order currency

date

line

Payment date in the YYYY-mm-dd HH:ii:ss format (for example, 2012-10-01 12:32:00)

payerSum

number

Amount debited from the subscriber's account

payerCurrency

line

Currency of debiting from the subscriber's account according to ISO 4217 standard (RUB, UAH, BYN, EUR, USD)

errorMessage

line

Error details (only for the error status)

Error response

{
    "error": {
        "message": "Неверный ключ secretKey",
        "code": -32000
    }
}

Value

Description

message

line

Information with a description of the request error.

Unitpay PHP-SDK
Learn more
Payment system code