InstantTransfer
  1. Withdrawal direct (Merch)
InstantTransfer
  • PayStar API Documentation
    • Introduction
    • Authorization Bearer
    • Sandbox
    • Callbacks
    • Glossary
    • Dictionarys
      • Currencys
      • Telecom operators
      • Bank names
    • Deposit direct (Merch)
      • Create | Deposit order
      • Check status | Deposit order
    • Deposit reverse (Gateway)
      • Create | Reverse deposit order
      • Check status | Deposit order
    • Withdrawal direct (Merch)
      • Create | Withdrawal order
        POST
      • Check status | Withdrawal order
        GET
    • Balance
      • GET Merchant balance
  • Armax API
    • POST Armax Order
      POST
  • Butler API Bridge
    • Authorization Bearer
    • Withdrawal direct | PDO API Bridge
      • Check status | Withdrawal order
      • Create | Withdrawal Order
    • PSP Deposit Order
      • PSP Deposit Order
      • PSP Deposit Order status
    • Merch Deposit Order
      • Merch Deposit Order
      • Merch Deposit Order status
  • CoreFy API
    • Withdrawal Order
      POST
    • Payment Order
      POST
  • PayNetEasy API Bridg
    • Introduсtion
    • Autorization
    • Glossary
    • POST order
      POST
    • POST Status order
      POST
  1. Withdrawal direct (Merch)

Create | Withdrawal order

POST
/api/v1/integration/withdrawal-order/
You can use this CURL to create a Withdrawal order.
curl --request POST \
--url https://baseurl.com/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": "сardNumber"
    "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

Example
{
    "amount": 100,
    "currency": "USD",
    "externalTransactionId": "Merch-bf95219b-393d-4323-91bf-639be",
    "callbackUrl": "https://merch.com/callbackurl",
    "additionalFields": [
        {
            "key": "productCode",
            "value": "Merch-12345"
        }, 
        {
            "key": "phoneNumber",
            "value": "+33644012345"
        },
        {
            "key": "telecomOperator",
            "value": "Chack the list of availeble telecomOperator"
        },  
        {
            "key": "payeerIdentifier",
            "value": "1Merch-12345"
        },
        {
            "key": "email",
            "value": "Jhon.Wick@Continental-Hotel.com"
        },
        {
            "key": "cardNumber",
            "value": "1234123412341234"
        },
        {
            "key": "cardHolder",
            "value": "JOHN WEAK"
        },
        {
            "key": "cardCvv",
            "value": "583"
        },
        {
            "key": "cardExpireMonth",
            "value": "05"
        },
        {
            "key": "cardExpireYear",
            "value": "26"
        },
        {
            "key": "bankName",
            "value": "Chack the list of availeble bankName"
        }

    ]
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v1/integration/withdrawal-order/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 100,
    "currency": "USD",
    "externalTransactionId": "Merch-bf95219b-393d-4323-91bf-639be",
    "callbackUrl": "https://merch.com/callbackurl",
    "additionalFields": [
        {
            "key": "productCode",
            "value": "Merch-12345"
        }, 
        {
            "key": "phoneNumber",
            "value": "+33644012345"
        },
        {
            "key": "telecomOperator",
            "value": "Chack the list of availeble telecomOperator"
        },  
        {
            "key": "payeerIdentifier",
            "value": "1Merch-12345"
        },
        {
            "key": "email",
            "value": "Jhon.Wick@Continental-Hotel.com"
        },
        {
            "key": "cardNumber",
            "value": "1234123412341234"
        },
        {
            "key": "cardHolder",
            "value": "JOHN WEAK"
        },
        {
            "key": "cardCvv",
            "value": "583"
        },
        {
            "key": "cardExpireMonth",
            "value": "05"
        },
        {
            "key": "cardExpireYear",
            "value": "26"
        },
        {
            "key": "bankName",
            "value": "Chack the list of availeble bankName"
        }

    ]
}'

Responses

🟢200Order created successfully
application/json
Body

Example
{
    "externalId": "PSP-bf95219b-393d-4323-91bf-639ac",
    "orderStatus": "Created"
}
🟠400Bad request
🟠401Authorization error
🟠403Forbidden: Your authorization is disabled or not properly configured - please contact the manager for consultation.
🟠423Temporary error
Modified at 2024-12-12 13:18:26
Previous
Withdrawal direct (Merch)
Next
Check status | Withdrawal order
Built with