Create a Deposit (Pay-In) Deal

This endpoint creates a new deposit (pay-in) deal. The deal is initiated by the client and can include various parameters such as the amount, currency, client information, and payment type.
Upon success, a response containing the deal ID, status, and redirect URL will be returned.
Ensure that all required fields are included in the request body.

Body Params
number
required

Deal gross amount (how much money a client gives)

string
required

The currency in which the client will transfer money

string
required

The country the client is from (for cases when payment is made in international currency)

boolean

Deal is sbp, deprecated

string
required

Merchant invoice reference

string
required

Merchant client reference

uuid

ID from bank list

boolean

Trusted flag

string
required

Redirect to this URL when payment successfully completes

string
required

Redirect to this URL when payment fails

string
required

Redirect to this URL when the user presses the back button

string
enum
Defaults to p2p

Payment type / FPS

string

Client's payment details (optional)

fingerprint
object

Represents the fingerprint data of a client, including location and browser details.
This information is used to enhance security and identify the client’s device.

string
enum

Language code

Headers
string
required

Bearer token for authenticating the request. Example: Authorization: Bearer 123.

Responses

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "new",
  "url": "https://paymentgateway.com/redirect",
  "type": "p2p"
}
400

Invalid request. The deal was not created.
Possible reasons:

  • ERROR_ACCESS_TOKEN_INVALID — the access token is invalid. The error may have occurred during the token request or refresh process.
  • ERROR_INVALID_PUBLIC_KEY — authorization failed due to an invalid public key.
  • FEATURE_NOT_AVAILABLE_FOR_SELECTED_CURRENCY — the selected currency is not supported for this payment method.
  • ERROR_CURRENCY_NOT_SUPPORTED — the specified currency is not supported. Please contact technical support.

Example response:

{
  "error": "ERROR_ACCESS_TOKEN_INVALID",
  "message": "Access token is invalid.",
  "statusCode": 400
}

{
  "error": "ERROR_TOKEN_EXPIRED",
  "message": "Access token has expired.",
  "statusCode": 401
}
404

Invalid credentials.
Authorization failed due to an invalid account_id. The deal was not created.
Example response:

{
  "error": "ERROR_INVALID_CREDENTIALS",
  "message": "Invalid account_id.",
  "statusCode": 404
}

{
  "error": "DEAL_ALREADY_EXISTS",
  "message": "Deal with same invoiceId already exists.",
  "statusCode": 409
}
422

Validation error.
The deal was not created due to invalid request parameters.
Example response:

{
  "error": "ERROR_VALIDATION",
  "message": "Invalid request parameters.",
  "statusCode": 422
}
500

Internal server error. The deal was not created or its status may require verification.
Possible error types:

  • METHOD_ROUTING_ERROR — the deal was not created. You can retry the request.
  • CALCULATOR_ERROR-004 — the deal was not created due to an internal calculation error. Please contact technical support or your account manager.
  • Request timeout — the deal may have been created. Please verify the transaction status before retrying the request.

Example response:

{
  "error": "METHOD_ROUTING_ERROR",
  "message": "Internal routing error.",
  "statusCode": 500
}
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json