PayStar API Documentation
  1. API DOC | EN
  • API DOC | EN
    • Introduction
    • Glossary
    • Authorization key
    • Sandbox
    • Additional fields
    • Currencies
    • Bank names
    • Telecom operators
    • Callbacks
    • Payment history
    • Error descriptions
    • Tech FAQ
    • Events
    • Balance H2H
      GET
    • Deposit H2H - ECOM (with PCI) / P2P / Online
      POST
    • Deposit H2H - ECOM by Card token (without PCI)
      POST
    • Deposit H2C - ECOM (without PCI)
      POST
    • Deposit status H2H - PayStar ID
      GET
    • Deposit status H2H - Merch ID
      GET
    • Payout H2H
      POST
    • Payout status H2H - PayStar ID
      GET
    • Payout status H2H - Merch ID
      GET
  • MERCHANT
    • FEATURES | EN
      • Deposits & Payouts
      • Issues (Tickets)
      • Secure data (One-time secret)
      • Summary Report
      • Payment Analytics
      • Payment Form Analytics
      • Unified audit log
      • Export reports
      • Black list
      • Routing & Cascading
      • Limits
      • Commissions
      • Team
      • My Account
      • PayStar in 100 Questions
    • ВОЗМОЖНОСТИ | RU
      • Депозиты и выплаты
      • Issues (Задачи)
      • Защищённые данные (One-time secret)
      • Сводный отчёт
      • Аналитика по платежам
      • Единый журнал событий
      • Аналитика платёжной формы
      • Экспорт отчётов
      • Черный список
      • Мавршрутизация и Каскады
      • Лимиты
      • Комиссии
      • Команда
      • Мой аккаунт
      • PayStar в 100 вопросах
  1. API DOC | EN

Payout H2H

POST
https://secure.PayStar.uk/api/v1/integration/withdrawal-order/
Maintainer:Not configured
INFO
This method is used to perform payouts.
Note: Deposits and payouts cannot share the same Authorization keys — they are two separate pipelines.
Payment Status Verification Before Cascading
Errors and missing responses during payment creation may occur due to transient or unforeseen circumstances and do not reliably indicate the final payment status. If you receive a 499+ error, any other error, or no response at all, for example due to a broken connection or timeout, check the payment status in our system before sending the payment through the cascade.
You can use this CURL to create a payout order.
curl --request POST \
--url https://secure.PayStar.uk//api/v1/integration/withdrawal-order \
--header 'Authorization: Bearer Your Token' \
--header 'Content-Type: application/json' \
--header 'accept: text/plain' \
--data '{
 "amount": 100,
 "currency": "USD",
 "externalTransactionId": "Merch12345",
 "callbackUrl": "https://merch.com/callbackUrl",
 "additionalFields": [
   {
    "key": "cardNumber",
    "value": "1234123412341234"
   },
   {
    "key": "bankName",
    "value": "SuperBank"
   }
 ]
}'

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json

Examples

Responses

🟢200Order created successfully
application/json
Bodyapplication/json

🟠400Bad request
🟠401Unauthorized
🟠403Forbidden
🟠423Temporary error
🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://secure.PayStar.uk/api/v1/integration/withdrawal-order/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 100,
    "currency": "RUB",
    "externalTransactionId": "MerchID-{{$number.int(min=1)}}",
    "callbackUrl": "https://merch.com/callbackUrl",
    "additionalFields": [
        {
            "key": "cardNumber",
            "value": "1234123412341234"
        },
        {
            "key": "payeerIdentifier",
            "value": "Merch-12345"
        },
        {
            "key": "email",
            "value": "Jhon.Wick@Continental-Hotel.com"
        }
    ]
}'
Response Response Example
200 - Example 1
{
    "externalId": "a30288b2-220a-4495-9bcb-6821dcc39331",
    "orderStatus": "Created"
}
Previous
Deposit status H2H - Merch ID
Next
Payout status H2H - PayStar ID
Built with