Solução de Migração Automática de Cartões para API v5
Visão Geral
Com a descontinuação das nossas APIs legadas (v1 a v4) e a necessidade de migração dos clientes para a nossa nova API v5, a solução de migração automática de cartões foi desenvolvida para facilitar a transição. A partir de agora, a API v5 aceitará o ID de cartões (card_id
) da base de dados das APIs antigas, excluindo assim a necessidade de migração completa da base de cartões e simplificando o processo para os desenvolvedores e clientes.
Esta solução visa manter a continuidade das transações com os mesmos cartões registrados nas versões anteriores da API, garantindo uma migração mais tranquila e sem interrupções para os clientes.
Principais Características:
- Suporte ao ID de Cartões Legados: A API v5 começará a aceitar o card_id que foi usado nas APIs anteriores (v1 a v4), permitindo a continuidade do uso dos cartões sem necessidade de migração de dados.
- Validação de Cadastro: A solução funcionará somente no mesmo cadastro de cliente (v1 a v4 para v5). Portanto, é fundamental garantir que a conta correta esteja sendo utilizada e que ela esteja vinculada ao antigo cadastro.
- Rotas Suportadas: A solução atualmente está disponível apenas para as rotas Charge e Orders da API v5. A rota Subscription ainda não é compatível com essa solução de migração automática de cartões.
O Que Muda?
Não há grandes mudanças na estrutura das requisições da API. O principal ajuste será ao realizar a criação de um pedido de cartão. No objeto credit_card
, você deverá enviar o mesmo ID de cartão (card_id
) que foi utilizado nas versões anteriores da API (v1 a v4).
Exemplo:
{
"closed": true,
"customer": {
"name": "Tony Stark",
"type": "individual",
"email": "[email protected]",
"document": "03154435026",
"address": {
"line_1": "7221, Avenida Dra Ruth Cardoso, Pinheiro",
"line_2": "Prédio",
"zip_code": "05425070",
"city": "São Paulo",
"state": "SP",
"country": "BR"
},
"phones": {
"home_phone": {
"country_code": "55",
"area_code": "11",
"number": "000000000"
},
"mobile_phone": {
"country_code": "55",
"area_code": "11",
"number": "000000000"
}
}
},
"items": [
{
"amount": 2990,
"description": "Chaveiro do Tesseract",
"quantity": 1,
"code": 123
}
],
"payments": [
{
"payment_method": "credit_card",
"credit_card": {
"installments": 1,
"statement_descriptor": "AVENGERS",
"card_id": "{{Card_id}}", //aqui informa o card_id da antiga API
"card": {
"billing_address": {
"line_1": "7221, Avenida Dra Ruth Cardoso, Pinheiro",
"zip_code": "05425070",
"city": "São Paulo",
"state": "SP",
"country": "BR"
}
}
}
}
]
}
{
"items": [
{
"amount": 2990,
"description": "Teste Mensalidade",
"quantity": 2,
"code": "Teste"
}
],
"customer_id": "{{customer_id}}", //id do cliente no pagarme V5
"payments": [
{
"credit_card": {
"installments": 1,
"statement_descriptor": "AVENGERS",
"card_id": "{{Card_id}}", //aqui informa o card_id da antiga API
"card": {
"billing_address": {
"line_1": "7221, Avenida Dra Ruth Cardoso, Pinheiro",
"zip_code": "05425070",
"city": "São Paulo",
"state": "SP",
"country": "BR"
}
}
}
]
}
Importante:
Todos os outros campos obrigatórios devem ser preenchidos conforme detalhado na documentação da API v5.
Como Utilizar a Solução de Migração Automática de Cartões?
Habilitação da Funcionalidade
Para começar a utilizar a solução de migração automática de cartões, a conta do cliente precisa ser configurada para suportar essa funcionalidade. Para validar se sua conta já está configurada ou para fazer a solicitação de ativação, entre em contato com nossa Central de Atendimento.
Passos para Implementação:
Passo 1: Valide se a sua conta está configurada para aceitar a migração automática de cartões. Caso contrário, entre em contato com nosso time de atendimento para habilitar essa funcionalidade.
Passo 2: Adapte a estrutura de suas requisições para enviar o card_id
da base de dados das APIs legadas (v1 a v4) ao criar novos pedidos de cartão.
Passo 3: Teste a integração com a API v5, realizando a criação de pedidos reais utilizando card_id
da base de dados das APIs legadas (v1 a v4) para garantir que o processo esteja funcionando corretamente.
Validação de Cadastro
A utilização do card_id
as APIs legadas deve ocorrer exclusivamente dentro do mesmo cadastro do cliente. Isso significa que o card_id
deve estar vinculado à mesma conta do cliente, independentemente de ser v1, v2, v3 ou v4. Caso haja dúvidas sobre o cadastro, recomendamos que entre em contato com nossa Central de Atendimento para garantir que o processo de migração ocorra sem problemas.
Limitações
Rota Subscription não suportada: A solução de migração automática de cartões está disponível apenas para as rotas Charge e Orders. Caso deseje utilizar a migração para a rota Subscription, aguarde futuras atualizações.
Somente para o mesmo cadastro: A migração de cartões só funcionará se os cartões forem mantidos dentro do mesmo cadastro de cliente. É fundamental garantir que a conta utilizada no Dashboard 2.0 esteja vinculada ao cadastro correto.
Disponível apenas em ambiente de produção: A solução de migração automática de cartões está disponível somente em ambiente de produção. Não é possível utilizá-la em ambiente de homologação ou com cartões criados no modo teste.
Contato e Suporte
Caso tenha dúvidas durante a implementação ou precise de suporte adicional, entre em contato com nossa Central de Atendimento. Nossa equipe estará disponível para ajudar com qualquer dificuldade no processo de migração ou integração.
Chat: Pode ser iniciado diretamente pela sua Dashboard Pagar.me.
E-mail: [email protected]
Telefone: 4004-1330