Ambiente | Método | Endpoint |
---|---|---|
Sandbox | post | https://apisandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId}/Customer |
Produção | post | https://api.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId}/Customer |
Para alterar os dados do comprador de uma recorrência existente, basta fazer uma chamada PUT para o endpoint especificado. Em resposta, a API irá retornar o código do Status HTTP, informando se a operação foi realizada com sucesso ou não.
Requisição
post https://apisandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId}/Customer
{
"Name":"Outro nome do Comprador",
"Email":"[email protected]",
"Birthdate":"1999-12-12",
"Identity":"0987654321",
"IdentityType":"CPF",
"Address":{
"Street":"Avenida Brigadeiro Faria Lima",
"Number":"1500",
"Complement":"AP 201",
"ZipCode":"05426200",
"City":"São Paulo",
"State":"SP",
"Country":"BRA",
"District":"Alphaville"
},
"DeliveryAddress":{
"Street":"Avenida Brigadeiro Faria Lima",
"Number":"1500",
"Complement":"AP 201",
"ZipCode":"05426200",
"City":"São Paulo",
"State":"SP",
"Country":"BRA",
"District":"Alphaville"
}
}
}
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
"Name":"Outro nome do Comprador",
"Email":"[email protected]",
"Birthdate":"1999-12-12",
"Identity":"0987654321",
"IdentityType":"CPF",
"Address":{
"Street":"Avenida Brigadeiro Faria Lima",
"Number":"1500",
"Complement":"AP 201",
"ZipCode":"05426200",
"City":"São Paulo",
"State":"SP",
"Country":"BRA",
"District":"Alphaville"
},
"DeliveryAddress":{
"Street":"Avenida Brigadeiro Faria Lima",
"Number":"1500",
"Complement":"AP 201",
"ZipCode":"05426200",
"City":"São Paulo",
"State":"SP",
"Country":"BRA",
"District":"Alphaville"
}
}
--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? |
---|---|---|---|---|
RecurrentPaymentId | Número de identificação da recorrência. | Texto | 50 | Sim (envio no endpoint) |
Name | Nome do comprador. | Texto | 255 | Sim |
Email | Email do comprador. | Texto | 255 | Não |
Birthdate | Data de nascimento do comprador. | Date | 10 | Não |
Identity | Número do RG, CPF ou CNPJ do cliente. | Texto | 14 | Não |
IdentityType | Tipo do documento de identificação do comprador (CFP/CNPJ). | Texto | 255 | Não |
Address.Street | Endereço do comprador. | Texto | 255 | Não |
Address.Number | Número do endereço do comprador. | Texto | 15 | Não |
Address.Complement | Complemento do endereço do comprador. | Texto | 50 | Não |
Address.ZipCode | CEP do endereço do comprador. | Texto | 9 | Não |
Address.City | Cidade do endereço do comprador. | Texto | 50 | Não |
Address.State | Estado do endereço do comprador. | Texto | 2 | Não |
Address.Country | País do endereço do comprador. | Texto | 35 | Não |
Address.District | Bairro do endereço do comprador. | Texto | 50 | Não |
DeliveryAddress.Street | Endereço de entrega do comprador. | Texto | 255 | Não |
DeliveryAddress.Number | Número do endereço de entrega do comprador. | Texto | 15 | Não |
DeliveryAddress.Complement | Complemento do endereço de entrega do comprador. | Texto | 50 | Não |
DeliveryAddress.ZipCode | CEP do endereço de entrega do comprador. | Texto | 9 | Não |
DeliveryAddress.City | Cidade do endereço de entrega do comprador. | Texto | 50 | Não |
DeliveryAddress.State | Estado do endereço de entrega do comprador. | Texto | 2 | Não |
DeliveryAddress.Country | País do endereço de entrega do comprador. | Texto | 35 | Não |
DeliveryAddress.District | Bairro do endereço de entrega do comprador. | Texto | 50 | Não |
Resposta
HTTP Status 200
Consulte HTTP Status Code para ver a lista com todos os códigos de status HTTP possivelmente retornados pela API.