Skip to Main Content
Riverty Docs
  • Get Started
  • Login
riverty logo Docs

Void Authorization

Void (cancel) an authorization that has not been captured.

More information can be found in our Documentation.

Path

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

Request Parameters

orderNumber
required
string
Order number

Request Body

application/json

required
object
Order details
parentTransactionReference
string
Max length: 128
A unique reference provided to Riverty by a third party (merchant or Payment Service Provider). Identifies an entire order.
merchantId
string
Max length: 50
Optional field. Used only in specific setups where merchant-specific profiles are required. Most integrations do not need this field.

Responses

  • 401 Authorization has been denied for this request.
  • 413 Request body too large.
  • 429 Too many requests.
  • 500 Internal server error.
Successful Request, Full VoidSuccessful Request, Partial VoidUnsuccessful Request, Order Already Captured

Request Example

    
        null
    

Response Example

    
        {
 "totalCapturedAmount": 0,
 "totalRefundedAmount": 0,
 "totalAuthorizedAmount": 185,
 "remainingAuthorizedAmount": 0
}