InstantTransfer
  1. Deposit reverse (Gateway)
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
        POST
      • Check status | Deposit order
        GET
    • 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 reverse (Gateway)

Create | Reverse deposit order

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

CURL Example | POST Reverse 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": "GateWay12345"
  "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": "Gateway-bf95219b-393d-4323-91bf-639be",
    "callbackUrl": "https://merch.com/calbackurl",
    "additionalFields": [
        {
            "key": "CardNumber",
            "value": "1234123412341234"
        },
        {
            "key": "phoneNumber",
            "value": "+33644012345"
        },
        {
            "key": "email",
            "value": "Jhon.Wick@Continental-Hotel.com"
        },
        {
            "key": "productCode",
            "value": "s16001"
        },
        {
            "key": "telecomOperator",
            "value": "Chack the list of availeble telecomOperator"
        }

    ]
}

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/reverse' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 100,
    "currency": "USD",
    "externalTransactionId": "Gateway-bf95219b-393d-4323-91bf-639be",
    "callbackUrl": "https://merch.com/calbackurl",
    "additionalFields": [
        {
            "key": "CardNumber",
            "value": "1234123412341234"
        },
        {
            "key": "phoneNumber",
            "value": "+33644012345"
        },
        {
            "key": "email",
            "value": "Jhon.Wick@Continental-Hotel.com"
        },
        {
            "key": "productCode",
            "value": "s16001"
        },
        {
            "key": "telecomOperator",
            "value": "Chack the list of availeble telecomOperator"
        }

    ]
}'

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 reverse (Gateway)
Next
Check status | Deposit order
Built with