Capture Payment

See the detailed API Reference for more information.

Why Capturing Payments Is Important

The Capture Payment call should be completed by merchants in parallel with shipping the order. This call triggers the invoice to be sent to the customer, with terms based on the payment method selected at checkout.

Merchants also have the option to perform a Partial Capture, which is especially useful when fulfilling an order in multiple shipments or when parts of an order need to be changed—without canceling or reprocessing the entire transaction.

Response Fields

CapturedAmount – Total amount successfully captured in this API call.
AuthorizedAmount – Original total amount of the order as specified during the AUTHORIZE call.
RemainingAuthorizedAmount – Amount still available for capture after this partial capture.
CaptureNumber – Unique identifier of this capture in Riverty’s system, required for refunds and further operations - Refer to this page for additional information on references.

Key Considerations

When Riverty receives an authorization request, the final outcome is either accepted or rejected. If accepted, the order is placed in a "reserved" state. It will only be finalized once a Capture or Cancel request is made. If no follow-up action is taken, the reservation will be automatically voided after 30 days, depending on the region.
Always provide your own unique reference in the _invoiceNumber_ field. If omitted, Riverty will generate an invoice number for communication with the customer. Inconsistent invoice numbers may cause confusion.
For partial captures, it is mandatory to include the specific order lines being captured in the request payload.

For full technical details, refer to the Capture Payment API documentation.

FAQ

What validation do you apply to the amount fields?

We support rounding differences. Please make sure that following applies:

TotalGrossAmount equals the sums of grossUnitPrice * Quantity for all line items
The rounding difference between grossUnitPrice and netUnitPrice + vatAmount may not be bigger then 1 Cent per quantity (e.g. you have a quantity of 2; we will allow a difference of 2 cents for grossUnitPrice versus netUnitPrice + vatAmount)
Same rounding difference logic also applied for the totalNetAmount

I do not have the imageUrl in my order management system. Is this a problem?

You do not need to send in productUrl and imageUrl if they are already part of the Authorize request and the same product id is used

Can I do multiple captures?

You can do multiple Partial Captures for the same order, as long as there is a balance left over in the Remaining Authorized Amount. Please make sure to send a unique invoiceNumber per capture.

Do you find this page helpful?