Webhook for Voids and Refunds

Voids and Refunds

Kushki can send events to your webhook notifying your application when one of the following events occurs:

  1. When a cancellation (void) is approved.
  2. When a refund is approved.

Structure

The webhooks sent by Kushki will contain the headers listed below.
These are the possible variables that are submitted in the webhook body:

Método: POST

Body: Object

VariableTipo
countrystring
integrationMethodstring
metadataobject
contractIDstring
credentialMetadatastring
aurusTicketNumberstring
processorTypestring
merchantNamestring
responseCodestring
credentialAliasstring
mccCodestring
saleTransactionTypestring
uniqueCodestring
merchantIdstring
nitstring
syncModestring
idstring
socialReasonstring
isSandboxTransactionboolean
foreignCard boolean
visibilitystring
transactionReferencestring
creatednumber (Timestamp format)
voidTicketNumberstring
transactionIdstring
saleTicketNumberstring
lastFourDigitsstring
taxIdstring
credentialIdstring
paymentMethodstring
saleApprovalCodestring
privateProcessorIdstring
ticketNumberstring
forceRefundboolean
responseTextTransacción aprobada
partialVoidboolean
contactPersonstring
binCardstring
terminalIdstring
requestAmountnumber
categoryMerchantstring
processorIdstring
processorMerchantIdstring
processorNamestring
saleTransactionReferencestring
emailstring
amountobject
amount.subtotalIva0number
amount.subtotalIva number
amount.ivanumber
amount.extraTaxesobject
currencystring
icenumber
cardCountrystring
cardHolderNamestring
transactionStatus"APPROVAL"
paymentBrandstring
cardTypestring
publicCredentialIdstring
saleCreatednumber (Timestamp format)
tokenstring
transactionType"VOID" "REFUND"
cardCountryCodestring
consortiumNamestring
approvedTransactionAmountnumber
currencyCodestring

Example

  • JSON
// Void approved
{
"country": "Mexico",
"integrationMethod": null,
"metadata": {
"contractID": "157AB"
},
"credentialMetadata": null,
"aurusTicketNumber": "300765709982529055",
"processorType": "aggregator_formal",
"merchantName": "Tu Comercio MX",
"responseCode": "000",
"credentialAlias": "Tu Comercio",
"mccCode": "5399",
"saleTransactionType": "SALE",
"uniqueCode": null,
"merchantId": "20000000104096460000",
"nit": "1209120000000",
"syncMode": "online",
"id": "f319be20-27d5-4faa-a4d4-b70b6ca55e0d",
"socialReason": "TU COMERCIO",
"isSandboxTransaction": true,
"foreignCard": true,
"visibility": "hidden",
"transactionReference": "f319be20-27d5-4faa-a4d4-b70b6ca55e0d",
"created": 1660062967307,
"voidTicketNumber": "661660062966165887",
"transactionId": "532095824159012674",
"saleTicketNumber": "300765709982529055",
"lastFourDigits": "5480",
"taxId": "1209120000000",
"credentialId": "c15718524c994d0dbc50c1bd03453cc2",
"paymentMethod": "card",
"saleApprovalCode": "000000",
"privateProcessorId": "6000000000165643753487118743",
"ticketNumber": "661660062966165887",
"forceRefund": false,
"responseText": "Transacción aprobada",
"partialVoid": false,
"contactPerson": "John Doe",
"binCard": "545195",
"terminalId": "1656437534581",
"requestAmount": 99.97,
"categoryMerchant": "Medium",
"processorId": "6000000000165643753414808509",
"processorMerchantId": "6000000000165643753448883050",
"processorName": "Kushki Acquirer Processor",
"saleTransactionReference": "f33a3887-d63d-42f0-8d57-3851942c100d",
"email": "test@test.com",
"amount": {
"subtotalIva0": 99.97,
"iva": 0,
"subtotalIva": 0,
"extraTaxes": {
"agenciaDeViaje": 0,
"iac": 0,
"tasaAeroportuaria": 0
},
"currency": "MXN",
"ice": 0
},
"cardCountry": "Ecuador",
"cardHolderName": "John Doe",
"transactionStatus": "APPROVAL",
"paymentBrand": "Master Card",
"cardType": "credit",
"publicCredentialId": "da2f03f0600e4a1d9e702c6096ae733e",
"saleCreated": 1660062956000,
"token": "c9192a20afd14cf885d339d772c8ca57",
"transactionType": "VOID",
"cardCountryCode": "EC",
"consortiumName": null,
"approvedTransactionAmount": 99.97,
"currencyCode": "MXN"
}