Skip to main content
The CaptureRequest object is used to capture funds from a previously authorized payment.

Properties

FieldTypeRequiredDescription
captureAmountintegerAmount to capture in the smallest currency unit
Notes: Minimum value: 1, If omitted full authorization amount is captured, Cannot exceed originally authorized amount

Usage

Full Capture: Omit the captureAmount field to capture the entire authorized amount.Partial Capture: Include captureAmount to capture a specific amount.

Example - Full Capture

{}

Example - Partial Capture

{
  "captureAmount": 750
}

Business Rules

  • Capture can only be performed on authorized payments
  • Capture amount cannot exceed the authorized amount
  • Multiple partial captures are allowed until the full amount is captured
  • Once captured, funds are transferred to the merchant