Void Credit Authorization
Void an existing credit card authorization before capture
post
https://<PayEngine-host>
/api/payment/void

Sample Request / Response

Request
Response

Example Request

1
{
2
"id": "a447b0b8-0dbb-4e07-bfc2-c35bba8d71e8",
3
}
Copied!

Example Response

1
{
2
"data": {
3
"ID": "5de1f3f1-65c0-4363-9387-c59131e6fb6d",
4
"MerchantID": "b0ad3bfe-d8b2-4def-9840-6c8f2570d2ce",
5
"TransactionID": "e236488f-56f7-4c29-8809-5a3e1e663ff5",
6
"VoidResponse": {
7
"status": "PASS",
8
"responseCode": "1",
9
"responseMessage": "Transaction Void Successful",
10
"authCode": "224574",
11
"hostReferenceNumber": "7320666621",
12
"hostResponseCode": "100",
13
"taskID": "7320666621",
14
"transactionID": "7320555621",
15
"transactionTimestamp": "2022-06-13T17:53:22",
16
"transactionAmount": "0.01",
17
"processedAmount": "0.01",
18
"totalAmount": "0.01",
19
"addressVerificationCode": "",
20
"cardHolderVerificationCode": "N",
21
"cardType": "Mastercard",
22
"maskedCardNumber": "5xxxxxxxxxxx1344",
23
"customerReceipt": "<Printable Receipt>",
24
"merchantReceipt": "<Printable Receipt>"
25
}
26
}
27
}
Copied!
Webhook event: PAYMENT_VOIDED

Webhook Payload Example

1
{
2
event_uid: 'a8a27e7a91559581c5b48e020f9250bd',
3
event: 'PAYMENT_VOIDED',
4
data: {
5
account_id: '5e62f6da-8399-4ca7-a521-3ff27f6d9485',
6
payment_id: '5de1f3f1-65c0-4363-9387-c59131e6fb6d',
7
merchant_id: 'b0ad3bfe-d8b2-4def-9840-6c8f2570d2ce',
8
void_response: {
9
status: 'PASS',
10
taskID: '62076827',
11
authCode: 885680,
12
cardType: 'V',
13
responseCode: 'A0000',
14
voidedAmount: '0.01',
15
transactionID: '81960579',
16
customerReceipt: '',
17
merchantReceipt: '',
18
responseMessage: 'Success',
19
hostResponseCode: '00',
20
maskedCardNumber: '1111',
21
transactionAmount: '0.01',
22
hostReferenceNumber: '468581147130',
23
transactionTimestamp: '2022-06-13T18:19:23'
24
},
25
transaction_id: 'e236488f-56f7-4c29-8809-5a3e1e663ff5'
26
}
27
}
Copied!