Webhook for One-Time Payments by Wire Transfer

Wire Transfers

As the final phase of the wire transfer payment reception process, Kushki offers you the possibility of sending events to the webhook notifying your application when a wire transfer payment is completed.

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

VariableType
amountobject
amount.subtotalIva0integer
amount.ivainteger
amount.subtotalIvainteger
amount.icenumber
amount.currencystring
amount.extraTaxesobject
amount.extraTaxes.agenciaDeViajesnumber
amount.extraTaxes.propinanumber
amount.extraTaxes.iacnumber
amount.extraTaxes.tasaAeroportuarianumber
processorState"OK" "NOT_AUTHORIZED" "FAILED"
documentTypestring
createdinteger (Unix Timestamp Format)
documentNumberstring
transactionCyclestring
paymentDescriptionstring
responseCodestring
tokenstring
publicMerchantIdstring
returnCodestring
bankIdstring
userIpstring
userTypestring “Persona Natural” (0) o “Persona Jurídica” (1)
trazabilityCodestring
statusstring
completedAtnumber (Unix Timestamp Format)
countrystring
ticketNumberstring
metadataobject
metadata.key0string
metadata.key1string
metadata.key2string
serviceCodestring
processorTypestring
responseTextstring
transferProcessorstring
entityCodestring
processorIdstring
bankurlstring
callbackUrlstring
currencystring
sessionIdstring
userIdstring
emailstring
processorTokenstring
signatureTokenstring
termsUrlstring

Examples

  • JSON
  • JSON
  • JSON
// Approved Transaction
{
"country": "Ecuador",
"ticketNumber": "1600791090789584",
"metadata": {
"userId": "IB344"
},
"documentType": "NIT",
"serviceCode": null,
"documentNumber": "1716458334",
"transferProcessor": "SafetyPay Processor",
"merchantName": "DaN Comercio",
"processorId": "6000000000160079103702947108435",
"bankurl": "https://uat-sandbox.kushkipagos.com/checkout/transfer?status=pending&identificationType=NIT&identificationNumber=1716458334&description=&referenceNumber=1600791090789584&bankName=Kushki bank México&bankCode=0005&amount=100000&cus=675989749&ticketNumber=1600791090789584&processor=SafetyPay Processor",
"callbackUrl": "https://t72ajthpqukj.runscope.net",
"currency": "USD",
"trazabilityCode": "675989749",
"email": "kushki@kushki.com",
"amount": {
"subtotalIva0": 100000,
"iva": 0,
"subtotalIva": 0,
"extraTaxes": {
"agenciaDeViajes": 0,
"iac": 0,
"propina": 0,
"tasaAeroportuaria": 0
}
},
"completedAt": 1600791096885,
"entityCode": null,
"transactionReference": "1abb9e2f-f051-4246-a48a-0a82f73d5626",
"created": 1600791077909,
"sessionId": "-",
"userId": "-",
"paymentDescription": "Description of the payment.",
"token": "f7dfb91323b743e6a4e705bbfc7dd899",
"publicMerchantId": "20000000********0000",
"bankId": "0005",
"userIp": "35.193.164.95",
"userType": "1",
"status": "approvedTransaction"
}
// Transacción declinada
{
"country": "Colombia",
"metadata": {
"userId": "IB344"
},
"processorState": "NOT_AUTHORIZED",
"documentType": "NIT",
"serviceCode": "9010003304",
"documentNumber": "100000002",
"processorType": "gateway",
"transferProcessor": "Pse Processor",
"merchantName": "Tu Gran Empresa",
"responseCode": "NOT_AUTHORIZED",
"returnCode": "SUCCESS",
"processorId": "6000000000158776276390266094439",
"bankurl": "https://uat-sandbox.kushkipagos.com/checkout/transfer?status=pending&identificationType=NIT&identificationNumber=100000002&description=Description of the payment.&referenceNumber=1601932114853069&bankName=&bankCode=1022&amount=10&cus=953738118&ticketNumber=1601932114853069&processor=Pse Processor",
"callbackUrl": "https://t72ajthpqukj.runscope.net",
"currency": "COP",
"trazabilityCode": "953738118",
"email": "kushki@kushki.com",
"amount": {
"subtotalIva0": 100000,
"iva": 0,
"subtotalIva": 0,
"extraTaxes": {
"agenciaDeViajes": 0,
"iac": 0,
"propina": 0,
"tasaAeroportuaria": 0
}
},
"completedAt": 1601932115738,
"entityCode": "9010003304",
"transactionReference": "05590ecf-da75-4451-8e61-0aad66d5c935",
"created": 1601932106021,
"transactionCycle": "1",
"sessionId": "-",
"userId": "-",
"paymentDescription": "Description of the payment.",
"token": "532a4c82079448c7b6cb59e08734d670",
"publicMerchantId": "20000000********0000",
"bankId": "1022",
"userIp": "35.193.164.95",
"userType": "1",
"status": "declinedTransaction"
}
// Declined Transaction
{
"country": "Colombia",
"metadata": {
"userId": "IB344"
},
"processorState": "FAILED",
"documentType": "NIT",
"serviceCode": "9010003304",
"documentNumber": "1716458334",
"processorType": "gateway",
"transferProcessor": "Pse Processor",
"merchantName": "Tu Gran Empresa",
"responseCode": "FAILED",
"returnCode": "SUCCESS",
"processorId": "6000000000XXXXXXXXXX90266094439",
"bankurl": "https://uat-sandbox.kushkipagos.com/checkout/transfer?status=pending&identificationType=NIT&identificationNumber=1716458334&description=Description of the payment.&referenceNumber=1601930595984139&bankName=&bankCode=1022&amount=10&cus=602113330&ticketNumber=1601930595984139&processor=Pse Processor",
"callbackUrl": "https://t72ajthpqukj.runscope.net",
"currency": "COP",
"trazabilityCode": "602113330",
"email": "test@kushki.com",
"amount": {
"subtotalIva0": 100000,
"iva": 0,
"subtotalIva": 0,
"extraTaxes": {
"agenciaDeViajes": 0,
"iac": 0,
"propina": 0,
"tasaAeroportuaria": 0
}
},
"completedAt": 1601930601798,
"entityCode": "9010003304",
"transactionReference": "938f71d5-fc0e-417e-8f43-06a744acaa04",
"created": 1601930572648,
"transactionCycle": "1",
"sessionId": "-",
"userId": "-",
"paymentDescription": "Description of the payment.",
"token": "64f681eb6da84abfa568b38529ad8a5a",
"publicMerchantId": "20000000********0000",
"bankId": "1022",
"userIp": "35.193.164.95",
"userType": "1",
"status": "declinedTransaction"
}