InstantTransfer
  1. Deposit direct (Merch)
InstantTransfer
  • PayStar API Documentation
    • Introduction
    • Authorization Bearer
    • Sandbox
    • Callbacks
    • Glossary
    • Dictionarys
      • Currencys
      • Telecom operators
      • Bank names
    • Deposit direct (Merch)
      • Create | Deposit order
        POST
      • Check status | Deposit order
        GET
    • Deposit reverse (Gateway)
      • Create | Reverse deposit order
      • Check status | Deposit order
    • Withdrawal direct (Merch)
      • Create | Withdrawal order
      • Check status | Withdrawal order
    • 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. Deposit direct (Merch)

Create | Deposit order

POST
/api/v1/integration/deposit-order/

CURL Example | POST Deposit order#

curl --request POST \
 --url https://baseurl.com/api/v1/integration/deposit-order \
 --header 'Authorization: Bearer YOUR TOKEN' \
 --header 'Content-Type: application/json' \
 --header 'accept: text/plain' \
 --data '{
  "amount": 100
  "currency": "USD"
  "externalTransactionId": 
  "successRedirectUrl": "http://merch.com/success"
  "failedRedirectUrl": "http://merch.com/failed"
  "processingRedirectUrl": "http://merch.com/processing"
  "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",
    "processingRedirectUrl": "https://merch.com/processing",
    "failedRedirectUrl": "https://merch.com/failed",
    "successRedirectUrl": "https://merch.com/success",
    "additionalFields": [
        {
            "key": "type",
            "value": "card"
        },
        {
            "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"
        },     
        {
            "key": "ip",
            "value": "62.76.69.168"
        },
        {
            "key": "browserAcceptHeader",
            "value": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9"
        },
        {
            "key": "browserJavaEnabled",
            "value": "true"
        },
        {
            "key": "browserJavascriptEnabled",
            "value": "true"
        },
        {
            "key": "browserLanguage",
            "value": "en-EN"
        },
        {
            "key": "browserColorDepth",
            "value": "24"
        },
        {
            "key": "browserScreenWidth",
            "value": "1920"
        },
        {
            "key": "browserScreenHeight",
            "value": "1920"
        },
        {
            "key": "browserTZ",
            "value": "-180"
        },
        {
            "key": "browserChallengeWindowSize",
            "value": "03"
        },
        {
            "key": "browserUserAgent",
            "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.109 Safari/537.36"
        }

    ]
}

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/deposit-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",
    "processingRedirectUrl": "https://merch.com/processing",
    "failedRedirectUrl": "https://merch.com/failed",
    "successRedirectUrl": "https://merch.com/success",
    "additionalFields": [
        {
            "key": "type",
            "value": "card"
        },
        {
            "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"
        },     
        {
            "key": "ip",
            "value": "62.76.69.168"
        },
        {
            "key": "browserAcceptHeader",
            "value": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9"
        },
        {
            "key": "browserJavaEnabled",
            "value": "true"
        },
        {
            "key": "browserJavascriptEnabled",
            "value": "true"
        },
        {
            "key": "browserLanguage",
            "value": "en-EN"
        },
        {
            "key": "browserColorDepth",
            "value": "24"
        },
        {
            "key": "browserScreenWidth",
            "value": "1920"
        },
        {
            "key": "browserScreenHeight",
            "value": "1920"
        },
        {
            "key": "browserTZ",
            "value": "-180"
        },
        {
            "key": "browserChallengeWindowSize",
            "value": "03"
        },
        {
            "key": "browserUserAgent",
            "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.109 Safari/537.36"
        }

    ]
}'

Responses

🟢200Order created successfully
application/json
Body

Examples
{
    "externalId": "5eaf47eb-344c-4aeb-8651-494d649499b5",
    "orderStatus": "Processing",
    "paymentDetails": {
        "amount": "1000",
        "formUrl": "https://paystar.uk/p2p"
    }
}
🟠400Bad request
🟠401Authorization error
🟠403Forbidden: Your authorization is disabled or not properly configured - please contact the manager for consultation.
🟠423Temporary error
🔴500Internal Server Error: Errors 499+ occur in unforeseen circumstances. They are transient and not indicative of the order status. If you receive a 499+ error when creating a payment, we recommend checking the payment status using the following method: **/a
Modified at 2024-12-12 13:18:26
Previous
Deposit direct (Merch)
Next
Check status | Deposit order
Built with