Criar perfil de pagamento

Este endpoint permite criar um perfil de pagamento para um cliente e reaproveitar esses dados em pagamentos automáticos ou recorrentes. Em caso de sucesso, a requisição retornará uma resposta com status 201.

POST

https://api.mercadopago.com/v1/customers/{customer_id}/payment-profiles
Request parameters
Header
Authorization
string

OBRIGATÓRIO

Access Token obtido através do painel de desenvolvedores. Obrigatório ser enviado em todas as requisições.
X-Idempotency-Key
string

OBRIGATÓRIO

Esta função permite repetir solicitações de forma segura, sem o risco de realizar a mesma ação mais de uma vez por engano. Isso é útil para evitar erros, como a criação de dois pagamentos idênticos. Para garantir que cad...Ver mais
Path
customer_id
string

OBRIGATÓRIO

Identificador único do cliente para o qual o perfil de pagamento está sendo criado. Pode ser obtido enviando uma requisição ao endpoint "Buscar em clientes".
Body
description
string
Descrição do perfil de pagamento do cliente, que será utilizado para facilitar a identificação da natureza das cobranças vinculadas a este perfil dentro do ecossistema de gestão do integrador ou seller. Campo de texto us...Ver mais
max_day_overdue
integer
Define a quantidade de dias para realizar novas tentativas de processamento do pagamento em caso de falha ou reprovação inicial. Por exemplo, se enviar "5" como valor, serão realizadas novas tentativas de processamento d...Ver mais
statement_descriptor
string
Descrição que será exibida na fatura do cartão do cliente. (ex. MERCADOPAGO)
sequence_control
string
Define se os dados da assinatura, como a informação que determina a sequência do pagamento, devem ser enviados de forma manual ou automática. Os valores possíveis são:
AUTO: Os dados da assinatura são enviados automaticamente. É o valor padrão caso o campo não seja enviado.
MANUAL: Os dados da assinatura devem ser enviados manualmente.
Response parameters
id
string
Identificador único do perfil de pagamento, gerado automaticamente pelo Mercado Pago.
created_date
string
Data de criação do perfil de pagamento, no formato "yyyy-MM-ddTHH:mm:ss.sssZ"
last_updated_date
string
Data da última atualização do perfil de pagamento, no formato "yyyy-MM-ddTHH:mm:ss.sssZ"
description
string
Descrição do perfil de pagamento do cliente, que será utilizado para facilitar a identificação da natureza das cobranças vinculadas a este perfil dentro do ecossistema de gestão do integrador ou seller.
Erros

400Erro

payment_method_id_cannot_be_blank

A requisição falhou porque não foi enviado nenhum valor para o campo "payment_method_id". Em "details" é possível obter mais detalhes sobre o erro. Verifique se os dados enviados são corretos e tente novamente.

payment_methods_cannot_be_null

A requisição falhou porque não foi enviado nenhum meio de pagamento. Em "details" é possível obter mais detalhes sobre o erro. Verifique se os dados enviados são corretos e tente novamente.

payment_methods_required

A requisição falhou porque não foi enviado nenhum objeto com informações sobre o meio de pagamento. Em "details" é possível obter mais detalhes sobre o erro. Verifique se os dados enviados são corretos e tente novamente.

payment_method_token_or_card_id_required

A requisição falhou porque nenhum dos campos "card_token" ou "card_id" foi enviado, embora ao menos um deles seja obrigatório para criar o perfil de pagamento. Em "details" é possível obter mais detalhes sobre o erro. Verifique se os dados enviados são corretos e tente novamente.

html_insertion_not_allowed

A requisição falhou porque foram enviados elementos HTML em campos que não permitem esse tipo de conteúdo. Em "details" é possível obter mais detalhes sobre o erro. Verifique se os dados enviados são válidos e tente novamente.

max_day_overdue_out_of_range

A requisição falhou porque o valor enviado para o campo "max_day_overdue" não está dentro dos valores permitidos. Em "details" é possível obter mais detalhes sobre o erro. Verifique se os dados enviados são corretos e tente novamente.

validation_error

A requisição falhou por um erro de validação nos campos enviados. Em "details" é possível obter mais detalhes sobre o erro. Verifique se os dados enviados são corretos e tente novamente.

payload_failed

A requisição falhou, possivelmente devido a erros de formatação ou dados inválidos. Em "details" é possível obter mais detalhes sobre o erro. Verifique se os dados enviados são corretos e tente novamente.

multiple_default_payment_methods_not_allowed

