Void
In this type of transaction, the amount reserved by the Authorization transaction is released back to the credit card balance.
the authorization lifespan may vary depending on credit card type. For VISA, American Express and Mastercard, authorization may take up to 7 days. For Discover, up to 10 days. Authorizations may even take up to 30 days.
Partial Void (Partial Cancel Authorization) transaction. This transaction involves the partial release of the amount reserved by the Authorization transaction.
a “parent” transaction identifier must be passed with the transaction request.
In case none of the above is provided in the API request, the transaction will be declined.
In case none of the above is provided in the API request, the transaction will be declined.
Request Parameters
| Name | Type | Required | Description | |||||||||||||||||||||
| accountId | integer | ✓ | Platform Account identifier. must be greater than 0. | |||||||||||||||||||||
| amount | decimal | ✓ | Transaction amount. Value ≥ 0 (2 decimal places) Amount=0 can be passed with Partial Void transaction Type. | |||||||||||||||||||||
| billingAddress | object | optional | User Billing Address data object. | |||||||||||||||||||||
| billingOverride | object | optional | Data object that contains an array of billingFee objects. | |||||||||||||||||||||
| creditCard | object | conditional | Credit Card data object. Required in case Payment Method is Credit Card. | |||||||||||||||||||||
| ach | object | conditional | ACH data object. Required if payment method = ACH. | |||||||||||||||||||||
| currency | enum | ✓ | CurrencyTypeId. Available Values:
| |||||||||||||||||||||
| merchantData | object | optional | Merchant Data data object. | |||||||||||||||||||||
| entryMode | integer | optional | Nullable Transaction entry mode numerical value. | |||||||||||||||||||||
| paymentMethod | enum | ✓ | PaymentMethod enum values. Available Values:
| |||||||||||||||||||||
| processorData | object | optional | Processor Data data object. | |||||||||||||||||||||
| subAccountId | integer | ✓ | Sub-Account identifier. | |||||||||||||||||||||
| terminalId | string | optional | Terminal identifier. | |||||||||||||||||||||
| transactionMethod | enum | optional | transactionMethodId. Available Values:
| |||||||||||||||||||||
| type | enum | ✓ | transactionTypeId. Available Values:
| |||||||||||||||||||||
| originalTransaction | object | ✓ | Original Transaction data object. Required for Capture and Refund and Update and Void. |
//Void request example
{
"accountId": "Platform Account Id",
"amount": 13,
"billingAddress": {
"addressLine": "Address",
"city": "City Name",
"country": "USA",
"email": "email@mail.com",
"phoneNumber": "12346879",
"state": "FL",
"zipPostalCode": "123465798"
},
"billingOverride": [
{
"fixedAmount": "feeFixedAmount",
"id": "objectId",
"percentageAmount": "feePercentageAmount",
"sourceId": "feeSourceIdentifier",
"sourceType": "BillingAccountId",
"targetId": "feeTargetIdentifier",
"targetType": "BillingAccountId",
"reverse": "true",
"billingAmount": "billingAmountValue"
}
],
"creditCard": {
"number": "4111111111111111",
"expirationDate": "1225",
"nameOnCard": "Eleanor Johansson",
"type": "Visa",
"cvv": "123",
"tokenization": {
"type": "External"
}
},
"currency": "USD",
"merchantData": {
"freeText": "string",
"transactionDate": "dateTime",
"transactionDescription": "string",
"transactionId": "string"
},
"entryMode": "2",
"paymentMethod": "CreditCard",
"processorData": {
"dynamicDescriptor": "01919Z"
},
"subAccountId": "Sub-Account Id",
"terminalId": "string",
"transactionMethod": "RegularTransaction",
"type": "Void",
"originalTransaction": {
"transactionId": "Transaction Id",
"transactionType": "System"
}
}