Webhook para pagos únicos con transferencia bancaria

11 enero 2024

Transferencias

Como fase final del proceso de recepción de pagos con transferencia, Kushki te da la posibilidad de enviar eventos al webhook que notifiquen a tu aplicación cuando se complete un pago con transferencia.

Estructura

Los webhooks enviados por Kushki contendrán los encabezados (headers) aquí listados.
Estas son las posibles variables que se entregan en el webhook:

Método: POST

Body: Object

Variable	Tipo
`amount`	`object`
`amount.subtotalIva0`	`integer`
`amount.iva`	`integer`
`amount.subtotalIva`	`integer`
`amount.ice`	`number`
`amount.currency`	`string`
`amount.extraTaxes`	`object`
`amount.extraTaxes.agenciaDeViajes`	`number`
`amount.extraTaxes.propina`	`number`
`amount.extraTaxes.iac`	`number`
`amount.extraTaxes.tasaAeroportuaria`	`number`
`processorState`	`string` `OK` `NOT_AUTHORIZED` `FAILED`
`documentType`	`string`
`created`	`integer (Unix Timestamp Format)`
`documentNumber`	`string`
`transactionCycle`	`string`
`paymentDescription`	`string`
`responseCode`	`string`
`responseText`	`string`
`token`	`string`
`publicMerchantId`	`string`
`returnCode`	`string`
`bankId`	`string`
`userIp`	`string`
`userType`	`string` “Persona Natural” (0) o “Persona Jurídica” (1)
`trazabilityCode`	`string`
`status`	`string` `initializedTransaction` `approvedTransaction` `declinedTransaction` `expiredTransaction`
`completedAt`	`number (Unix Timestamp Format)`
`country`	`string`
`ticketNumber`	`string`
`metadata`	`object`
`metadata.key0`	`string`
`metadata.key1`	`string`
`metadata.key2`	`string`
`serviceCode`	`string`
`processorType`	`string`
`transferProcessor`	`string`
`entityCode`	`string`
`processorId`	`string`
`bankurl`	`string`
`callbackUrl`	`string`
`currency`	`string`
`sessionId`	`string`
`userId`	`string`
`email`	`string`
`processorToken`	`string`
`signatureToken`	`string`
`termsUrl`	`string`

Ejemplos

JSON
JSON

// Transacción aprobada
{
  "country": "Colombia",
  "ticketNumber": "3135812068015768",
  "metadata": {
    "userId": "IB344"
  },
  "documentType": "NIT",
  "serviceCode": null,
  "documentNumber": "1716458334",
  "processorType": "gateway",
  "transferProcessor": "SafetyPay Processor",
  "requestAmount": 9000,
  "merchantName": "Colombia",
  "credentialAlias": "Colombia",
  "processorId": "6000000000165289163175630825435",
  "credentialInfo": {
    "alias": "Colombia",
    "credentialId": "49939eeb24744cb7a6103ac64ad70c7e",
    "publicCredentialId": "b31557fcd8ca4e17820ce625b1c263a5"
  },
  "bankurl": "https://uat-sandbox.kushkipagos.com/checkout/transfer?status=pending&identificationType=NIT&identificationNumber=1716458334&description=&referenceNumber=3135812068015768&bankName=&bankCode=10322&amount=9000&cus=655117798&ticketNumber=3135812068015768&processor=SafetyPay Processor",
  "callbackUrl": "https://kushki.com",
  "currency": "COP",
  "trazabilityCode": "655117798",
  "email": "user@example.com",
  "amount": {
    "subtotalIva0": 9000,
    "iva": 0,
    "subtotalIva": 0,
    "extraTaxes": {
      "agenciaDeViajes": 0,
      "iac": 0,
      "tasaAeroportuaria": 0
    }
  },
  "completedAt": 1683135812740,
  "entityCode": null,
  "transactionReference": "0a82f882-7a52-4017-bcd4-4cb92077e995",
  "created": 1683135787298,
  "userAgent": "PostmanRuntime/7.29.2",
  "sessionId": "-",
  "publicCredentialId": "b31557fcd8ca4e17820ce625b1c263a5",
  "userId": "-",
  "paymentDescription": "Description of the payment.",
  "token": "96387bf4e4d4499a9101b50b0a5989df",
  "publicMerchantId": "20000000106541937000",
  "bankId": "10322",
  "credentialId": "49939eeb24744cb7a6103ac64ad70c7e",
  "userIp": "187.207.13.51",
  "userType": "1",
  "config": {
    "region": "us-east-1"
  },
  "status": "approvedTransaction"
}

// Transacción declinada 
{
  "country": "Colombia",
  "metadata": {
    "userId": "IB344"
  },
  "credentialMetadata": null,
  "documentType": "NIT",
  "documentNumber": "1716458334",
  "processorType": "gateway",
  "responseText": "Monto inválido",
  "transferProcessor": "Pse Processor",
  "merchantName": "Colombia",
  "responseCode": "T003",
  "credentialAlias": null,
  "credentialInfo": {
    "alias": "Colombia",
    "credentialId": "49939eeb24744cb7a6103ac64ad70c7e",
    "publicCredentialId": "b31557fcd8ca4e17820ce625b1c263a5"
  },
  "callbackUrl": "https://kushki.com",
  "currency": "COP",
  "email": "user@example.com",
  "amount": {
    "subtotalIva0": 9000,
    "iva": 0,
    "subtotalIva": 0,
    "extraTaxes": {
      "agenciaDeViajes": 0,
      "iac": 0,
      "tasaAeroportuaria": 0
    }
  },
  "completedAt": 1683135887526,
  "transactionReference": "bce86498-e660-4090-b111-51e33a75bc96",
  "created": 1683135875264,
  "userAgent": "PostmanRuntime/7.29.2",
  "sessionId": "-",
  "publicCredentialId": null,
  "userId": "-",
  "paymentDescription": "Description of the payment.",
  "token": "985ac507e9eb404e82e164f3f3f0e25d",
  "publicMerchantId": "20000000106541937000",
  "bankId": "10322",
  "credentialId": null,
  "userIp": "187.207.13.51",
  "userType": "1",
  "config": {
    "region": "us-east-1"
  },
  "status": "declinedTransaction"
}