Cetelem

In order to make the payment through the Aura-Cetelem acquirer on Carat Portal, in addition to the basic parameters of the REST Transaction creation service and REST Payment effectuation service, others parameters are required and will be sent using the prefixes field described in the Prefixes section.

ATTENTION: Before starting, please verify that the desired Authorizer is configured with the Payment Type with acquirer code = 93 (Aura - Cetelem).

Carat Portal Interfaces Supported for Integration#

You can use the following interfaces for integration with Cetelem routing:

  • REST Payment
  • REST Pre-Authorization
  • REST Cancel
  • Cancel via Portal

REST Payment#

Transaction Creation#

The parameters with specific data for the transaction via Cetelem that the virtual store application must send in the REST Transaction creation service:

ParameterDescriptionFormatRequired
authorizer_idAuthorizer Code on Carat Portal - Use the Aura-Cetelem code which is 93≤ 10 AYes
installment_typeInstallment type. May be:
3 - revolving credit
4 - revolving credit with installments
17 - installment plan
= 2 NYes for installment plan

Transaction Effectuation#

The parameters with specific data for the transaction via Cetelem that the virtual store application must send in the REST Transaction creation service:

ParameterDescriptionFormatRequired
acquirer
prefixesElement for sending SiTef prefixes. If the prefix that was sent is not supported by card, Carat Portal will invalidate the transaction, preventing that a false impression of the use of a functionality is given.

The Cetelem's supported prefixes are described in the Prefixes section.

Example:
{ "key" : "value" } -> { "CICLOS" : "01" }
≤ 2000 AYes

Prefixes#

ParameterDescriptionFormatRequired
CMATMaterial code= 4 NYES for installment plan
CPLANOPlan code= 5 ANYES for installment plan

REST Pre-Authorization#

Pre-Authorization Creation#

Below are described the specific Cetelem parameters for the REST pre-authorization creation service:

Element for sending SiTef prefixes. If the prefix that was sent is not supported by card, Carat Portal will invalidate the transaction, preventing that a false impression of the use of a functionality is given.

The Cetelem's supported prefixes are described in the Prefixes section.
ParameterDescriptionFormatMandatory
additional_data
pre_auth_lifecycleRepresents the number of days in which the pre-authorization is considered valid.< 2 NNO
entry_amountEntry amount in cents.< 12 NNO
additional_data
.extra_param
.prefixes[]
keyPrefix name.< 1024 ANNO
valuePrefix value.< 1024 ANNO

Example:

{
"merchant_usn": "14111112826",
"order_id": "14111112826",
"authorizer_id": "6",
"amount": "2300",
"transaction_type": "preauthorization",
"additional_data": {
"pre_auth_lifecycle": "7",
"entry_amount": "1",
"extra_param": {
"prefixes": [
{
"key": "CPLANO",
"value": "13219"
},
{
"key": "CMAT",
"value": "11"
}
]
}
}
}

Pre-Authorization Effectuation#

Installment information (installments and installment_type fields) must be sent in this step. In the capture step, the same values must be used.

Below is the specific description of some parameters of Cetelem for the REST pre-authorization service:

ParameterDescriptionFormatMandatory
installment_typeInstallment type.

May be:
3 - super credit limit
4 - revolving credit with installments
= 2 NYES
installmentsNumber of installments of the transaction. Note: use installment_type = 4 and installments = 1 for spot sale.= 2 NYES

Pre-Authorization Capture#

Below is the specific description of some parameters of Cetelem for the REST pre-authorization capture service:

ParameterDescriptionFormatMandatory
installment_typeInstallment type.
May be:
3 - credit limit
4 - revolving credit with installments
= 2 NYES
installmentsNumber of installments of the transaction. Note: use installment_type = 4 and installments = 1 for spot sale.= 2 NYES

IMPORTANT: For the Cetelem routing, the Pre-Authorization capture does not require card data.

Example#

Request:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/preauthorizations/capture/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
"amount":"100",
"installments":"1",
"installment_type":"4",
"acquirer":{
"entry_amount": "1555"
}
}
--verbose

Response:

{
"code": "0",
"message": "OK. Transaction successful.",
"capture": {
"status": "CON",
"nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
"order_id": "orderID",
"customer_receipt": "=== CUSTOMER RECEIPT ===",
"merchant_receipt": "=== MERCHANT RECEIPT ===",
"authorizer_id": "2",
"acquirer_id": "1005",
"acquirer_name": "Redecard",
"authorizer_code": "000",
"authorizer_message": "Transacao OK.",
"authorizer_date": "09/11/2018T19:40",
"authorizer_merchant_id": "000000000000000",
"authorization_number": "212195",
"esitef_usn": "180921015287704",
"merchant_usn": "20190101",
"sitef_usn": "212195",
"host_usn": "999212195",
"amount": "100",
"payment_type": "C",
"issuer": "2"
}
}

Below are described the specific Cetelem parameters for the REST pre-authorization capture service:

ParameterDescriptionFormatMandatory
acquirer
entry_amountEntry amount in cents.< 12 NNO