Release Settlement

PATCH/api/pay/v1/orders/{orderId}/settlementId/{settlementId}/release

Releases a held split settlement for a specific order.

Notes:

This API can only be used for orders with split settlements.
Use the Create Orders API to create a split settlement order.

View as Markdown Open in ChatGPT Open in Claude Open in Perplexity

Requires Bearer token. Get token →

Path Parameters

Name	Type	Description
`orderId`	`string`required	The unique order identifier.
`settlementId`	`string`required	The unique split settlement identifier.

Request Body

Name	Type	Description
`release_amount`	`object`	The amount to release from the held settlement.
`value`	`integer`required	Amount in smallest currency unit (paisa).
`currency`	`string`required	Three-letter ISO 4217 currency code.

Response

Name	Type	Description
`data`	`object`
`order_id`	`string`
`merchant_order_reference`	`string`
`type`	`string`	Allowed values: `CHARGEREFUND`
`status`	`string`	Allowed values: `CREATEDPENDINGPROCESSEDAUTHORIZEDCANCELLEDATTEMPTEDFAILEDFULLY_REFUNDEDPARTIALLY_REFUNDED`
`merchant_id`	`string`
`order_amount`	`object`
`pre_auth`	`boolean`
`allowed_payment_methods`	`string[]`
`notes`	`string`
`purchase_details`	`object`
`payments`	`SplitPaymentObject[]`
`created_at`	`string`
`updated_at`	`string`
`integration_mode`	`string`	Allowed values: `SEAMLESSREDIRECT`
`payment_retries_remaining`	`integer`

Status Codes

`200`	Settlement released successfully.
`401`	Authentication failed — missing, expired, or invalid Bearer token.
`404`	The requested resource does not exist.
`422`	Unprocessable Entity — invalid release request.
`500`	An unexpected error occurred on the server.

Request

curl --request PATCH \
  --url https://pluraluat.v2.pinepg.in/api/pay/v1/orders/v1-250513055632-aa-rjIIWX/settlementId/v1-250513055632-aa-rjIIWX-ss-f/release \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "release_amount": {
    "value": 10000,
    "currency": "INR"
  }
}'

Run this request

Bearer token

Path parameters

orderId

settlementId

Request body (JSON)

Status:

200 OK

{
  "data": {
    "order_id": "v1-250513055632-aa-rjIIWX",
    "merchant_order_reference": "bc2ddc75-eebb-452c-a034-ba9a836ddf17",
    "type": "CHARGE",
    "status": "PROCESSED",
    "merchant_id": "111370",
    "order_amount": {
      "value": 21000,
      "currency": "INR"
    },
    "pre_auth": false,
    "allowed_payment_methods": [
      "CARD",
      "UPI",
      "NETBANKING",
      "POINTS",
      "WALLET"
    ],
    "notes": "order1",
    "purchase_details": {
      "customer": {
        "email_id": "[email protected]",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "192212",
        "country_code": "91",
        "mobile_number": "9876543210",
        "is_edit_customer_details_allowed": false
      },
      "merchant_metadata": {
        "key1": "DD",
        "key2": "XOF"
      },
      "split_info": {
        "split_type": "AMOUNT",
        "split_details": [
          {
            "split_merchant_id": "111370",
            "split_settlement_id": "v1-250513055632-aa-rjIIWX-ss-f",
            "amount": {
              "value": 10000,
              "currency": "INR"
            },
            "on_hold": false,
            "status": "RELEASED",
            "updated_at": "2025-05-13T05:58:15.960Z",
            "release_amount": {
              "value": 10000,
              "currency": "INR"
            }
          },
          {
            "split_merchant_id": "111370",
            "split_settlement_id": "v1-250513055632-aa-rjIIWX-ss-g",
            "amount": {
              "value": 2000,
              "currency": "INR"
            },
            "on_hold": true,
            "status": "HOLD",
            "updated_at": "2025-05-13T05:56:32.655Z"
          }
        ]
      }
    },
    "payments": [
      {
        "id": "v1-250513055632-aa-rjIIWX-cc-a",
        "merchant_payment_reference": "d1ec1a52-45fb-47be-bd7a-0e0d930f26b8",
        "status": "PROCESSED",
        "payment_amount": {
          "value": 21000,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "payment_option": {
          "card_details": {
            "card_type": "CREDIT",
            "network_name": "VISA",
            "issuer_name": "HDFC",
            "card_category": "",
            "country_code": "IND",
            "token_txn_type": "ALT_TOKEN",
            "last4_digit": "1091",
            "save": false,
            "is_native_otp_eligible": true
          }
        },
        "acquirer_data": {
          "approval_code": "831000",
          "acquirer_reference": "7471158294616880303814",
          "rrn": "513205569234",
          "is_aggregator": true
        },
        "created_at": "2025-05-13T05:56:56.703Z",
        "updated_at": "2025-05-13T05:57:10.422Z"
      }
    ],
    "created_at": "2025-05-13T05:56:32.655Z",
    "updated_at": "2025-05-13T05:58:15.963Z",
    "integration_mode": "SEAMLESS",
    "payment_retries_remaining": 9
  }
}