Webhook for payment disbursement through wire transfer

September 26, 2024

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`	`"CA" "CC"`
`accountNumber`	`string`
`publicCredentialId`	`string`
`transactionId`	`string`
`token`	`string`
`bankId`	`string`
`credentialId`	`string`
`kushkiAmount`	`number`
`documentType`	`"CC" "NIT" "CE" "TI" "PP"`
`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`
`currency`	`"COP"`
`metadata`	`object`
`metadata.ref1`	`string`
`metadata.ref2`	`string`
`metadata.ref3`	`string`
`transactionReference`	`string`

Examples

JSON
JSON

// Approved Transaction
{
  "country": "Colombia",
  "ticketNumber": "1602088278680851",
  "amount": {
    "subtotalIva0": 10000,
    "iva": 0,
    "subtotalIva": 0,
    "extraTaxes": {
      "agenciaDeViajes": 0,
      "iac": 0,
      "propina": 0,
      "tasaAeroportuaria": 0
    }
  },
  "documentType": "CC",
  "transactionStatus": "APPROVAL",
  "created": 1602088271751,
  "documentNumber": "123456789",
  "processorType": "gateway",
  "accountType": "CA",
  "kushkiAmount": 0,
  "accountNumber": "123456",
  "transactionId": "e56c6344-d6be-4702-83f8-ea758188c6f6",
  "merchantName": "Tu Gran Empresa",
  "token": "4b680bc3d3214071910af2d08ec33af3",
  "transactionType": "PAYOUT",
  "totalAmount": 10000,
  "bankId": "000051",
  "processorId": "600000000015XXXXXXXXXXXX18652",
  "merchantId": "20000000XXXXXXX2000",
  "currency": "COP",
  "transactionReference": "e56c6344-d6be-4702-83f8-ea758188c6f6"
}

// Declined Transaction
{
  "country": "Colombia",
  "ticketNumber": "1602088434652337",
  "amount": {
    "subtotalIva0": 10000,
    "iva": 0,
    "subtotalIva": 0,
    "extraTaxes": {
      "agenciaDeViajes": 0,
      "iac": 0,
      "propina": 0,
      "tasaAeroportuaria": 0
    }
  },
  "documentType": "CC",
  "transactionStatus": "DECLINED",
  "responseCode": "084",
  "responseText": "Cuenta no vigente",
  "created": 1602088427391,
  "documentNumber": "999999990",
  "processorType": "gateway",
  "accountType": "CA",
  "kushkiAmount": 0,
  "accountNumber": "123456",
  "transactionId": "5b0a04be-3d42-4935-af2e-ffda5b8ee1de",
  "merchantName": "Tu Gran Empresa",
  "token": "80f9b1bf314d4d3b9c6e7b36d8c81216",
  "transactionType": "PAYOUT",
  "totalAmount": 10000,
  "bankId": "000051",
  "processorId": "600000000015XXXXXXXXXXXX18652",
  "merchantId": "20000000XXXXXXX2000",
  "currency": "COP",
  "transactionReference": "5b0a04be-3d42-4935-af2e-ffda5b8ee1de"
}