Pular para o conteúdo principal

Definir um cartão como padrão

Torne um cartão salvo o cartão de pagamento padrão do usuário autenticado ou remova seu status de padrão.

Domínio
Cards and vault
Serviço responsável
Payments
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado

Headers#

2
AuthorizationstringObrigatório
Aceito ou encaminhado pelo API Gateway para esta operação.
X-Merchant-IDstringOpcional
Aceito ou encaminhado pelo API Gateway para esta operação.

Parâmetros de rota#

2
user_idstringObrigatório
Valor que substitui `user_id` na rota do endpoint.
card_idstringObrigatório
Valor que substitui `card_id` na rota do endpoint.

Corpo da solicitação#

1
is_defaultbooleanOpcional
Payload JSON aceito pelo serviço responsável. Use o painel de solicitação para editar e visualizar o corpo.
Exemplo true

Resposta#

4
200A solicitação foi aceita ou concluída. Confira o payload para o resultado de negócio.
401As credenciais ou o contexto do chamador são inválidos.
403As credenciais ou o contexto do chamador são inválidos.
404O recurso ou a rota solicitada não foi encontrado.

Comportamento do cartão padrão#

Enviar {"is_default": true} para tornar o cartão salvo selecionado o padrão do usuário. A DEUNA remove o status de padrão de qualquer outro cartão do mesmo usuário, garantindo no máximo um cartão padrão.

O corpo da solicitação é opcional. Omiti-lo tem o mesmo efeito que enviar {"is_default": true}. Enviar {"is_default": false} para remover o status de padrão do cartão selecionado sem alterar nenhum outro cartão.

Antes de chamar o endpoint#

  • Autentique o cliente e envie o token de acesso do usuário no Authorization header.
  • Configure user_id com o UUID do usuário autenticado.
  • Use um card_id retornado por Listar cartões armazenados. O cartão deve pertencer ao usuário autenticado.

Verifique o resultado#

Uma solicitação bem-sucedida retorna 200 OK com o cartão atualizado. Confirme que o campo is_default corresponde ao valor solicitado. Você também pode listar os cartões salvos do usuário e verificar se nenhum outro está marcado como padrão.

O endpoint retorna 404 Not Found quando o cartão selecionado não existe para o usuário autenticado. Corrija UUIDs inválidos ou JSON malformado antes de tentar novamente; solicitações repetidas com o mesmo is_default mantêm o cartão no mesmo estado.