Payout H2H

POST

https://secure.PayStar.uk/api/v1/integration/withdrawal-order/

Last modified:2025-04-29 19:32:13

INFO

This method is used to perform payouts.
Note: Deposits and payouts cannot share the same Authorization keys — they are two separate pipelines.

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",
 "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

amount

number

Order amount

required

Example:

100

currency

string

Order currency in ISO 4217 standard.

required

Examples:

EURUSDRUB

externalTransactionId

string

Order ID in your system

required

Example:

Merch-bf95219b-393d-4323-91bf-639be

callbackUrl

string

optional

additionalFields

array [object {2}] | null

Additional fields. Required for some cases.

optional

key

enum<string> | enum<null>

Key name

optional

Allowed values:

productCodephoneNumbertelecomOperatorpayeerIdentifieremailcardNumbercardHoldercardExpireYearcardExpireMonthcardCvvbankName

value

string | null

Value name

optional

Example:

123456789012

Example

{
  "amount": 100,
  "currency": "RUB",
  "externalTransactionId": "MerchID-{{$number.int(min=1)}}",
  "callbackUrl": "https://merch.com/callbackUrl",
  "processingRedirectUrl": "https://merch.com/processing",
  "failedRedirectUrl": "https://merch.com/failed",
  "successRedirectUrl": "https://merch.com/success",
  "additionalFields": [
    {
      "key": "cardNumber",
      "value": "1234123412341234"
    },
    {
      "key": "payeerIdentifier",
      "value": "Merch-12345"
    },
    {
      "key": "email",
      "value": "Jhon.Wick@Continental-Hotel.com"
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://secure.PayStar.uk/api/v1/integration/withdrawal-order/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 100,
    "currency": "RUB",
    "externalTransactionId": "MerchID-{{$number.int(min=1)}}",
    "callbackUrl": "https://merch.com/callbackUrl",
    "processingRedirectUrl": "https://merch.com/processing",
    "failedRedirectUrl": "https://merch.com/failed",
    "successRedirectUrl": "https://merch.com/success",
    "additionalFields": [
        {
            "key": "cardNumber",
            "value": "1234123412341234"
        },
        {
            "key": "payeerIdentifier",
            "value": "Merch-12345"
        },
        {
            "key": "email",
            "value": "Jhon.Wick@Continental-Hotel.com"
        }
    ]
}'

Responses

🟢200Order created successfully

application/json

Body

externalId

string

Order ID in our system

required

Example:

PSP-bf95219b-393d-4323-91bf-639ac

orderStatus

enum<string>

Сurrent order status

required

Allowed values:

CreatedProcessingSuccessFailed

Example

{
  "externalId": "a30288b2-220a-4495-9bcb-6821dcc39331",
  "orderStatus": "Created"
}

🟠400Bad request

🟠401Unauthorized

🟠403Forbidden

🟠423Temporary error

Modified at 2025-04-29 19:32:13

Deposit status H2H

Payout status H2H