Criar transação de boleto

ℹ️
As características de uma transação de boleto são:

Os boletos precisam ser registrados;

Envie os parâmetros exclusivos para boleto: Payment.Bank, Payment.BoletoNumber, Payment.Assignor, Payment.Demonstrative, Payment.ExpirationDate, Payment.Identification e Payment.Instructions.

São aceitos como caracteres válidos: números, letras de A a Z (MAIÚSCULAS) e caracteres especiais de conjunção (hífen “-“ e apóstrofo “‘”). Quando utilizados, não pode haver espaços entre as letras. Exemplos corretos: D’EL-REI / D’ALCORTIVO / SANT’ANA. Exemplos incorretos: D’EL - REI / um espaço em branco entre palavras.

Requisição

post https://apisandbox.cieloecommerce.cielo.com.br/1/sales/

{
    "MerchantOrderId": "2017091101",
    "Customer": {
        "Name": "Nome do Comprador",
        "Identity": "12345678909",
        "IdentityType": "CPF",
        "Address": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "Sao Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        }
    },
    "Payment": {
        "Provider": "Braspag",
        "Bank": "BancoDoBrasil",
        "Type": "Boleto",
        "Amount": 10000,
        "BoletoNumber": "2017091101",
        "Assignor": "Empresa Teste",
        "Demonstrative": "Desmonstrative Teste",
        "ExpirationDate": "2017-12-31",
        "Identification": "12346578909",
        "Instructions": "Aceitar somente até a data de vencimento.",
        "splitpayments": [
            {
                "subordinatemerchantid": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
                "amount": 5000,
                "fares": {
                    "mdr": 5,
                    "fee": 30
                }
            },
            {
                "subordinatemerchantid": "9140ca78-3955-44a5-bd44-793370afef94",
                "amount": 5000,
                "fares": {
                    "mdr": 4,
                    "fee": 15
                }
            }
        ]
    }
}

A seguir, veja os campos de propriedade nesta requisição:

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
`MerchantOrderId`	Texto	50	Sim	Numero de identificação do Pedido
`Customer.Name`	Texto	60	Sim	Nome do comprador
`Customer.Identity`	Texto	14	Sim	Número do RG, CPF ou CNPJ do Cliente
`Customer.IdentityType`	Texto	255	Sim	Tipo de documento de identificação do comprador (CPF ou CNPJ)
`Customer.Address.Street`	Texto	60	Sim	Endereço de contato do comprador
`Customer.Address.Number`	Texto	60	Sim	Número endereço de contato do comprador
`Customer.Address.Complement`	Texto	60	Não	Complemento do endereço de contato do Comprador
`Customer.Address.ZipCode`	Texto	8	Sim	CEP do endereço de contato do comprador
`Customer.Address.District`	Texto	60	Sim	Bairro do endereço de contato do comprador
`Customer.Address.City`	Texto	18	Sim	Cidade do endereço de contato do comprador
`Customer.Address.State`	Texto	2	Sim	Estado do endereço de contato do comprador
`Customer.Address.Country`	Texto	35	Sim	Pais do endereço de contato do comprador
`Payment.Provider`	Texto	15	Sim	Nome da provedora de Meio de Pagamento de Boleto `Braspag`
`Payment.Bank`	Texto	15	Sim	Nome do Banco que o boleto será emitido `BancoDoBrasil`
`Payment.Type`	Texto	100	Sim	Tipo do Meio de Pagamento. No caso `Boleto`
`Payment.Amount`	Número	15	Sim	Valor do Pedido (deve ser enviado em centavos)
`Payment.BoletoNumber`	Texto	9	Não	Número do Boleto ("Nosso Número"). Caso preenchido, sobrepõe o valor configurado no meio de pagamento
`Payment.Assignor`	Texto	200	Não	Nome do Cedente. Caso preenchido, sobrepõe o valor configurado no meio de pagamento
`Payment.Demonstrative`	Texto	N/A	Não	Texto de Demonstrativo. Caso preenchido, sobrepõe o valor configurado no meio de pagamento
`Payment.ExpirationDate`	Date	AAAA-MM-DD	Não	Dias para vencer o boleto. Caso não esteja previamente cadastrado no meio de pagamento, o envio deste campo é obrigatório. Se enviado na requisição, sobrepõe o valor configurado no meio de pagamento.
`Payment.Identification`	Texto	14	Não	CNPJ do Cedente. Caso preenchido, sobrepõe o valor configurado no meio de pagamento
`Payment.Instructions`	Texto	450	Não	Instruções do Boleto. Caso preenchido, sobrepõe o valor configurado no meio de pagamento

