Uma transação do tipo Cash In é uma operação de adição de créditos em uma carteira digital. Os estabelecimentos que operam com esse tipo de transação devem ser registrados como carteira digital junto as bandeiras e devem estar cadastrados com um dos seguintes MCCs (Códigos de categoria do estabelecimento):
EC | CHAVE | MCC | BANDEIRAS ACEITAS |
---|---|---|---|
2000019700 | 8c08a0d0f00b73dedd2673a06fa725b0bd8edbf71c4c7dd0614bf408e4d16120 | 6051/6540 | Mastercard |
2000019700 | 8c08a0d0f00b73dedd2673a06fa725b0bd8edbf71c4c7dd0614bf408e4d16120 | 6051/6540 | Visa |
2000019853 | 8c08a0d0f00b73dedd2673a06fa725b0bd8edbf71c4c7dd0614bf408e4d16120 | 6540 | Elo |
Além disso, precisam enviar alguns dados adicionais na transação, para que as bandeiras possam identificar e diferenciar esse tipo de transação. Veja as especificações:
Além dos campos específicos dessa modalidade, para transações Cash In também é obrigatório o envio do Soft Descriptor (campo
Payment.SoftDescriptor
) e CPF ou CNPJ do portador (campoCustomer.Identity
e campoCustomer.IdentityType
). No caso de Cash In, o campo do Soft Descriptor precisa ser preenchido com nome da carteira*nome do portador. Confira mais detalhes na tabela de campos da requisição.
Importante: A marcação de Cash In é apenas aceita para as seguintes modalidades e bandeiras: Visa/Mastercard só crédito; Elo débito e crédito. Não é aceita para cartão estrangeiro.
Requisição
Ambiente | Método | Endpoint |
---|---|---|
Sandbox | post | https://apisandbox.cieloecommerce.cielo.com.br/1/sales |
Produção | post | https://api.cieloecommerce.cielo.com.br/1/sales |
{
"MerchantOrderId": "2012345678",
"Customer": {
"Name": "Comprador Carteira",
"Identity": "11225468954",
"IdentityType": "CPF"
},
"Payment": {
"Type": "CreditCard",
"Amount": 15700,
"Installments": 1,
"SoftDescriptor": "CARTEIRA*NOMEPORTADOR",
"CreditCard": {
"CardNumber": "4532110000001234",
"Brand": "Visa",
"SecurityCode": "123"
},
"Wallet": {
"PlatformOperator": "ABC",
"AdditionalData": {
"CashIn": "true"
"Mcc": "1234"
}
}
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
Wallet.PlatformOperator | string (texto) | 3 | Sim, para transações de Cash In | Sigla da carteira que está cadastrada aqui na Cielo como carteira digital (verificar sua sigla com seu gestor comercial) |
Wallet.AdditionalData.CashIn | string (texto) | - | Sim, para transações de Cash In | Enviar como “True” se for uma transação de Cash In |
Wallet.AdditionalData.Mcc | string (numérico) | 4 | Sim, para transações de Cash In | MCC do varejista subjacente (para transações de compra); MCC da carteira digital (para transações de abastecimento de crédito na carteira caso aplicável - no qual é necessária a marcação de cash in também vista nessa sessão) |
Customer.Identity | texto | 14 | Sim, para transações de Cash In | Número do CPF ou CNPJ do comprador. |
Customer.IdentityType | Texto | 255 | Sim, para transações de Cash In | Tipo de documento de identificação do comprador (CPF/CNPJ). |
SoftDescriptor | texto | 13 | Sim, para transações de Cash In | Texto que será impresso na fatura bancária do portador. Não permite caracteres especiais. Necessário preencher com Nome da carteira*nome do portador. |