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
merchantIdstring
transactionobject
transaction.countrystring
transaction.ticketNumberstring
transaction.approvalCodestring
transaction.forceRefundboolean
transaction.processorTypestring
transaction.responseTextstring
transaction.partialVoidboolean
transaction.contactPersonstring
transaction.binCardstring
transaction.terminalIdstring
transaction.requestAmountnumber
transaction.merchantNamestring
transaction.responseCodestring
transaction.saleTransactionTypestring
transaction.processorIdstring
transaction.saleTransactionTypestring
transaction.processorMerchantIdstring
transaction.uniqueCodestring
transaction.merchantIdstring
transaction.nitstring
transaction.syncModestring
transaction.processorNamestring
idstring
transaction.processorBankNamestring
transaction.saleTransactionReferencestring
transaction.emailstring
transaction.isSandboxTransactionboolean
transaction.amountobject
transaction.amount.ivanumber
transaction.amount.icenumber
transaction.amount.currencystring
transaction.amount.subtotalIvanumber
transaction.amount.subtotalIva0number
transaction.amount.extraTaxesobject
transaction.amount.extraTaxes.agenciaDeViajesnumber
transaction.amount.extraTaxes.iacnumber
transaction.amount.extraTaxes.propinanumber
transaction.amount.extraTaxes.tasaAeroportuarianumber
transaction.foreignCardboolean
transaction.visibilitystring
transaction.cardHolderNamestring
transaction.transactionReferencestring
transaction.transactionStatusstring
transaction.creatednumber (Unix Timestamp Format)
transaction.paymentBrandstring
transaction.cardTypestring
transaction.voidTicketNumberstring
transaction.saleCreatednumber (Unix Timestamp Format)
transaction.transactionIdstring
transaction.tokenstring
transaction.saleTicketNumberstring
transaction.transactionTypestring
transaction.lastFourDigitsstring
transaction.paymentMethodstring
transaction.approvedTransactionAmountnumber
transaction.currencyCodestring
transaction.saleApprovalCodestring
transaction.privateProcessorIdstring
aliasstring
eventstring
paymentMethodstring
urlstring
webhookIdstring
attributesobject
attributes.ApproximateReceiveCountstring
attributes.SentTimestampstring
attributes.SenderIdstring
ApproximateFirstReceiveTimestampstring

Example

  • JSON
// Void approved
{
"merchantId":"20000000102979650000",
"transaction":{
"country":"Colombia",
"ticketNumber":"661631286679018350",
"approvalCode":"005211",
"aurusTicketNumber":"521253402808032234",
"forceRefund":false,
"processorType":"gateway",
"responseText":"Approved transaction",
"partialVoid":false,
"contactPerson":"000",
"binCard":"400489",
"terminalId":"A000J154",
"requestAmount":1000,
"merchantName":"Your great company",
"responseCode":"000",
"saleTransactionType":"SALE",
"processorId":"1012311890879009295615952845327",
"processorMerchantId":null,
"uniqueCode":"15263056",
"merchantId":"20000000102979650000",
"nit":"9010003304",
"syncMode":"online",
"processorName":"Redeban Processor",
"id":"632cc65b-2220-4bfc-bcf3-80b9c31188f6",
"processorBankName":"000048",
"saleTransactionReference":"70c3977d-6658-4060-bfd5-3fa3f60b166d",
"email":"test@kushkipagos.com",
"isSandboxTransaction":false,
"amount":{
"subtotalIva0":1000,
"iva":0,
"subtotalIva":0,
"currency":"COP",
"ice":0
},
"foreignCard":false,
"visibility":"hidden",
"cardHolderName":"Juan Gómez",
"transactionReference":"632cc65b-2220-4bfc-bcf3-80b9c31188f6",
"transactionStatus":"APPROVAL",
"created":1631286681606,
"paymentBrand":"Visa",
"cardType":"credit",
"voidTicketNumber":"661631286679018350",
"saleCreated":1631286493000,
"transactionId":"111212534028080396",
"token":"r73sRw101231SytOuq189087QumqNDhU",
"saleTicketNumber":"621253400927822134",
"transactionType":"VOID",
"lastFourDigits":"0049",
"paymentMethod":"card",
"approvedTransactionAmount":1000,
"currencyCode":"COP",
"saleApprovalCode":"003976",
"privateProcessorId":"1012311890879656596915952845327"
},
"alias":"tarjeta",
"event":"approvedTransaction",
"paymentMethod":"card-chargeback",
"url":"https://hookb.in/OeXVVOa7VBiqOdYYOD91",
"webhookId":"84fbb356-bc96-4b75-99e6-4dc837904164",
"attributes":{
"ApproximateReceiveCount":"1",
"SentTimestamp":"1631286682313",
"SenderId":"AROARCHINE4T4ISC2XQDD:usrv-webhook-primary-transactionsTrigger",
"ApproximateFirstReceiveTimestamp":"1631286687313"
}
}