Create Hold

Method: POST
URL: BASE_URL/merchant/payment/hold/create/
Header:

Authorization: Bearer <ACCESS_TOKEN>

Request body

Field	Sample Data	Type	Required	Description
amount	1000	int	Yes	Amount in SUM (1000 = 1,000 SUM)
userId	123	string	No	User ID declared by the merchant
account	{"field_name": "sample data"}	dict	No	Send empty dict {} if no additional data
cardId	9f877739-bc25-4f0f-a13f-ec485fd04250	string	Yes	Card ID created in Paylov system
time	10	int	Yes	Hold time in minutes. Max: 40320 (28 days)
externalId	externalId1	string	No	External ID. Max length: 64 characters
serviceId	9f877739-bc25-4f0f-a13f-ec485fd04250	string	No	Provided by the Payment System

{
  "userId": "string",
  "cardId": "string",
  "amount": 10,  # 10 = 10 Sum
  "account": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "time": 10,
  "externalId": "string", # max_chars: 64
  "serviceId": "uuid" 
}

Field	Type	Required	Description
userId	string	Yes	The unique identifier for the user.
cardId	string	Yes	The unique identifier for the card used in the hold.
amount	integer	Yes	The amount to be held. (amount in sum)
account	object	No	Contains additional properties for the account.
account.additionalProp1	string	Optional	Custom account data.
account.additionalProp2	string	Optional	Custom account data.
account.additionalProp2	string	Optional	Custom account data.
time	integer	Yes	The duration of the hold in minutes. The maximum allowed value is 28 days (40320 minutes).

Success response

{
  "result": {
    "transactionId": "uuid4"
  }
}

Field	sample_data	Type	Description
transactionId	uuid4	string	The unique identifier for the user.