Webhook for payment disbursement through wire transfer

Structure

The webhooks sent by Kushki will contain the headers listed here.

These are the possible variables that are submitted in the Webhook body:

Method: POST

Body: Object

Variable	Type
`country`	`string`
`amount`	`object`
`amount.subtotalIva0`	`number`
`amount.iva`	`number`
`amount.subtotalIva`	`number`
`amount.extraTaxes`	`object`
`amount.extraTaxes.propina`	`number`
`amount.extraTaxes.tasaAeroportuaria`	`number`
`amount.extraTaxes.agenciaDeViajes`	`number`
`amount.extraTaxes.iac`	`number`
`accountType`	`"CB"`
`accountNumber`	`string`
`publicCredentialId`	`string`
`transactionId`	`string`
`token`	`string`
`bankId`	`string`
`name`	`string`
`credentialId`	`string`
`kushkiAmount`	`number`
`documentType`	`"CURP" "RFC"`
`documentNumber`	`string`
`processorType`	`string`
`created`	`number`
`transactionStatus`	`"APPROVAL"`, `"DECLINED"`
`transactionType`	`"PAYOUT"`
`merchantId`	`string`
`responseText`	`string`
`responseCode`	`string`
`credentialInfo`	`object`
`credentialInfo.credentialAlias`	`string`
`credentialInfo.credentialMetadata`	`object`
`credentialInfo.credentialId`	`string`
`merchantName`	`string`
`credentialAlias`	`string`
`ticketNumber`	`string`
`totalAmount`	`number`
`processorId`	`string`
`kushkiFee`	`object` Kushki service rates
`kushkiFee.surcharge`	`number`
`kushkiFee.totalAmount`	`number`
`kushkiFee.variableFee`	`number`
`kushkiFee.maximumAmount`	`number`
`kushkiFee.minimumAmount`	`number`
`kushkiFee.discountAmount`	`number`
`kushkiFee.fixedFee`	`number`
`processorName`	`string`
`currency`	`"MXN"`
`metadata`	`object`
`metadata.processorStatus`	`string`
`metadata.processorStatusDescription`	`string`
`metadata.ref1`	`string`
`metadata.ref2`	`string`
`metadata.ref3`	`string`
`transactionReference`	`string`

Examples

JSON

// Transacción aprobada
{
   "country": "Mexico",
   "ticketNumber": "1648580447848870",
   "metadata": {
       "processorStatus": "LIQUIDADO",
       "contractID": "AB123",
       "processorStatusDescription": null
   },
   "documentType": "RFC",
   "documentNumber": "KUSHKI12345",
   "processorType": "aggregator_gateway",
   "responseText": "Transacción aprobada",
   "merchantName": "Tu Comercio",
   "responseCode": "000",
   "credentialAlias": "Postman",
   "processorId": "6000000000164745263355215877169",
   "kushkiFee": {
       "surcharge": 0,
       "totalAmount": 0,
       "variableFee": 0,
       "maximumAmount": 0,
       "minimumAmount": 0,
       "discountAmount": 0,
       "fixedFee": 0
   },
   "merchantId": "20000000104096130000",
   "credentialInfo": {
       "credentialAlias": "Postman",
       "credentialMetadata": {},
       "credentialId": "f88698f7208c49dbb5a53cdf79b9dca1"
   },
   "currency": "MXN",
   "processorName": "Transfer Processor",
   "amount": {
       "subtotalIva0": 0.6,
       "iva": 0,
       "subtotalIva": 0,
       "extraTaxes": {
           "agenciaDeViajes": 0,
           "propina": 0,
           "iac": 0,
           "tasaAeroportuaria": 0
       }
   },
   "transactionReference": "55971ac1-1f41-4620-10b7-5e67a7416ab2",
   "transactionStatus": "APPROVAL",
   "created": 1648580431970,
   "accountType": "CB",
   "kushkiAmount": 0,
   "accountNumber": "646280140400000007",
   "publicCredentialId": "a011c73bc43144c4b83df2c37a563de2",
   "transactionId": "55971ac1-1f41-4620-10b7-5e67a7416ab2",
   "token": "97695ca609d94736801d3a443ba11c5a",
   "transactionType": "PAYOUT",
   "totalAmount": 0.6,
   "bankId": "0074",
   "name": "John Doe",
   "credentialId": "f88698f7208c49dbb5a53cdf79b9dca1"
}

Webhook for payment disbursement through wire transfer

Structure#

Examples#

Structure

Examples