Card Payments

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 an authorization is made

When a capture is made

When a cancellation is made

When a reversal is made

When a balance inquiry is made

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`
`franchise`	`string` Allowed values: `VISA`, `MASTERCARD`, `PROSA` (PROSA only Mexico).
`metadata`	`object`
`metadata.key0`	`string`
`metadata.key1`	`string`
`metadata.key2`	`string`
`available`	`boolean`
`channel`	`string`
`public_credential_id`	`string`
`client_transaction_id`	`string`
`mcc`	`string`
`card_country`	`string`
`processor_name`	`string`
`transaction_reference`	`string`
`payment_method`	`string`
`card_details`	`object`
`card_details.prosa_info`	`object`
`card_details.reading_type`	`string`
`card_details.card_sequential`	`string`
`card_details.tlv`	`string`
`transaction_id`	`string`
`created`	`integer`
`merchant_name`	`string`
`transaction_type`	`string`
`processor`	`object`
`processor.code`	`string`
`processor.message`	`string`
`reference_number`	`string`
`tax_id`	`string`
`sync_mode`	`string`
`additional_info`	`object`
`additional_info.f7`	`string`
`additional_info.f63`	`string`
`additional_info.f11`	`string`
`additional_info.f37`	`string`
`additional_info.f32`	`string`
`additional_info.f62s2`	`string`
`subtotal_iva0`	`number`
`deferred`	`object`
`deferred.months`	`string`
`response_code`	`string`
`transaction_status`	`string`
`social_reason`	`string`
`payment_brand`	`string` Allowed values: `VISA`, `MASTERCARD`
`acquirer_bank`	`string`
`request_amount`	`number`
`merchant_id`	`string`
`merchant_category`	`string`
`acq_transaction_type`	`string`
`security`	`object`
`security.ip`	`string`
`security.user_agent`	`string`
`masked_credit_card`	`string`
`authorization_code`	`string`
`issuing_bank`	`string`
`processor_id`	`string`
`foreign_card`	`boolean`
`pos_details`	`object`
`pos_details.model`	`string`
`pos_details.location`	`object`
`pos_details.location.latitude`	`number`
`pos_details.location.longitude`	`number`
`pos_details.version`	`string`
`pos_details.brand`	`string`
`pos_details.terminal_id`	`string`
`last_four_digits`	`string`
`approval_code`	`string`
`amount`	`object`
`amount.extra_taxes`	`object`
`amount.currency`	`string`
`amount.subtotal_iva0`	`number`
`rules_response`	`object`
`rules_response.country`	`string`
`rules_response.commercial_executive`	`string`
`rules_response.business_category`	`string`
`rules_response.address`	`string`
`rules_response.city`	`string`
`rules_response.authorizer`	`object`
`rules_response.authorizer.authorizer_name`	`string`
`rules_response.authorizer.soft_descriptor`	`string`
`rules_response.authorizer.authorizer_bank_id`	`string`
`rules_response.authorizer.commerce_code`	`string`
`rules_response.authorizer.authorizer_type`	`string`
`rules_response.authorizer.retailer_id`	`string`
`rules_response.authorizer.authorizer_acquirer_bin`	`string`
`rules_response.authorizer.category_model`	`string`
`rules_response.authorizer.url`	`string`
`rules_response.authorizer.authorizer_alias`	`string`
`rules_response.authorizer.terminal_id`	`string`
`rules_response.contact_person`	`string`
`rules_response.merchant_name`	`string`
`rules_response.telephone`	`string`
`rules_response.mcc`	`string`
`rules_response.url`	`string`
`rules_response.zip_code`	`string`
`rules_response.tax_id`	`string`
`rules_response.province`	`string`
`rules_response.business_registration_id`	`string`
`rules_response.tcc`	`string`
`rules_response.total_amount`	`string`
`rules_response.business_line`	`string`
`rules_response.currency`	`string`
`rules_response.id`	`string`
`rules_response.acquirer_type`	`string`
`acq_transaction_scope`	`string`
`contact_details`	`object`
`contact_details.document_number`	`string`
`contact_details.document_type`	`string`
`acq_transaction_mode`	`string`
`card_type`	`string` Allowed values: `credit`, `debit`, `prepaid`
`ticket_number`	`string`
`card_country_code`	`string`
`credential_alias`	`string`
`bin_card`	`string`
`credential_id`	`string`
`cvm_type`	`string`
`approved_transaction_amount`	`number`
`transactionReference`	`string`

Examples

{
    "country": "Colombia",
    "franchise": "MASTERCARD",
    "metadata": {
    "transaccionCodigo": "1245",
    "type": "test",
    "transaccionId": "1234"
  },
    "available": true,
    "channel": "POS",
    "public_credential_id": "146cbf33c7fd45c4111cbf9d3f04478d",
    "client_transaction_id": "ae6dd41a-9173-4ec7-8734-3178454ef341",
    "mcc": "1234",
    "card_country": "COLL",
    "processor_name": "MASTERCARD",
    "transaction_reference": "718fa526-6f41-405f-a1f5-a71db52dfdd2",
    "payment_method": "card",
    "card_details": {
        "prosa_info": {},
        "reading_type": "MCR"
    },
    "transaction_id": "111663595155516279",
    "created": 1663895155240,
    "merchant_name": "Tu libreria",
    "transaction_type": "SALE",
    "processor": {
        "code": "000",
        "message": "Transacción Aprobada."
    },
    "reference_number": "226520101801",
    "tax_id": "7283839521223",
    "sync_mode": "online",
    "additional_info": {
        "f7": "0922200555",
        "f63": "MDS8TNCN9",
        "f11": "101883",
        "f37": "226520101883"
    },
    "subtotal_iva0": 101.99,
    "deferred": {
        "months": "1"
    },
    "response_code": "00",
    "transaction_status": "APPROVAL",
    "social_reason": "TU LIBRERIA",
    "payment_brand": "MASTERCARD",
    "acquirer_bank": "Kushki",
    "request_amount": 101.99,
    "merchant_id": "20000000305053342000",
    "approved_transaction_amount": 101.99,
    "merchant_category": "Medium",
    "acq_transaction_type": "charge",
    "security": {
        "ip": "187.212.254.148",
        "user_agent": "PostmanRuntime/7.29.2"
    },
    "masked_credit_card": "545195XXXXXX5480",
    "authorization_code": "533804",
    "issuing_bank": "BankACQ",
    "processor_id": "1652365464",
    "foreign_card": true,
    "pos_details": {
        "model": "P2-EU",
        "location": {
            "latitude": -0.1848534,
            "longitude": -78.4769761
        },
        "brand": "SUNMI",
        "version": "Kushki SunmiV1.1.13",
        "terminal_id": "PB04209860004"
    },
    "last_four_digits": "5480",
    "approval_code": "533804",
    "amount": {
        "extra_taxes": {},
        "currency": "COP",
        "subtotal_iva0": 101.99
    },
    "rules_response": {
        "country": "COL",
        "address": "Centro 123",
        "business_category": "0",
        "commercial_executive": "user@example.com",
        "authorizer": {
            "authorizer_name": "MASTERCARD",
            "soft_descriptor": "KSK*TEST",
            "authorizer_bank_id": "",
            "authorizer_type": "",
            "commerce_code": "353453",
            "retailer_id": "",
            "authorizer_acquirer_bin": "545195",
            "category_model": "0",
            "terminal_id": "1652365413",
            "authorizer_alias": "MASTERCARD",
            "url": "http://internal-k8s-acquirer-acquirer-83c4eec5cf-1220747559.us-east-1.elb.amazonaws.com/mc/"
        },
        "city": "Monterrey",
        "contact_person": "John Doe",
        "merchant_name": "Tu libreria",
        "telephone": "8100000001",
        "mcc": "1234",
        "tax_id": "asdf12345678",
        "url": "http://internal-k8s-acquirer-acquirer-83c4eec5cf-1220747559.us-east-1.elb.amazonaws.com/mc/",
        "zip_code": "64000",
        "province": "NUEVO LEON",
        "tcc": "H",
        "total_amount": "101.990000",
        "business_registration_id": "000000000001",
        "business_line": "37006",
        "currency": "MXN",
        "id": "1652365464",
        "acquirer_type": "kushki"
    },
    "acq_transaction_scope": "international",
    "contact_details": {
        "document_number": "123666",
        "document_type": "0"
    },
    "acq_transaction_mode": "Authorization",
    "card_type": "credit",
    "ticket_number": "111663890155240264",
    "card_country_code": "COL",
    "credential_alias": "Tu libreria",
    "bin_card": "545195",
    "credential_id": "245c10532cd844e28e4ec9a83159d89b",
    "transactionReference": "718fa526-6f41-405f-a1f5-a71db52dfdd2"
}

{
    "country": "Colombia",
    "franchise": "MASTERCARD",
    "metadata": {
    "transaccionCodigo": "1245",
    "type": "test",
    "transaccionId": "1234"
  },
    "available": true,
    "channel": "POS",
    "public_credential_id": "146cbf33c7fd45c4111cbf9d3f04478d",
    "client_transaction_id": "6610eadc-6c1d-44aa-8ca0-18e061c1472a",
    "mcc": "1234",
    "card_country": "COL",
    "processor_name": "MASTERCARD",
    "transaction_reference": "a1c8ccb4-0bbc-4661-8b22-7355bd1a2701",
    "payment_method": "card",
    "card_details": {
        "prosa_info": {},
        "reading_type": "MCR"
    },
    "transaction_id": "151663895657169613",
    "created": 1663895657169,
    "merchant_name": "Tu libreria",
    "transaction_type": "PREAUTH",
    "processor": {
        "code": "000",
        "message": "Transacción Aprobada."
    },
    "reference_number": "226520101814",
    "tax_id": "7283839425223",
    "sync_mode": "online",
    "additional_info": {
        "f7": "0922201417",
        "f63": "MDS8TNCN9",
        "f11": "101884",
        "f37": "226520101884"
    },
    "subtotal_iva0": 601,
    "deferred": {
        "months": "1"
    },
    "response_code": "00",
    "transaction_status": "APPROVAL",
    "social_reason": "TU LIBRERIA",
    "payment_brand": "MASTERCARD",
    "acquirer_bank": "Kushki",
    "request_amount": 601,
    "merchant_id": "20000000505013348000",
    "approved_transaction_amount": 601,
    "merchant_category": "Medium",
    "acq_transaction_type": "preAuth",
    "security": {
        "ip": "187.212.254.148",
        "user_agent": "PostmanRuntime/7.29.2"
    },
    "masked_credit_card": "222300XXXXXX0018",
    "authorization_code": "918762",
    "issuing_bank": "BankACQ",
    "processor_id": "1652365464",
    "cvm_type": "none",
    "foreign_card": true,
    "pos_details": {
        "location": {
            "latitude": -0.22480833333333333,
            "longitude": -78.487955
        },
        "model": "P2-EU",
        "version": "Kushki SunmiV1.1.26",
        "brand": "SUNMI",
        "terminal_id": "PB04016R20519"
    },
    "last_four_digits": "0018",
    "approval_code": "918762",
    "amount": {
        "extra_taxes": {},
        "currency": "MXN",
        "subtotal_iva0": 601
    },
    "rules_response": {
        "country": "MEX",
        "address": "Centro 123",
        "business_category": "0",
        "commercial_executive": "user@example.com",
        "city": "Monterrey",
        "authorizer": {
            "authorizer_name": "MASTERCARD",
            "soft_descriptor": "KSK*TEST",
            "authorizer_bank_id": "",
            "authorizer_type": "",
            "commerce_code": "353453",
            "retailer_id": "",
            "authorizer_acquirer_bin": "24477",
            "category_model": "0",
            "url": "http://internal-k8s-acquirer-acquirer-83c4eec5cf-1220747559.us-east-1.elb.amazonaws.com/mc/",
            "terminal_id": "1632369464",
            "authorizer_alias": "MASTERCARD"
        },
        "contact_person": "John Doe",
        "merchant_name": "Tu libreria",
        "telephone": "8100000001",
        "mcc": "1234",
        "zip_code": "64000",
        "tax_id": "asdf12345678",
        "url": "http://internal-k8s-acquirer-acquirer-83c4eec5cf-1220747559.us-east-1.elb.amazonaws.com/mc/",
        "province": "NUEVO LEON",
        "tcc": "H",
        "total_amount": "601.000000",
        "business_registration_id": "000000000001",
        "business_line": "37006",
        "currency": "MXN",
        "id": "1652365464",
        "acquirer_type": "kushki"
    },
    "acq_transaction_scope": "international",
    "contact_details": {
        "document_type": "-1"
    },
    "acq_transaction_mode": "Authorization",
    "card_type": "credit",
    "ticket_number": "111663895707169666",
    "card_country_code": "MEX",
    "credential_alias": "Tu libreria",
    "bin_card": "222300",
    "credential_id": "245c10532cd544e28e4eb9a70659d89b",
    "transactionReference": "a1c8ccb4-0bbc-4661-8b22-7355bd1a2701"
}

{
    "country": "Mexico",
    "franchise": "MASTERCARD",
    "metadata": {
    "transaccionCodigo": "1245",
    "type": "test",
    "transaccionId": "1234"
  },
    "available": true,
    "channel": "POS",
    "public_credential_id": "146caf33c7fd45c4941cbf9d3f04478d",
    "client_transaction_id": "ae6dd91a-9173-4ec7-8934-3178454ef341",
    "mcc": "1234",
    "card_country": "CHL",
    "processor_name": "MASTERCARD",
    "transaction_reference": "777fea10-24f2-4bb9-8d0c-8ae717fce2e8",
    "payment_method": "card",
    "card_details": {
        "prosa_info": {},
        "reading_type": "MCR"
    },
    "transaction_id": "111663895948960466",
    "created": 1663895948960,
    "merchant_name": "Tu libreria",
    "transaction_type": "CAPTURE",
    "processor": {
        "code": "000",
        "message": "Transacción Aprobada."
    },
    "reference_number": "226601101885",
    "tax_id": "7283839421223",
    "sync_mode": "online",
    "additional_info": {
        "f7": "0923011908",
        "f63": "MDS8TNCN9",
        "f11": "101885",
        "f37": "226601101885"
    },
    "subtotal_iva0": 2000,
    "deferred": {
        "months": "1"
    },
    "response_code": "00",
    "transaction_status": "APPROVAL",
    "social_reason": "TU LIBRERIA",
    "payment_brand": "MASTERCARD",
    "acquirer_bank": "Kushki",
    "request_amount": 2000,
    "merchant_id": "20000000105053348000",
    "approved_transaction_amount": 2000,
    "merchant_category": "Medium",
    "acq_transaction_type": "capture",
    "security": {
        "ip": "187.252.251.248",
        "user_agent": "PostmanRuntime/7.29.2"
    },
    "masked_credit_card": "222300XXXXXX0018",
    "authorization_code": "423101",
    "issuing_bank": "BankACQ",
    "processor_id": "1652365464",
    "foreign_card": true,
    "pos_details": {
        "model": "P2-EU",
        "location": {
            "latitude": -0.1848534,
            "longitude": -78.4769761
        },
        "version": "Kushki SunmiV1.1.13",
        "brand": "SUNMI",
        "terminal_id": "PB04209860189"
    },
    "last_four_digits": "0018",
    "approval_code": "423101",
    "amount": {
        "extra_taxes": {},
        "currency": "COP",
        "subtotal_iva0": 2000
    },
    "rules_response": {
        "country": "MEX",
        "commercial_executive": "marco@kushkipagos.com",
        "address": "Direccion prueba",
        "business_category": "0",
        "city": "Guanajuato",
        "authorizer": {
            "authorizer_name": "MASTERCARD",
            "soft_descriptor": "KSK*TEST",
            "authorizer_bank_id": "",
            "authorizer_type": "",
            "commerce_code": "353453",
            "authorizer_acquirer_bin": "24477",
            "retailer_id": "",
            "category_model": "0",
            "authorizer_alias": "MASTERCARD",
            "url": "http://internal-k8s-acquirer-acquirer-83c4eec5cf-1220747559.us-east-1.elb.amazonaws.com/mc/",
            "terminal_id": "1652365464"
        },
        "contact_person": "Person Contact 1",
        "merchant_name": "Tu libreria",
        "telephone": "0987654321",
        "mcc": "1234",
        "tax_id": "asdf12345678",
        "zip_code": "12345",
        "url": "http://internal-k8s-acquirer-acquirer-83c4eec5cf-1220747559.us-east-1.elb.amazonaws.com/mc/",
        "province": "AGUASCALIENTES",
        "total_amount": "2000.000000",
        "tcc": "H",
        "business_registration_id": "000000000001",
        "business_line": "37006",
        "currency": "MXN",
        "id": "1652365464",
        "acquirer_type": "kushki"
    },
    "acq_transaction_scope": "international",
    "contact_details": {
        "document_number": "123666",
        "document_type": "0"
    },
    "acq_transaction_mode": "Authorization",
    "card_type": "credit",
    "ticket_number": "111663895948960466",
    "card_country_code": "MEX",
    "credential_alias": "Tu libreria",
    "bin_card": "222300",
    "credential_id": "245c10532cd844e28e4ec9a70659d89b",
    "transactionReference": "777fea10-24f2-4bb9-8d0c-8ae717fce2e8"
}

Webhooks-Card Payments

Card Payments#

Structure#

Examples#

Card Payments

Structure

Examples