| 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/ |
O pedido de requisição de uma transação recorrente com boleto bancário é o mesmo da criação de um boleto tradicional. Adicione o nó RecurrentPayment ao nó Payment para agendar as recorrências futuras ao autorizar uma transação pela primeira vez na série de recorrências.
A data de vencimento dos boletos recorrentes será criada baseando-se na data do próximo pedido recorrente adicionado do valor que estiver configurado no meio de pagamento.
Exemplo.: Dia da próxima cobrança: 01/01/2021 + 5 dias. Vencimento do boleto criado automaticamente: 06/01/2021.
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":"São Paulo",
"State":"SP",
"Country":"BRA",
"District":"Alphaville"
}
},
"Payment": {
"Provider": "Simulado",
"Type": "Boleto",
"Amount": 1000,
"Instructions": "Aceitar somente até a data de vencimento.",
"RecurrentPayment": {
"AuthorizeNow": true,
"StartDate": "2020-01-01",
"EndDate": "2020-12-31",
"Interval": "Monthly"
}
}
}
--request POST "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
"MerchantOrderId":"2017091101",
"Customer":{
"Name":"Nome do Comprador",
"Identity":"12345678909",
"IdentityType":"CPF",
"Address":{
"Street":"Alameda Xingu",
"Number":"512",
"Complement":"27 andar",
"ZipCode":"12345987",
"City":"São Paulo",
"State":"SP",
"Country":"BRA",
"District":"Alphaville"
}
},
"Payment": {
"Provider":"Simulado",
"Type":"Boleto",
"Amount":1000,
"Instructions":"Aceitar somente até a data de vencimento.",
"RecurrentPayment":{
"AuthorizeNow":true,
"StartDate":"2020-01-01",
"EndDate":"2020-12-31",
"Interval":"Monthly"
}
}
}
--verbose
A seguir, veja as propriedades de campo nesta requisição:
| Propriedade (header) | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
MerchantId | Guid | 36 | Sim | Identificador da loja no Split de Pagamento |
MerchantKey | Texto | 40 | Sim | Chave Publica para Autenticação Dupla no Split de Pagamento |
Content-Type | Header | 40 | Sim | Application/json |
RequestId | Guid | 36 | Não | Identificador do request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT. |
| Propriedade (body) | Descrição | Tipo | Tamanho | Obrigatório? |
|---|---|---|---|---|
Payment.Provider | Nome do provedor do meio de pagamento. | Texto | 15 | Sim |
Payment.Type | Tipo do meio de pagamento. | Texto | 100 | Sim |
Payment.Amount | Valor do pedido, em centavos. | Número | 15 | Sim |
Payment.RecurrentPayment.StartDate | Data para início da recorrência. | Texto | 10 | Não |
Payment.RecurrentPayment.EndDate | Data para término da recorrência. | Texto | 10 | Não |
Payment.RecurrentPayment.Interval | Intervalo da recorrência. Monthly (default) / Bimonthly / Quarterly / SemiAnnual / Annual | Texto | 10 | Não |
Payment.RecurrentPayment.AuthorizeNow | "true" - autoriza no momento da requisição. "false" - para agendamento futuro. | Booleano | *** | Sim |
Resposta
{
"MerchantOrderId": "teste001",
"Customer": {
"Name": "Nome do Comprador",
"Identity": "12345678909",
"IdentityType": "CPF",
"Address": {
"Street": "Alameda Xingu",
"Number": "512",
"Complement": "27 andar",
"ZipCode": "06455914",
"City": "São Paulo",
"State": "SP",
"Country": "BRA",
"District": "Alphaville"
}
},
"Payment": {
"Instructions": "Aceitar somente até a data de vencimento.",
"ExpirationDate": "2020-08-15",
"Url": "https://apisandbox.cieloecommerce.cielo.com.br/post/pagador/reenvia.asp/a5f3181d-c2e2-4df9-a5b4-d8f6edf6bd51",
"BoletoNumber": "100031-0",
"BarCodeNumber": "00096834800000129001234270000010003105678900",
"DigitableLine": "00091.23423 40000.010004 31056.789008 6 83480000012900",
"Address": "N/A, 1",
"IsRecurring": false,
"PaymentId": "58e4bde3-1abc-4aef-a58a-741f4c53940d",
"Type": "Boleto",
"Amount": 1000,
"ReceivedDate": "2020-01-01 00:00:01",
"Currency": "BRL",
"Country": "BRA",
"Provider": "Simulado",
"ReasonCode": 0,
"ReasonMessage": "Successful",
"Status": 1,
"RecurrentPayment": {
"RecurrentPaymentId": "a08a622b-71f2-4553-9345-5f3c4fbbacb0",
"ReasonCode": 0,
"ReasonMessage": "Successful",
"NextRecurrency": "2020-02-01",
"StartDate": "2020-01-01",
"EndDate": "2020-12-31",
"Interval": "Monthly",
"Link": {
"Method": "GET",
"Rel": "recurrentPayment",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId}"
},
"AuthorizeNow": true,
},
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}"
}
]
}
}
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
"MerchantOrderId": "teste001",
"Customer": {
"Name": "Nome do Comprador",
"Identity": "12345678909",
"IdentityType": "CPF",
"Address": {
"Street": "Alameda Xingu",
"Number": "512",
"Complement": "27 andar",
"ZipCode": "06455914",
"City": "São Paulo",
"State": "SP",
"Country": "BRA",
"District": "Alphaville"
}
},
"Payment": {
"Instructions": "Aceitar somente até a data de vencimento.",
"ExpirationDate": "2020-08-15",
"Url": "https://apisandbox.cieloecommerce.cielo.com.br/post/pagador/reenvia.asp/a5f3181d-c2e2-4df9-a5b4-d8f6edf6bd51",
"BoletoNumber": "100031-0",
"BarCodeNumber": "00096834800000129001234270000010003105678900",
"DigitableLine": "00091.23423 40000.010004 31056.789008 6 83480000012900",
"Address": "N/A, 1",
"IsRecurring": false,
"PaymentId": "58e4bde3-1abc-4aef-a58a-741f4c53940d",
"Type": "Boleto",
"Amount": 1000,
"ReceivedDate": "2020-01-01 00:00:01",
"Currency": "BRL",
"Country": "BRA",
"Provider": "Simulado",
"ReasonCode": 0,
"ReasonMessage": "Successful",
"Status": 1,
"RecurrentPayment": {
"RecurrentPaymentId": "a08a622b-71f2-4553-9345-5f3c4fbbacb0",
"ReasonCode": 0,
"ReasonMessage": "Successful",
"NextRecurrency": "2020-02-01",
"StartDate": "2020-01-01",
"EndDate": "2020-12-31",
"Interval": "Monthly",
"Link": {
"Method": "GET",
"Rel": "recurrentPayment",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId}"
},
"AuthorizeNow": true,
},
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}"
}
]
}
}
--verbose
| Propriedade | Descrição | Tipo | Tamanho | Formato |
|---|---|---|---|---|
RecurrentPaymentId | Campo identificador da próxima recorrência. | GUID | 36 | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
NextRecurrency | Data da próxima recorrência. | Texto | 7 | 05/2019 (MM/YYYY) |
StartDate | Data do início da recorrência. | Texto | 7 | 05/2019 (MM/YYYY) |
EndDate | Data do fim da recorrência. | Texto | 7 | 05/2019 (MM/YYYY) |
Interval | Intervalo entre as recorrências. | Texto | 10 | Monthly / Bimonthly / Quarterly / SemiAnnual / Annual |
AuthorizeNow | Define se a primeira recorrência já irá ser autorizada ou não. | Booleano | *** | true ou false |