A requisição falhou porque o número máximo de meios de pagamento marcados como padrão foi excedido. Lembre-se de que apenas um meio de pagamento pode ser definido com "default_method" = true.

more_than_two_payment_methods_not_allowed

A requisição falhou porque foram enviados mais de dois objetos de meio de pagamento, excedendo o limite permitido para a criação do perfil. Revise a requisição e verifique se o nó foi enviado corretamente.

two_cards_with_token_not_allowed

A requisição falhou porque não é permitido criar um perfil de pagamento com dois cartões utilizando "card_token" como meio de pagamento. Revise a requisição para enviar ambos objetos de forma correta.

duplicate_payment_method_not_allowed

A requisição falhou porque há um meio de pagamento duplicado. O mesmo meio de pagamento não pode ser incluído novamente.

invalid_site_id_for_fintoc

A requisição falhou porque o site_id associado ao usuário que está criando o perfil de pagamento não é válido para o meio de pagamento "fintoc", meio de pagamento que é apenas disponível para Chile. Verifique se está enviando as credenciais corretas ou crie um perfil utilizando um meio de pagamento válido para seu país.

profile_modification_not_allowed

A requisição falhou porque houve tentativa de alterar um perfil com status cancelado, o que não é permitido. Verifique o status do perfil antes de realizar qualquer atualização.

payment_method_validation_failed

A requisição falhou porque a validação do meio de pagamento não foi realizada. Tente novamente mais tarde e, se o problema persistir, entre em contato com o Suporte informando os detalhes do erro.

customer_id_mismatch

A requisição falhou porque o "customer_id" enviado não corresponde ao perfil de pagamento. Verifique se o valor correto foi enviado e tente novamente.

caller_id_mismatch

A requisição falhou porque o "caller_id" enviado não corresponde ao perfil de pagamento. Verifique se o valor correto foi enviado e tente novamente.

site_id_mismatch

A requisição falhou porque o "site_id" não corresponde ao perfil de pagamento. Verifique se o valor correto foi enviado e tente novamente.

unknown_error_occurred

Erro desconhecido. Entre em contato com o Suporte para mais informações.

401Erro

header_missing

A requisição falhou porque um header obrigatório não foi enviado. Certifique-se de enviar todos os headers necessários.

Unauthorized Access Token

O Access Token enviado está incorreto. Revise o valor e tente enviar a requisição novamente com a informação correta.

402Erro de processamento

payment_method_not_approved

A requisição falhou porque o pagamento utilizado para verificar o meio de pagamento não foi aprovado. Confirme se os dados informados são válidos e suficientes para concluir a transação ou utilize outro método.

404Erro

resource_not_found

A requisição falhou porque o perfil de pagamento não foi encontrado. Verifique se o ID do perfil de pagamento, o ID do cliente e o ID do solicitante estão corretos.

429Erro

Too Many Requests

A requisição falhou porque o limite de chamadas foi excedido. Diminua a frequência ou utilize backoff exponencial para novas tentativas.

500Erro

internal_server_error

A requisição falhou por um erro interno do servidor. Tente novamente mais tarde e, se o problema persistir, entre em contato com o Suporte informando detalhes do erro.

Request
curl -X POST \
    'https://api.mercadopago.com/v1/customers/{customer_id}/payment-profiles'\
    -H 'Content-Type: application/json' \
       -H 'Authorization: Bearer APP_USR-8*********88776-122*********fc20dede6*********a497d7225*********64' \
       -H 'X-Idempotency-Key: 73e6ebe3-b371-4636-b79b-51999079892d' \
    -d '{
  "description": "Test payment profile",
  "max_day_overdue": 5,
  "statement_descriptor": "Test Descriptor",
  "sequence_control": "MANUAL",
  "payment_methods": [
    {
      "id": "visa",
      "type": "credit_card",
      "token": "12345",
      "default_method": false
    }
  ]
}'
Response
{
  "id": "7036b192b541454fa9b9990660dfa1b5",
  "created_date": "2024-05-22T14:03:28.653Z",
  "last_updated_date": "2024-05-22T14:03:28.653Z",
  "description": "Test payment profile",
  "max_day_overdue": 5,
  "statement_descriptor": "Test Descriptor",
  "status": "READY",
  "sequence_control": "AUTO",
  "payment_methods": [
    {
      "payment_method_id": "64abf0f5-3e15-48a5-9be0-a8ac56bbd87a",
      "id": "visa",
      "type": "credit_card",
      "card_id": 1234567890,
      "status": "READY",
      "default_method": true
    }
  ]
}