riverty logo

Docs

Capture Payment

Completes the payment that has been authorized. Typically done when the order is shipped. Can be a full or partial capture of the order amount.

More information can be found in our Documentation.

Path

POST /api/v3/orders/{orderNumber}/captures

Request Parameters

orderNumber required
string
Order number

Request Body

application/json

orderDetails
required
object
Order details
invoiceNumber
string > 20 Characters
Invoice number. The merchant may want to use internal invoice numbers, or let the Riverty generate one at random. This will show up in Riverty's portal. One order may have one or more invoices.
campaignNumber
integer
Invoice campaign number. The merchant may link multiple orders to a campaign they are running.
shippingDetails
array
Shipping information which includes shipping type, company and tracking ID
parentTransactionReference
string > 128 Characters
A unique reference provided to Riverty by a third party (merchant or Payment Service Provider). Identifies an entire order.
transactionReference
string > 100 Characters
A unique reference for each transaction (separate for transactions within an order), generated and provided to Riverty by a third party (merchant or Payment Service Provider). It is used to identify transactions during back-end settlement between Core systems and the PSP.
references
object

Responses

Successful Request, Full CaptureSuccessful Request, Partial CaptureUnsuccessful Request, Capture Amount Exceeds Authorized Amount

Response Example

    
        {
 "capturedAmount": 185,
 "authorizedAmount": 185,
 "remainingAuthorizedAmount": 0,
 "captureNumber": "800090089",
 "totalRefundedAmount": 0,
 "totalCapturedAmount": 185
}
    

Request Example

    
        null