Create a Deposit (Pay-In) Deal

post

https://secure.sandbox.platcore.io/deals/payin

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

amount

number

required

Deal gross amount (how much money a client gives)

currency

string

required

The currency in which the client will transfer money

country

string

required

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

sbp

boolean

Deal is sbp, deprecated

invoiceId

string

required

Merchant invoice reference

clientId

string

required

Merchant client reference

bankId

uuid

ID from bank list

trusted

boolean

Trusted flag

successUrl

string

required

Redirect to this URL when payment successfully completes

failUrl

string

required

Redirect to this URL when payment fails

backUrl

string

required

Redirect to this URL when the user presses the back button

type

string

enum

Defaults to p2p

Payment type / FPS

clientCard

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.

lang

string

enum

Language code

Headers

Authorization

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"
}

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

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

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

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully created a new deposit deal. Example response: JSON

400Invalid request, typically due to a missing or malformed parameter. Example response: JSON

401Authentication failed. This may happen due to the following reasons: Authentication is required but not provided. The access token has expired. Example response: JSON

409Conflict occurred because a deal with the same invoice ID already exists. Example response: JSON