Void Order
This endpoint is for fully or partially void an order for an authorized (deferred payment request.
Resource URL
For live environment, please update the endpoint to https://api.optty.com
Headers
Key | Value |
---|---|
Content-Type | application/json |
Authorization | Bearer {GENERATED_ACCESS_TOKEN} |
Parameters
Request Parameters
Field | Type | Description | Required |
---|---|---|---|
voidReference | string | The reference for voiding request | Yes |
description | string | The description or reason for the voiding | No |
amount | numeric | The amount to be voided from the total order amount | Yes |
Response Parameters
Field | Type | Description | Required |
---|---|---|---|
voidReference | string | The reference passed for the voiding request | |
voidedId | string | The returned Id for the completion execution of the request | |
amount | numeric | The amount processed for the voiding operation |
Sample Request/Response
Last updated