Create a deposit order
POST
/api/v1/integration/deposit-order/You can use this CURL to create a 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":
"externalTransactionId":
"successRedirectUrl":
"failedRedirectUrl":
"processingRedirectUrl":
"currency":
"additionalFields": [
{
"key":
"value":
}
]
}'
Request
Body Params application/json
amount
number
Order amount
Example:
100
currency
string
Order currency in ISO 4217 standard.
Examples:
EURUSDRUB
successRedirectUrl
string
URL address where the user will be redirected in case of a successful payment
Example:
http://merchantsite.com/success
processingRedirectUrl
string
URL address where the user will be redirected if the payment status is not yet determined at the time of execution
Example:
http://merchantsite.com/processing
failedRedirectUrl
string
URL address where the user will be redirected in case of an unsuccessful payment
Example:
http://merchantsite.com/failed
callbackUrl
string
Url for callback
Example:
http://google.com
externalTransactionId
string
Order ID in your system
Example:
Merch-bf95219b-393d-4323-91bf-639be
additionalFields
array [object {2}]
Additional fields. Required for some cases.
key
enum<string>
Key name
Allowed values:
BankNamePayeerIdentifierIPCardNumberCardCvvCardHolderCardExpireMonthCardExpireYearBrowserAcceptHeaderBrowserJavaEnabledBrowserJavascriptEnabledBrowserLanguageBrowserColorDepthBrowserScreenWidthBrowserScreenHeightbrowserTZBrowserUserAgentBrowserChallengeWindowSizeEmailTypeProductCode
value
enum<string>
Value name
Allowed values:
ALLSBPTINKSBER
Example
{
"amount": 100,
"currency": "USD",
"externalTransactionId": "Merch-bf95219b-393d-4323-91bf-639be",
"callbackUrl": "https://webhook.site/",
"processingRedirectUrl": "http://merchantsite.com/processing",
"failedRedirectUrl": "http://merchantsite.com/failed",
"successRedirectUrl": "http://merchantsite.com/success",
"additionalFields": [
{
"key": "CardNumber",
"value": "2202205300068092"
},
{
"key": "CardCvv",
"value": "583"
},
{
"key": "CardHolder",
"value": "JOHN WEAK"
},
{
"key": "CardExpireMonth",
"value": "05"
},
{
"key": "CardExpireYear",
"value": "26"
},
{
"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": "ru-RU"
},
{
"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"
},
{
"key": "PayeerIdentifier",
"value": "111112"
},
{
"key": "BankName",
"value": "SBER"
},
{
"key": "Email",
"value": "Jhon.Wick@Continental-Hotel.com"
},
{
"key": "Type",
"value": "card"
},
{
"key": "ProductCode",
"value": "s16001"
}
]
}
Request samples
Responses
Order created successfully(200)
Bad request(400)
Authorization error(401)
Forbidden: Your authorization is disabled or not properly configured - please contact the manager for consultation.(403)
Temporary error(423)
Internal 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(500)
Order created successfully
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
externalId
string
Order ID in our system
Example:
PSP-bf95219b-393d-4323-91bf-639ac
orderStatus
enum<string>
Сurrent order status
Allowed values:
CreatedProcessingSuccessFailed
paymentDetails
object | null
optional
formUrl
string | null
Payment form URL
Example:
payment.com/form
number
string | null
Phone number
Example:
380961234567
fio
string | null
Full name
Example:
John Wick
amount
string | null
Order amount
Example:
100
bank
string | null
Bank name
Example:
ALL
card
string | null
Card number
Example:
123456789012
Example
p2p Order Success created
{
"externalId": "PSP-bf95219b-393d-4323-91bf-639ac",
"orderStatus": "Created",
"paymentDetails": {
"formUrl": "payment.com/form",
"amount": "100",
}
}
Last modified: a month ago