PayMongo HomeGuidesAPI ReferenceStart Building
API Reference

Open a hold

post
https://inventories-api.paymongo.com/v1/holds

Reserve quantities against one or more inventory items. Validation is all-or-nothing: if any line lacks availability, the whole hold is refused and nothing is held.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Hold to open; body carries livemode for S2S callers

Hold to open; checkout defaults expires_at to now+24h and accepts an earlier future value, judged on the server clock: up to a minute past now+24h is clamped to it, later is rejected with 422; order/pack forbid it, manual accepts an optional future value

integer
lines
array of objects
required
lines*
boolean

LiveMode is required for S2S callers; ignored for merchant secret-key callers.

string
required
Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?