Instrumento de pagamento do Google Pay

Esta referência é baseada no esquema de instrumento de pagamento com cartão para o objeto de instrumento de pagamento retornado pelo processador de pagamentos do Google Pay após a conclusão do checkout na matriz payment.instruments.

{
  "id": string,
  "handler_id": string,
  "type": string,
  "selected": boolean,
  "display": {
    "brand": string,
    "last_digits": string,
    "description": string,
    "card_art": string
  },
  "billing_address": {
    "first_name": string,
    "last_name": string,
    "street_address": string,
    "extended_address": string,
    "address_locality": string,
    "address_region": string,
    "postal_code": string,
    "address_country": string,
    "phone_number": string
  },
  "credential": {
    "type": "PAYMENT_GATEWAY" | "DIRECT",
    "token": string
  }
}

Propriedades

Propriedade Tipo Sempre presente? Descrição
id string Sim Um identificador exclusivo para essa instância de instrumento de pagamento, atribuído pela plataforma.
handler_id string Sim O identificador exclusivo da instância do gerenciador que produziu esse instrumento. Corresponde ao campo id na configuração do processador de pagamentos.
type string Sim O tipo de instrumento de pagamento, por exemplo, card.
selected booleano Não Indica se esse instrumento foi selecionado pelo usuário.
display objeto Sim Informações de exibição do instrumento de pagamento.
display.brand string Sim A marca/rede do cartão (por exemplo, "VISA").
display.last_digits string Sim Os quatro últimos dígitos do número do cartão.
display.description string Não Uma descrição da ficha de informações voltada ao usuário.
display.card_art string Não Um URI para uma imagem que representa o cartão.
billing_address objeto Não O endereço de faturamento associado ao cartão. Só é retornado se billing_address_required estiver definido como true na configuração.
billing_address.first_name string Não Nome do contato associado ao endereço.
billing_address.last_name string Não Sobrenome do contato associado ao endereço.
billing_address.street_address string Não É o endereço.
billing_address.extended_address string Não Uma extensão de endereço (por exemplo, número do apartamento ou da suíte).
billing_address.address_locality string Não A localidade (por exemplo, cidade).
billing_address.address_region string Não A região (por exemplo, estado ou província).
billing_address.postal_code string Não O CEP/código postal.
billing_address.address_country string Não O código do país (formato ISO 3166-1 alfa-2 com duas letras).
billing_address.phone_number string Não O número de telefone. Só é retornado se phone_number_required estiver definido como true na configuração.
credential objeto Não Os dados de tokenização segura retornados pelo Google Pay.
credential.type string Sim O tipo de tokenização. Corresponde ao tipo configurado.
  • PAYMENT_GATEWAY: usado se você processar pagamentos por um gateway compatível.
  • DIRECT: usado se você descriptografar as credenciais.
credential.token string Sim O token de credencial de pagamento criptografado como uma string serializada em JSON.

Para PAYMENT_GATEWAY, ele contém o payload criptografado a ser transmitido ao gateway. Para DIRECT, ele contém os detalhes do cartão criptografado (requer descriptografia usando sua chave privada). Consulte o guia Criptografia de dados de pagamento para mais detalhes sobre o formato e o processo de descriptografia.