PApaymongo
Holds

Open a hold

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.

post/v1/holds

Request

  • Base URL
    https://inventories-api.paymongo.com
  • URL
    https://inventories-api.paymongo.com/v1/holds
  • Auth
    • HTTP basic
    • or HTTP bearer

Request body

expires_atinteger
livemodeboolean

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

reasonstring required

Example request

{
  "expires_at": 1752086400,
  "lines": [
    {
      "inventory_item_id": "invitem_abc123",
      "quantity": 2
    }
  ],
  "livemode": true,
  "reason": "checkout"
}

Response

OK

has_moreboolean

Example response

{
  "data": {
    "closed_at": 1752086400,
    "created_at": 1752000000,
    "expires_at": 1752086400,
    "id": "hold_abc123",
    "lines": [
      {
        "id": "holdline_abc123",
        "inventory_item_id": "invitem_abc123",
        "quantity": 2
      }
    ],
    "livemode": true,
    "reason": "checkout",
    "state": "open",
    "updated_at": 1752000000
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.