Resposta

{
    "MerchantOrderId": "2017091101",
    "Customer": {
        "Name": "Nome do Comprador",
        "Identity": "12345678909",
        "IdentityType": "CPF",
        "Address": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "Sao Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        }
    },
    "Payment": {
        "Instructions": "Aceitar somente até a data de vencimento.",
        "ExpirationDate": "2020-12-31",
        "Demonstrative": "Desmonstrative Teste",
        "Url": "https://transactionsandbox.pagador.com.br/post/pagador/reenvia.asp/4b97aa02-9bf2-4e06-8197-c099b861e226",
        "BoletoNumber": "0000000248",
        "BarCodeNumber": "",
        "DigitableLine": "",
        "Assignor": "Empresa Teste",
        "Address": "N/A, 1",
        "Identification": "12346578909",
        "ProviderReturnCode": "0",
        "ProviderReturnMessage": "Transação criada com sucesso",
        "Bank": 4,
        "Amount": 10000,
        "ReceivedDate": "2020-03-08 08:19:27",
        "Provider": "Braspag",
        "Status": 1,
        "IsSplitted": false,
        "ReturnMessage": "Transação criada com sucesso",
        "ReturnCode": "0",
        "PaymentId": "4b97aa02-9bf2-4e06-8197-c099b861e226",
        "Type": "Boleto",
        "Currency": "BRL",
        "Country": "BRA",
        "SplitPayments": [
            {
                "SubordinateMerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
                "Amount": 6000,
                "Fares": {
                    "Mdr": 5.0,
                    "Fee": 30
                },
                "Splits": [
                    {
                        "MerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
                        "Amount": 5670
                    },
                    {
                        "MerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
                        "Amount": 330
                    }
                ]
            },
            {
                "SubordinateMerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
                "Amount": 4000,
                "Fares": {
                    "Mdr": 4.0,
                    "Fee": 15
                },
                "Splits": [
                    {
                        "MerchantId": "9140ca78-3955-44a5-bd44-793370afef94",
                        "Amount": 3825
                    },
                    {
                        "MerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
                        "Amount": 175
                    }
                ]
            }
        ],
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/4b97aa02-9bf2-4e06-8197-c099b861e226"
            }
        ]
    }
}

A seguir, veja os campos de propriedade nesta resposta:

Propriedade	Descrição	Tipo	Tamanho	Formato
`PaymentId`	Campo Identificador do Pedido.	Guid	36	xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
`ExpirationDate`	Data de expiração.	Texto	10	2014-12-25
`Url`	URL do Boleto gerado	string	256	https://.../pagador/reenvia.asp/8464a692-b4bd-41e7-8003-1611a2b8ef2d
`BoletoNumber`	"NossoNumero" gerado.	Texto	50	2017091101
`BarCodeNumber`	Representação numérica do código de barras.	Texto	44	00091628800000157000494250100000001200656560
`DigitableLine`	Linha digitável.	Texto	256	00090.49420 50100.000004 12006.565605 1 62880000015700
`Address`	Endereço do Loja cadastrada no banco	Texto	256	Av. Teste, 160
`Status`	Status da Transação.	Byte	2	Ex. 1