PayOut

POST /host2host/payout

Creates a PayOut operation. The merchant pays to the customer.

Authentication

Authorization: Bearer YOUR_JWT_TOKEN

Request Body

Field	Type	Required	Description
`paymentMethod`	string	Yes	Payment method code (see Payment Methods)
`idTransactionMerchant`	string	Yes	Your unique transaction identifier
`amount`	decimal	Yes	Payout amount in the operation currency
`number`	string	Yes	Recipient's card number, phone, or account number
`bankName`	string	Yes	Recipient's bank name
`nameMediator`	string	No	Recipient's full name
`clientID`	string	Yes	Unique customer identifier in your system
`clientIP`	string	Yes	Customer's IP address
`clientDateCreated`	datetime	Yes	Customer registration date in your system
`integrationMerhcnatData`	object	No	Webhook configuration
`integrationMerhcnatData.webHook`	string	No	Webhook URL for this operation

Example: Card PayOut

curl -X POST 'https://api.admin-pixelwave.com/host2host/payout' \
  -H 'Authorization: Bearer YOUR_JWT_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "paymentMethod": "toCard",
    "idTransactionMerchant": "payout-12345",
    "amount": 3000,
    "number": "4276123456789012",
    "bankName": "Sberbank",
    "nameMediator": "Ivanov Ivan",
    "clientID": "user-67890",
    "clientIP": "192.168.1.100",
    "clientDateCreated": "2025-01-15T10:30:00Z"
  }'

Example: SBP PayOut

curl -X POST 'https://api.admin-pixelwave.com/host2host/payout' \
  -H 'Authorization: Bearer YOUR_JWT_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "paymentMethod": "sbp",
    "idTransactionMerchant": "payout-sbp-001",
    "amount": 3000,
    "number": "+79991234567",
    "bankName": "Sberbank",
    "clientID": "user-67890",
    "clientIP": "192.168.1.100",
    "clientDateCreated": "2025-01-15T10:30:00Z"
  }'

Success Response

{
  "result": {
    "status": "success",
    "x-request-id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "codeError": "none",
    "codeErrorExt": "none",
    "message": ""
  },
  "data": {
    "id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
    "dateAdded": "2025-01-15T10:30:01Z",
    "dateUpdated": "2025-01-15T10:30:01Z",
    "typeOperation": "payOut",
    "status": "in_progress",
    "idTransactionMerchant": "payout-12345",
    "amountInitial": 3000,
    "amountRandomized": 0,
    "amount": 3000,
    "amountComission": 90,
    "currency": "RUB",
    "amountInCurrencyBalance": 37.50,
    "amountComissionInCurrencyBalance": 1.125,
    "exchangeRate": 80.00
  },
  "totalNumberRecords": 0
}

Response Fields

Field	Type	Description
`id`	uuid	Platform operation ID
`status`	string	`in_progress` — payout is being processed
`amount`	decimal	Payout amount
`amountComission`	decimal	Commission charged
`currency`	string	Operation currency
`amountInCurrencyBalance`	decimal	Amount deducted from your balance (USDT)
`exchangeRate`	decimal	Exchange rate used

PayOut responses do not include paymentDetailsData — the recipient details are the ones you provided in the request.

Error Responses

Error Code	Description
`invalidRequestParameters`	Missing or invalid fields
`duplicateIdentifier`	`idTransactionMerchant` already exists
`noSuitableTariffForRequest`	No tariff for this method/amount
`notEnoughMoneyOnBalance`	Insufficient merchant balance
`noPaymentDetailsAvailable`	No providers available

Important Notes

Your balance must cover the payout amount plus commission
For SBP payouts, number must be a phone number in format +7XXXXXXXXXX
For card payouts, number must be a valid card number (16 digits)
The bankName affects commission calculation — use the exact bank name
Final status comes via webhook

PayOut

On this page