Webhook for payment disbursement through wire transfer
November 23, 2023
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 | "CC" "CA" "CM" |
accountNumber | string |
publicCredentialId | string |
transactionId | string |
token | string |
bankId | string |
credentialId | string |
kushkiAmount | number |
documentType | "DNI" "CE" "PAS" "RUC" |
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 | "PEN" |
metadata | object |
metadata.ref1 | string |
metadata.ref2 | string |
metadata.ref3 | string |
transactionReference | string |
Examples
- JSON
- JSON
// Approved Transaction{"country": "Peru","ticketNumber": "1687371461822490","amount": {"subtotalIva0": 30,"iva": 0,"subtotalIva": 0,"extraTaxes": {"agenciaDeViajes": 0,"iac": 0,"propina": 0,"tasaAeroportuaria": 0}},"documentType": "DNI","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": "f514382a15494a0881e96eb638cfd91d","transactionType": "PAYOUT","totalAmount": 30,"bankId": "002","processorId": "600000000015XXXXXXXXXXXX18652","merchantId": "20000000XXXXXXX2000","currency": "PEN","processorName": "BCP Processor","transactionReference": "e56c6344-d6be-4702-83f8-ea758188c6f6"}
// Declined Transaction{"country": "Peru","ticketNumber": "1687371461822490","amount": {"subtotalIva0": 30,"iva": 0,"subtotalIva": 0,"extraTaxes": {"agenciaDeViajes": 0,"iac": 0,"propina": 0,"tasaAeroportuaria": 0}},"documentType": "DNI","transactionStatus": "DECLINED","responseCode": "","responseText": "","created": 1602088427391,"documentNumber": "123456789","processorType": "gateway","accountType": "CA","kushkiAmount": 0,"accountNumber": "123456","transactionId": "5b0a04be-3d42-4935-af2e-ffda5b8ee1de","merchantName": "Tu Gran Empresa","token": "f514382a15494a0881e96eb638cfd91d","transactionType": "PAYOUT","totalAmount": 30,"bankId": "002","processorId": "600000000015XXXXXXXXXXXX18652","merchantId": "20000000XXXXXXX2000","currency": "PEN","processorName": "BCP Processor","transactionReference": "5b0a04be-3d42-4935-af2e-ffda5b8ee1de"}