Webhook for One-Time Payments made with a card

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

When a credit or debit card transaction is approved or rejected.

When a cancellation or credit card refund is approved

Payment Notification

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
`ticket_number`	`string`
`transaction_id`	`string`
`transaction_reference`	`string`
`amount`	`object`
`amount.subtotalIva0`	`number`
`amount.subtotalIva`	`number`
`amount.iva`	`number`
`amount.ice`	`number`
`amount.currency`	`string`
`metadata`	`object`
`metadata.key0`	`string`
`metadata.key1`	`string`
`metadata.key2`	`string`
`currency_code`	`string`
`transaction_type`	`"SALE"`
`transaction_status`	`"APPROVAL" "DECLINED"`
`created`	`number (Unix Timestamp Format)`
`sync_mode`	`string`
`merchant_id`	`string`
`processor_id`	`string`
`processor_name`	`string`
`last_four_digits`	`string`
`approval_code`	`string`
`request_amount`	`number`
`approved_transaction_amount`	`number`
`subtotal_iva0`	`number`
`subtotal_iva`	`number`
`iva_value`	`number`
`country`	`string`
`processor_type`	`string`
`response_code`	`string`
`card_holder_name`	`string`
`payment_brand`	`string`
`fullResponse`	`number`
`token_type`	`string`
`maskedCardNumber`	`string`
`tokenAlreadyUsed`	`boolean`
`transactionCardHolderName`	`string`
`transactionCardId`	`string`
`transactionEmail`	`string`
`transaction_details`	`object`
`transaction_details.cardType`	`string`
`transaction_details.binCard`	`string`
`transaction_details.processorBankName`	`string`
`transaction_details.isDeferred`	`string`
`transaction_details.lastFourDigitsOfCard`	`string`
`issuing_bank`	`string`
`foreign_card`	`boolean`
`response_text`	`string`
`ip`	`string`
`merchant_name`	`string`
`acquirerBank`	`string`
`card_type`	`string`
`token`	`string`
`credential_alias`	`string`
`processor_bank_name`	`string`
`bin_card`	`string`
`ice_value`	`string`
`credential_id`	`string`
`processorCode`	`string`
`processor`	`object`
`processor.code`	`string`
`processor.message`	`string`
`channel`	`string`
`interest_amount`	`string`
`mccCode`	`string`
`card_country`	`string`
`ignoreWarnings`	`boolean`
`bin_type`	`integer`
`integration`	`string`
`acquirer_bank`	`string`
`processor_merchant_id`	`string`
`security`	`object`
`security.whitelist`	`boolean`
`originalCommissionType`	`string`
`commission`	`object`
`commission.deferred`	`integer`
`commission.country`	`string`
`commission.iva`	`number`
`commission.merchantId`	`string`
`commission.fixAmount`	`number`
`commission.variableAmount`	`number`
`commission.type`	`string`
`commission.merchantName`	`string`
`parent_merchant_id`	`string`
`parent_ticket_number`	`string`
`plcc`	`boolean`
`commissionType`	`string`
`card_country_code`	`string`
`processor_transaction_id`	`string`
`KSH_LAMBDA_FUNCTION`	`string`
`KSH_AWS_REQUEST_ID`	`string`
`transactionReference`	`string`
`contactDetails`	`string`
`contactDetails`	`object`
`contactDetails.firstName`	`string`
`contactDetails.lastName`	`string`
`contactDetails.phoneNumber`	`string`
`contactDetails.documentType`	`string`
`contactDetails.documentNumber`	`string`
`contactDetails.email`	`string`
`publicMerchantId`	`string`
`merchantId`	`string`
`paymentMethod`	`string`
`syncMetadata`	`string`
`id`	`string`
`status`	`string`

Examples

JSON

// Approved transaction
{
  "country": "Colombia",
  "metadata": {
    "contractID": "157AB"
  },
  "processor_type": "gateway",
  "response_code": "000",
  "transaction_status": "APPROVAL",
  "card_holder_name": "TESTING",
  "payment_brand": "Visa",
  "request_amount": 16.98,
  "fullResponse": true,
  "merchant_id": "20000000XXXXXXXX2000",
  "approved_transaction_amount": 16.98,
  "productDetails": {
    "product": [
      {
        "quantity": 1,
        "price": 6990000,
        "id": "198952AB",
        "sku": "10101042",
        "title": "eBook Digital Services"
      },
      {
        "quantity": 1,
        "price": 9990000,
        "id": "198953AB",
        "sku": "004834GQ",
        "title": "eBook Virtual Selling"
      }
    ]
  },
  "token_type": "transaction-token",
  "maskedCardNumber": "438626XXXXXX7714",
  "currency_code": "USD",
  "transaction_details": {
    "cardType": "Visa",
    "binCard": "438626",
    "processorBankName": "0032~BANCO INTERNACIONAL",
    "isDeferred": "N"
  },
  "subtotal_iva": 0,
  "issuing_bank": null,
  "processor_id": "6000000000158776275865741143200",
  "processor_name": "Credibanco Processor",
  "foreign_card": true,
  "response_text": "Transacción aprobada",
  "transaction_reference": "55d28261-c446-4592-a8d6-17c20aee3bb0",
  "last_four_digits": "7714",
  "user_agent": "Go-http-client/1.1",
  "transaction_id": "781482485839103928",
  "approval_code": "000000",
  "amount": {
    "subtotalIva0": 16.98,
    "iva": 0,
    "subtotalIva": 0,
    "currency": "USD",
    "ice": 0
  },
  "created": 1601587937000,
  "ip": "35.193.164.95",
  "iva_value": 0,
  "merchant_name": "Tu Gran Empresa",
  "contact_details": {
    "firstName": "Diego",
    "lastName": "Cadena",
    "phoneNumber": "0988734644",
    "documentType": "CC",
    "documentNumber": "1009283738",
    "email": "test@test.com"
  },
  "acquirerBank": null,
  "card_type": null,
  "ticket_number": "992823152575262637",
  "transaction_type": "SALE",
  "token": "fca0fe160b5048aca584e30fbf652edf",
  "sync_mode": "online",
  "orderDetails": {
    "billingDetails": {
      "country": "Ecuador",
      "zipCode": "170402",
      "address": "Eloy Alfaro 139 y Catalina Aldaz",
      "city": "Quito",
      "phone": "0988734644",
      "name": "Diego Cadena",
      "region": "Pichincha"
    },
    "shippingDetails": {
      "country": "Ecuador",
      "zipCode": "170402",
      "address": "Eloy Alfaro 139 y Catalina Aldaz",
      "city": "Quito",
      "phone": "0988734644",
      "name": "Diego Cadena",
      "region": "Pichincha"
    },
    "siteDomain": "tuebook.com"
  },
  "credential_alias": "Kushki Test",
  "processor_bank_name": "0032~BANCO INTERNACIONAL",
  "bin_card": "438626",
  "ice_value": 0,
  "credential_id": "b18653307844446bbfcb4783d2711a47",
  "subtotal_iva0": 16.98,
  "transactionReference": "55d28261-c446-4592-a8d6-17c20aee3bb0"
}

Webhook for One-Time Payments made with a card

Payment Notification#

Structure#

Examples#

Payment Notification

Structure

Examples