Creating a payout
Only mass payments can be set up via API.
https://unitpay.ru/api?
method=massPayment
params[sum]=10.00
params[purse]=7951xxxxx71
params[login][email protected]
params[transactionId]=1782
params[secretKey]=key
params[paymentType]=sbp
Mandatory Parameters:
login
string
Email account in the UnitPay system
purse
string
Recipient's wallet, full card number or phone number without "+" (for SBP payouts)
transactionId
text
Unique payout ID on your side
sum
number
Transfer amount in rubles, for example: "100"
paymentType
string
Payment system code
Supported: card, webmoney, usdt, sbp
memberId
string
Bank identifier that can be requested using the method. Required for SBP disbursements only
Additional Parameters:
projectId
namber
Unique project ID in the UnitPay system
comment
text
Payment comment. Displayed only in your personal cabinet (only letters, numbers, dots and commas are allowed)
IMPORTANT: always use a unique transactionId for new payments, retrieving an existing transactionId (regardless of other parameters) returns the current payment status.
If after creating a payment you need to check its status, you need to use the "Information about Payout" query
Successful
{"result": {
"message": "Payout successfully completed",
"status": "success",
"payoutId": "114233",
"partnerBalance": "15733.00",
"createDate": "2021-12-01 11:51:02",
"completeDate": "2021-12-01 11:52:02",
"sum": "300",
"payoutCommission": "6.00",
"partnerCommission": "0.00"
}}
message
string
Successful operation comment, can be used as a hint to the user after the request has been executed
status
string
success - successful payment not_completed - payment has been sent to the payment system, but no confirmation has been received yet (temporary status)
payoutId
number
Unique payment ID in the UnitPay system
partnerBalance
number
Partner's balance in the system available for payments
createDate
text
Date of creation of the instalment
completeDate
text
Date of finalisation of payout
sum
number
Amount of payout
payoutCommission
number
Payout commission
partnerCommission
number
Partner commission
Example of an erroneous answer:
{"error": {
"message": "Payment in the specified currency to the specified details is not possible",
"code": 122
}}
message
string
Information describing the request error
code
string
Error code, detailed decoding in the table below
Error Description:
100
The "masspayment" service is deactivated
101
The "masspayment" service is not available to you
122
Payment in the specified currency to the specified details is not possible
1051
We were unable to retrieve the recipient's wallet information. Check the wallet number and try the operation again or after a while.
Technical errors:
-32000
Invalid authorisation parameters (login, secret key)
-32602
Invalid query parameters
-32603
Internal technical error
IMPORTANT: If you receive an error with code -32603 use the payout information request as the payout may change its status after a re-request.
Last updated
Was this helpful?