Capture Payment

See the detailed API Reference for more information.

Why Capture Payment Matters

The Capture Payment call should be made by merchants when shipping an order. Capturing triggers the customer’s invoice, which reflects the payment terms selected at checkout.

Merchants can also perform a Partial Capture, which is particularly useful when:

• Orders are shipped in multiple deliveries.
• Only part of an order is fulfilled.
• Adjustments are needed without canceling or reprocessing the entire transaction.

Response Fields

• CapturedAmount – The total amount successfully captured in this API call.
• AuthorizedAmount – The full order amount as originally submitted during the Authorize call.
• RemainingAuthorizedAmount – The amount still available for capture after this request.
• CaptureNumber – A unique identifier for this capture in Riverty’s system. Required for refunds and subsequent operations. See Transaction Reference Numbers for more details.

Key Considerations

1. Reservation state
   When Riverty receives an Authorize request, the final outcome is either accepted or rejected.

   • If accepted, the order is placed in a reserved state.
   • The reservation is finalized only when a Capture or Cancel request is submitted.
   • If no follow-up action occurs, the reservation will be automatically voided after 30 days.

2. Invoice numbers
   Always provide your own unique reference in the invoiceNumber field. If omitted, Riverty will generate one for customer communication. Using inconsistent invoice numbers may cause confusion.

3. Partial captures
   For partial captures, you must include the specific order lines being captured in the request payload.

Example Request

{
 "invoiceNumber": "Invoice123",
 "orderDetails": {
  "items": [
   {
    "imageUrl": "https://developer-sandbox.riverty.com/images/brown_wool_hat.jpg",
    "quantity": 1,
    "productId": "3323-BRN-M",
    "vatAmount": 4.79,
    "vatPercent": 19,
    "description": "Woolen hat, brown, Size M",
    "netUnitPrice": 25.21,
    "grossUnitPrice": 30
   },
   {
    "type": "ShippingFee",
    "quantity": 1,
    "productId": "SHIP",
    "vatAmount": 0.8,
    "vatPercent": 19,
    "description": "Shipping",
    "netUnitPrice": 4.2,
    "grossUnitPrice": 5
   }
  ],
  "totalNetAmount": 29.41,
  "totalGrossAmount": 35
 }
}

Example Request

{
 "captureNumber": "Invoice123",
 "capturedAmount": 35,
 "authorizedAmount": 185,
 "remainingAuthorizedAmount": 150
}