Cancel
Request Parameters
Transaction Packet
| Name | Type | Required | Description | |||||||||||||||||||||
| accountId | integer | ✓ | Platform Account identifier. | |||||||||||||||||||||
| amount | decimal | ✓ | Transaction amount. Amount=0 can be passed with Cancel transaction type. | |||||||||||||||||||||
| billingaddress | object | optional | User Billing Address data object. | |||||||||||||||||||||
| originalTransaction | object | optional | Original Transaction data object. Required ONLY if transactionTypeId = 3 (Void) or 4 (Partial Void) or 5 (Capture) or 6 (Partial Capture) or 8 (Refund) or 9 (Partial Refund) or 12 (Cancel) or 13 (Adjustment) or 14 (Retrieval) or 15 (Representment) or 16 (Arbitration) or 17 (Reversal). | |||||||||||||||||||||
| creditCard | object | ✓ | Credit Card data object. | |||||||||||||||||||||
| currency | enum | ✓ | currencyTypeId Available Values:
| |||||||||||||||||||||
| entryMode | integer | optional | Nullable Transaction entry mode numerical value. | |||||||||||||||||||||
| merchantData | object | optional | Merchant Data data object. | |||||||||||||||||||||
| paymentMethod | enum | ✓ | paymentMethodTypeId Available Values:
| |||||||||||||||||||||
| paymentType | enum | optional | PaymentType enum values. Available Values:
| |||||||||||||||||||||
| processorData | object | ✓ | Processor Data data object. | |||||||||||||||||||||
| status | enum | ✓ | transactionStatusId Available Values:
| |||||||||||||||||||||
| subaccountId | integer | ✓ | Sub-Account identifier. | |||||||||||||||||||||
| terminalId | string | optional | Terminal identifier. | |||||||||||||||||||||
| transactionMethod | enum | optional | transactionMethodId Available Values:
| |||||||||||||||||||||
| type | enum | ✓ | transactionTypeId Available Values:
|
{
"accountId": "Platform Account Id",
"amount": 10,
"billingAddress": {
"addressLine": "Address",
"city": "City Name",
"country": "USA",
"email": "email@mail.com",
"phoneNumber": "12346879",
"state": "FL",
"zipPostalCode": "123465798"
},
"originalTransaction": {
"transactionId": "732000000002107745",
"transactionType": "merchant"
},
"creditCard": {
"bin": "411111",
"expirationDate": "1220",
"last4": "1111",
"nameOnCard": "Eleanor Johnson",
"type": "Visa"
},
"currency": "USD",
"entryMode": 99,
"merchantData": {
"freeText": "string",
"transactionDate": "dateTime",
"transactionDescription": "string",
"transactionId": "string"
},
"paymentMethod": "CreditCard",
"paymentType": "OneOff",
"processorData": {
"authorizationNumber": "A0101Z",
"avsResultIndication": "P",
"cvvResultIndication": "D",
"errorCode": "123",
"errorCodeDescription": "Error Code Description",
"transactionId": "Transaction ID"
},
"status": "Processed",
"subAccountId": "Sub-Account Id",
"terminalId": "string",
"transactionMethod": "RegularTransaction",
"type": "Cancel"
}