Pre-Authorization Capture Service
The capture of the Pre-Authorization is intended to effect the Pre-Authorization, which may be in the total amount or lower than the total value of the Pre-Authorization. This will depend on the business rule of the Virtual Store application.
The flow should be: do the pre-authorization operation and if the result is approved, the capture service should be called to complete the flow. The capture will be accomplished in the moment defined by the application business rule.
In the capture operation, the parameter amount may have a value equal to or less than the pre-authorization parameter amount.
For GetNetLac via SiTef routing, the installment can also be done at the pre-authorization and in this case, the capture should expect a installmente number equal or more than the sent previously. If the pre-auth is a sale spot, the capture can not be installed.
Call details#
- Resources:
/v1/preauthorizations/capture/{nit} - HTTP Method:
POST - Request format:
JSON - Response format:
JSON - Header parameters:
| Parameter | Description | Format | Mandatory |
|---|---|---|---|
Content-Type | Fixed value application/json | = 15 AN | YES |
merchant_id | Merchant code on Carat Portal. The production and certification codes will be different. | < 15 AN | YES |
merchant_key | Merchant authentication key on Carat Portal. The production and certification keys will be different. | < 80 AN | YES |
Example#
Request:
To use this example, don't forget to define the variable {{url}} to the value
esitef-homologacao.softwareexpress.com.br
Response:
Response codes
See reference on API codes - response codes
Request parameters#
| Parameter | Description | Format | Mandatory | |||
|---|---|---|---|---|---|---|
amount | Purchase amount specified by store (in cents) on transaction creation. | < 12 N | YES | |||
discount | Discount amount in cents. In case of pre-authorizations with promotional values when using Visa Checkout, VISA suggests that this field should be submitted additionally. | < 12 N | NO | |||
installments (*) | Installments number, 1 for sale spot | < 2 N | YES | |||
installment_type | Along with the installments field, indicates installment. Possible values for installment_type are:
| = 1 N | YES | |||
promo_code | Visa Checkout promotion code used in pre-authorization. In case of pre-authorizations with promotional values when using Visa Checkout, VISA suggests that this field should be submitted additionally. | AN | NO | |||
subtotal | Subtotal amount, in cents. In case of pre-authorizations with promotional amounts by using Visa Checkout, VISA suggests that this field be submitted additionally. | < 12 N | NO | |||
card | Sending card data is mandatory on SiTef routed transactions with the exception of the Cetelem acquirer. Only one of these fields must be used: | |||||
number | Customer's card number (PAN). | < 19 N | COND. | |||
token | Used for recurring pre-authorizations, when the card is already stored at Carat Portal database. | = 88 AN | COND. | |||
wallet_transaction_id | Wallet Visa Checkout transaction ID. | < 25 AN | COND. | |||
initial_wallet_transaction_id | Informs if the Wallet ID (wallet_transaction_id) is being used for the first time. If it's the first time, send true, otherwise, send false. Required only for Visa Checkout.Default value: true | < 5 AN | COND. | |||
expiry_date | Card expiry date in MMYY format. | = 4 N | COND. | |||
security_code | Card security code. | < 5 N | COND. | |||
acquirer.submerchant_split[] | It consists of an array for split payments, unique to BIN and Sipag routing, both via SiTef. Allows the division of parts of the total payment amount among other companies. The maximum number of items allowed in this array is 5 items. Each item consists of the | |||||
submerchant_code | store code BIN/Sipag | < 15 AN | NO | |||
submerchant_amount | transaction amount for merchant | < 12 N | NO | |||
mcc | The MCC (Merchant Category Code) is a code that classifies the business by the type of goods or services it provides. | < 4 N | NO | |||
subacquirer_merchant_id | It is the merchant identification for the subacquirer. | < 22 AN | NO | |||
ecomm_pos_ref | This field will send and identification that will appear in the PDV field of the SiTef Web report for e-commerce transactions. | < 8 AF | NO | |||
Response parameters#
| Parameter | Description | Format |
|---|---|---|
code | Carat Portal response code. Anything besides 0 means failure. See more information at the Response Code document | < 4 N |
message | Carat Portal response message. | < 500 AN |
capture | ||
acquirer_id | Acquirer/routing ID used in transaction. | < 4 N |
acquirer_name | Acquirer/routing name used in transaction. | < 100 AN |
amount | Purchase amount specified by store (in cents) on transaction creation. | < 12 AN |
authorization_number | Authorization number | < 6 AN |
authorizer_code | Authorizer responde code. | < 10 AN |
authorizer_date | Authorizer pre-auth effectuation date, returned by the authorizer on the format DD/MM/AAAA’T’HH:mm. Example: 13/07/2017T16:03 | = 16 AN |
authorizer_id | Authorizer ID use in transaction. | < 4 N |
authorizer_merchant_id | Merchant ID from authorizer. | < 100 AN |
authorizer_message | Reponse message from authorizer. | < 500 AN |
customer_receipt | Customer receipt. | < 4000 AN |
eci | Eletronic Commerce Indicator (pre-authorization security level indicator on transactions). | < 3 AN |
esitef_usn | Carat Portal pre-authorization's unique sequential number. | = 15 N |
host_usn | Authorizer NSU. | < 15 AN |
issuer | Issuer code returned by the authorizer. | < 5 AN |
merchant_receipt | Merchant receipt. | < 4000 AN |
merchant_usn | Unique sequential number sent by store at the transaction creation. | < 12 AN |
nit | Carat Portal pre-authorization transaction ID. | = 64 AN |
order_id | Order ID sent by the store at transaction creation. | < 40 AN |
payment_type | Payment type from the selected authorizer: B = boleto, C = credit, D = debit, P = Private Label credit card, T = bank transfer, G = gift card, O = other payment methods, W = Boleto NR via Web Service | = 1 AN |
sitef_usn | SiTef pre-authorization's unique sequential number. | = 6 N |
status | Carat Portal pre-authorization transaction status. | = 3 AN |
tid | Acquirer/routing transaction ID. This field is only returned in transactions with external acquirer's. | < 40 AN |
xid | XID field returned on 3DS authentications or certain acquirers/routings. | < 40 AN |
| card | ||
suffix | Last 4 digits of the customer’s card number. | = 4 AN |
bin | First 6 digits of the customer’s card. | = 6 AN |