Authorization and capture

🔐 Producto en versión beta en Colombia

Estamos trabajando en nuestra versión beta. ¡Manténte atento a su lanzamiento oficial! También puedes contactar a tu gerente de cuenta para más información.

With this endpoint you can:

Carry out preauthorizations

Make reauthorizations

Make captures

Void preauthorizations

Supported Reading Channels

We support the following reading channels. The fields you send to us to process a charge may differ depending on the reading type.

ICC= Integrated Circuit Card

MCR= Magnetic Card reader

MFC= Multi-Function Card

Make preauthorizations (Place a hold on card payment)

You can retain the balance of a card to withhold a certain amount of the account.

Structure

To make authorizations, send preAuth in the transaction_type field and Authorization in the transaction_mode field as part of the body of your request. (See full example on the right side of the screen).

Make reauthorizations

You can extend the amount or effect of the authorization.

The currency must be the same as the authorization.

An amount of $0 can be sent in the reauthorization to extend the date of capture.

The reauthorization can be for an amount greater than the authorization.

NOTE: A reauthorization can be canceled. After performing the cancellation, no reauthorizations can be made on the canceled transaction.

Structure

To make reauthorizations, send reAuthorization in the transaction_type field and Authorization in the transaction_mode field as part of the body of your request. (See full example on the right side of the screen).

Discover how to perform a cardless reauthorization.

Capture a payment

Once you are required to collect the funds from the card, capture the amount you define.

The capture must be the sum of the authorization and all reauthorizations made that have not been canceled. The amount to be captured can be equal or lower than the amount authorized or reauthorized.

Structure

To capture send capture in the transaction_type field, Authorization in the transaction_mode field and the transaction_reference of the transaction to capture as part of the body of your request (transaction_reference must be from an authorization, not from a reauthorization). (See full example on the right side of the screen).

Discover how to perform a cardless capture.

Cardless operations

You can perform a reauthorization, capture or void without requiring the reading of the card. Below you will find out how you can carry out a cardless operation:

NOTE: You can also check the information for a cardless refund.

To perform an operation without a card it is required to send the omit_card field with the value of true in the request. The fields required for a cardless operation are the following:

PROPERTY	TYPE	Allowed values
`amount`	`Object`
`transaction_mode`	`String`	`Authorization`, `Void`
`transaction_type`	`String`	`charge`, `reAuthorization`, `capture`
`client_transaction_id`	`String`
`transaction_reference`	`String`
`omit_card`	`Boolean`	`true`

NOTE: Cardless operations are available for Visa and Mastercard credit and debit cards in Colombia.

Example of a cardless operation

To perform a cardless operation, the omit_card field is sent with the value of true and then the other non-required fields are omitted:

{
    "amount": {
        "currency": "COP",
        "iva": 0.0,
        "subtotal_iva": 0.0,
        "subtotal_iva0": 600
    },
    "transaction_mode": "Authorization",
    "transaction_type": "reAuthorization",
    "client_transaction_id": "6680eadc-6c8d-44aa-8ca0-18e061c1472a",
    "transaction_reference": "f2f29080-0214-42c0-95a5-77ecf3434cd7",
    "omit_card": true
}

{
    "amount": {
        "currency": "COP",
        "iva": 0.0,
        "subtotal_iva": 0.0,
        "subtotal_iva0": 600
    },
    "transaction_mode": "Authorization",
    "transaction_type": "capture",
    "client_transaction_id": "6680eadc-6c8d-44aa-8ca0-18e061c1472a",
    "transaction_reference": "f2f29080-0214-42c0-95a5-77ecf3434cd7",
    "omit_card": true
}

{
    "amount": {
        "currency": "COP",
        "iva": 0.0,
        "subtotal_iva": 0.0,
        "subtotal_iva0": 600
    },
    "transaction_mode": "Void",
    "transaction_type": "charge",
    "client_transaction_id": "6680eadc-6c8d-44aa-8ca0-18e061c1472a",
    "transaction_reference": "f2f29080-0214-42c0-95a5-77ecf3434cd7",
    "omit_card": true
}

curl --location 'https://api-uat.kushkipagos.com/pos/v1/transaction' \ --header 'Private-Credential-Id;' \ --header 'Content-Type: application/json' \ --data '{ "card": { "card_holder_name": "John Doe" }, "amount": { "iva": 0, "tip": 0, "currency": "COP", "extra_taxes": { "iac": 0, "ice": 0, "airport_tax": 0, "travel_agency": 0 }, "subtotal_iva": 0, "subtotal_iva0": 600 }, "country": "COL", "cvm_type": "none", "is_cashback": false, "pos_details": { "brand": "SUNMI", "model": "P2-EU", "version": "Kushki SunmiV1.1.26", "location": { "latitude": -0.22480833333333333, "longitude": -78.487955 }, "has_print": true, "terminal_id": "PB04216R20537" }, "card_details": { "tracks": { "track_ksn": "FFFF4357486333600002", "enc_track2": "283587285CE10278E7FA50AD5C97CFFE87F472C9FE6406F8" }, "enc_tlv": "CE447A062C49774934E42A7F826668C0C478E38402C158062EE794C0E471B43EA8CE49C256C2C8B157526B0B2BE74FC23F65E18D4F52B99A1A0910E6CCD9B11A32D6D537E2B6E2B011C89569DE6A3D53318080BC77E0E70B398ED3083FD7366CCF8FB4DBF34A116E6D52CFBEF26371878D842034E5029EF62DF235D2C427F04102E451773D9E8975978917E3BC531327702967052E239F8C592734AE14688E603C52B858FC1D97B763AE623603F1475FFFB065EC07AF7A29", "pin_ksn": "FFFF4357486333600002", "reading_type": "ICC" }, "contact_details": { "email": "", "last_name": "", "first_name": "", "phone_number": "", "document_type": "-1", "document_number": "", "second_last_name": "" }, "transaction_mode": "Authorization", "transaction_type": "preAuth", "client_transaction_id": "6680eadc-6c8d-44aa-8ca0-18e061c1472a" }'

{ "additional_amounts": { "account_type": "", "amount": 0, "amount_type": "", "card_type": "", "currency_code": "" }, "authorized_amount": 601, "card_type": "credit", "cvm_type": "none", "F11": "101658", "franchise": "MASTERCARD", "kushki_response": { "code": "000", "message": "Transacción Aprobada." }, "message_fields": { "F38": "890862", "F39": "00" }, "transaction_reference": "2aa48997-a545-4bdb-8e1c-a57546f03e5f", "transaction_status": "APPROVAL", "transaction_type": "preAuth", "ticket_number": "111727462978861299" }

Supported Reading Channels

Make preauthorizations (Place a hold on card payment)

Structure

Make reauthorizations

Structure

Capture a payment

Structure

Cardless operations

Example of a cardless operation

Request

Responses

Authorization and capture

Supported Reading Channels#

Make preauthorizations (Place a hold on card payment)#

Structure#

Make reauthorizations#

Structure#

Capture a payment#

Structure#

Cardless operations#

Example of a cardless operation#

Request

Responses

Supported Reading Channels

Make preauthorizations (Place a hold on card payment)

Structure

Make reauthorizations

Structure

Capture a payment

Structure

Cardless operations

Example of a cardless operation