Void

Void cancels a previously processed transaction before it is settled. All the responses have GeneralResponse section that informs about successful result or error. See Error Codes and Messages.

Request Body

application/json

Amount*number

Total amount of the original transaction to void.

PaymentType*string

Indicates electronic data capture (EDC) type.

ReferenceId*string

Alphanumeric SPIn transaction identifier of the original transaction to void.

Length1 <= length <= 50

PrintReceipt?string

Indicates if any of receipt copies should be printed after the transaction.

Value in"No" | "Both" | "Merchant" | "Customer"

GetReceipt?string

Indicates if any of receipt copies should be returned in response.

Value in"No" | "Both" | "Merchant" | "Customer"

MerchantNumber?|

Merchant number for multi-merchant environment. If not present in multi-merchant environment, transaction will be cancelled.

Formatint32

Range1 <= value <= 5

CaptureSignature?boolean

Indicates whether the payment terminal should prompt the customer to sign on the device screen.

GetExtendedData?boolean

Indicates whether extended transaction data should be returned or not.

IsReadyForIS?boolean

Indicates whether register is ready to receive intermediate status or not.

CallbackInfo?

Information for callback with transaction result.

ReconId?string

Used for reconciliation purposes. This field is applicable only for Fiserv North transactions and it is optional. It contains an alphanumeric reference ID that links the transaction to its corresponding settlement record in Fiserv.

Length1 <= length <= 10

IsvId?string

This is the unique identifier generated by iPOSpays for each ISV. It must be sent to associate the transaction and the merchant with the corresponding ISV.

Length1 <= length <= 16

Tpn?string

Terminal profile number. Can be used to identify the terminal in SPIn Proxy environment.

Length10 <= length <= 12

RegisterId?string

Terminal identifier for register. [Obsolete] Can be used to identify the terminal instead of Tpn in SPIn Proxy environment. Required if no Tpn.

Length2 <= length <= 50

Authkey?string

Merchant's authorization password. Required if no SPInToken.

Length10 <= length <= 10

SPInProxyTimeout?|

Timeout for processing transaction with SPIn proxy. If null, the default timeout will be used.

Formatint32

Range1 <= value <= 720

CustomFields?

A collection of custom fields in key-value format.

Response Body

`application/json`

curl -X POST "https://example.com/v2/Payment/Void" \  -H "Content-Type: application/json" \  -d '{    "Amount": 1,    "PaymentType": "Credit",    "ReferenceId": "d6c871b6a580",    "PrintReceipt": "No",    "GetReceipt": "No",    "MerchantNumber": null,    "CaptureSignature": false,    "GetExtendedData": true,    "IsReadyForIS": false,    "CallbackInfo": {      "Url": ""    },    "ReconId": "",    "IsvId": "",    "Tpn": "",    "RegisterId": "",    "Authkey": "",    "SPInProxyTimeout": null,    "CustomFields": {}  }'

{
  "GeneralResponse": {
    "HostResponseCode": "",
    "HostResponseMessage": "",
    "ResultCode": "0",
    "StatusCode": "0000",
    "Message": "",
    "DetailedMessage": "",
    "DelayBeforeNextRequest": null
  },
  "PaymentType": "Credit",
  "TransactionType": "",
  "Amounts": {
    "TotalAmount": null,
    "Amount": null,
    "TipAmount": null,
    "FeeAmount": null,
    "TaxAmount": null
  },
  "AuthCode": "",
  "ReferenceId": "",
  "InvoiceNumber": "",
  "SerialNumber": "",
  "BatchNumber": "",
  "TransactionNumber": "",
  "Voided": false,
  "Signature": "",
  "IPosToken": "",
  "Token": "",
  "RRN": "",
  "PNReferenceId": "",
  "MerchantNumber": null,
  "MerchantName": "",
  "ExtendedDataByApplication": {},
  "CardData": {
    "CardType": "None",
    "EntryType": "None",
    "Last4": "",
    "First4": "",
    "BIN": "",
    "ExpirationDate": "",
    "Name": "",
    "CardBrand": ""
  },
  "EMVData": {
    "ApplicationName": "",
    "AID": "",
    "TVR": "",
    "TSI": "",
    "IAD": "",
    "ARC": ""
  },
  "Receipts": {
    "Customer": "",
    "Merchant": ""
  },
  "L2L3ValidationError": {
    "Description": "",
    "PoNumber": "",
    "PurchaseIdentifier": "",
    "SummaryCommodityCode": "",
    "LineItemCount": "",
    "TaxAmount": "",
    "Quantity": "",
    "UnitOfMeasure": "",
    "UnitCost": "",
    "TaxRate": "",
    "DiscountAmount": "",
    "DebitCreditIndicator": "",
    "ExtLineAmount": "",
    "QuantityExpIndicator": "",
    "UnitPriceDecimal": ""
  },
  "AutoRentalValidationError": {
    "AdjustmentAmount": "",
    "AdjustmentAuditIndicatorCode": "",
    "AgreementReferenceNumber": "",
    "PickupAddress": "",
    "PickupCity": "",
    "PickupCountry": "",
    "PickupCountryCode": "",
    "PickupDate": "",
    "PickupLocation": "",
    "PickupRegionCode": "",
    "PickupState": "",
    "RentalDistance": "",
    "RentalDistanceUnitofMeasure": "",
    "RentalDuration": "",
    "RentalPeriod": "",
    "RentalRate": "",
    "RentalTime": "",
    "ReturnAddress": "",
    "ReturnDate": "",
    "ReturnLocationId": "",
    "ReturnRegionCode": "",
    "ReturnStateCountry": "",
    "ReturnTime": "",
    "ServiceMobile": "",
    "VehicleMake": "",
    "VehicleModel": ""
  }
}

{
  "GeneralResponse": {
    "ResultCode": "0",
    "StatusCode": "0000",
    "Message": "",
    "DetailedMessage": "",
    "DelayBeforeNextRequest": null
  }
}

Request Body

Response Body

200application/json

400application/json

Standard Void Response

DvPay Void Response

DvPay Lite Void Response

`application/json`

`application/json`