API atual/Referência completa/Mini-loja WhatsApp: sacola e checkout

Cartões salvos

Lista e apaga os cartões que o cliente guardou na carteira para pagar mais rápido nas próximas compras.

A carteira de cartões guarda, para o cliente identificado, os cartões que ele pediu para salvar (save_card: true no checkout ou em Pagar com cartão). A carteira é a mesma da loja online: um cartão salvo no site aparece no WhatsApp e o contrário também.

O que fica guardado nunca é o número nem o CVV: é um identificador reutilizável do cartão dentro do gateway, mais a bandeira, os 4 últimos dígitos e a validade. Esse identificador não sai do servidor. A API devolve só o id da carteira, e é esse id que você envia como instrument_id para pagar com o cartão salvo.

Salvar é opcional e escolha do cliente. Telefone sem conta não tem carteira.

Listar os cartões

GET/api/v1/storefront/wa-coex/pay/{token}/cardsPública

Lista os cartões salvos do cliente

Parâmetros de caminho

tokenstringobrigatório

Token da mini-loja.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/wa-coex/pay/$TOKEN/cards"

Resposta

200Carteira com um cartão

json

{
  "cards": [
    { "id": "6c1d3b52-8e0a-4f6c-9a47-2b8d1c0e5f11", "brand": "visa", "last4": "4242", "exp_month": 12, "exp_year": 2029 }
  ]
}

Campos da resposta

cardsarray

Cartões da carteira. [] quando o cliente não tem cartão salvo, não tem conta identificada, o cartão está desligado para o WhatsApp na loja ou a carteira não está disponível. Nenhum desses casos é erro.

idstring

Id do cartão na carteira. Use como instrument_id.

brandstring

Bandeira (visa, mastercard...).

last4string

Últimos 4 dígitos.

exp_monthinteger

Mês de validade (1 a 12).

exp_yearinteger

Ano de validade, com 4 dígitos.

Apagar um cartão

DELETE/api/v1/storefront/wa-coex/pay/{token}/cards/{cardID}Pública

Remove um cartão da carteira

Revoga o cartão da carteira do cliente. Depois disso o id deixa de servir como instrument_id. Quando a loja não tem carteira, ou o token não tem conta identificada, a resposta é {"deleted": true} do mesmo jeito: não há o que apagar.

Parâmetros de caminho

tokenstringobrigatório

Token da mini-loja.

cardIDstringobrigatório

id do cartão na carteira.

Resposta

200Cartão removido

json

{ "deleted": true }

Erros

Status	Quando	Corpo
503	Não foi possível revogar o cartão agora.	`{"error":"wallet_unavailable"}`

Veja também

Cartões salvos

Lista e apaga os cartões que o cliente guardou na carteira para pagar mais rápido nas próximas compras.

Salvar é opcional e escolha do cliente. Telefone sem conta não tem carteira.

Listar os cartões

GET/api/v1/storefront/wa-coex/pay/{token}/cardsPública

Lista os cartões salvos do cliente

Parâmetros de caminho

tokenstringobrigatório

Token da mini-loja.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/wa-coex/pay/$TOKEN/cards"

Resposta

200Carteira com um cartão

json

{
  "cards": [
    { "id": "6c1d3b52-8e0a-4f6c-9a47-2b8d1c0e5f11", "brand": "visa", "last4": "4242", "exp_month": 12, "exp_year": 2029 }
  ]
}

Campos da resposta

cardsarray

idstring

Id do cartão na carteira. Use como instrument_id.

brandstring

Bandeira (visa, mastercard...).

last4string

Últimos 4 dígitos.

exp_monthinteger

Mês de validade (1 a 12).

exp_yearinteger

Ano de validade, com 4 dígitos.

Apagar um cartão

DELETE/api/v1/storefront/wa-coex/pay/{token}/cards/{cardID}Pública

Remove um cartão da carteira

Parâmetros de caminho

tokenstringobrigatório

Token da mini-loja.

cardIDstringobrigatório

id do cartão na carteira.

Resposta

200Cartão removido

json

{ "deleted": true }

Erros

Status	Quando	Corpo
503	Não foi possível revogar o cartão agora.	`{"error":"wallet_unavailable"}`