logo ← gs-payment-ecommerce / Dados adicionais para transações de cartão

Dados adicionais para transações de cartão

#Adquirentes

#Prisma

Campos obrigatórios no additional_acquirer_data para o roteamento com prisma:

card_holder_name

#PagBank

Campos obrigatórios no additional_acquirer_data para o roteamento com pagbank:

payer.document
payer.email
payer.name

#Rede

Importante: A ausência de qualquer um dos campos obrigatórios pode resultar na rejeição da transação pela adquirente REDE.

Este documento especifica os campos obrigatórios que devem ser enviados no payload quando a adquirente utilizada for a REDE.

Todos os campos listados abaixo são obrigatórios para garantir o correto processamento da transação no fluxo Data Only.

#Lista de Campos Obrigatórios para o funcionamento do Data Only

  • data_only_information.device_information.device_type

  • data_only_information.device_information.color_depth

  • data_only_information.device_information.java_enabled

  • data_only_information.device_information.language

  • data_only_information.device_information.screen_height

  • data_only_information.device_information.screen_width

  • data_only_information.device_information.time_zone_off_set

  • data_only_information.device_information.user_agent

  • data_only_information.device_information.ip_address

  • data_only_information.billing_information.country

  • data_only_information.billing_information.state

  • data_only_information.billing_information.city

  • data_only_information.billing_information.address

  • data_only_information.billing_information.address_number

  • data_only_information.billing_information.neighborhood

  • data_only_information.billing_information.zip_code

  • data_only_information.billing_information.name

  • data_only_information.billing_information.email

  • data_only_information.billing_information.phone_number

#Estrutura do dados Adicionais para a Rede

{
    "acquirer_additional_data": {
        "data_only_information": {
            "device_information": {
                "device_type": "BROWSER",
                "color_depth": "30",
                "java_enabled": "false",
                "language": "pt-BR",
                "screen_height": "937",
                "screen_width": "1920",
                "time_zone_off_set": "180",
                "user_agent": "2313ewqewqe21",
                "ip_address": "192.168.123.132"
            },
            "billing_information": {
                "country": "BRA",
                "state": "SC",
                "city": "Garopaba",
                "address": "Rua jose antonio lobo",
                "address_number": "890",
                "neighborhood": "Ferraz",
                "zip_code": "88495000",
                "name": "John Snow",
                "email": "carlos.sousa@gsurfnet.com",
                "phone_number": "40028922"
            }
        }
    }
}

#Especificação dos campos

#Bloco device_information

CAMPO

TIPO

TAMANHO (MIN–MAX)

DESCRIÇÃO

device_type

enum: BROWSER

1–20

Tipo do dispositivo utilizado.

color_depth

string

30

Profundidade de cor.

java_enabled

enum: truefalse

4–5

Indica se o Java está habilitado.

language

string

30

Idioma configurado no dispositivo (ex: pt-BR).

screen_height

string

30

Altura da tela em pixels.

screen_width

string

30

Largura da tela em pixels.

time_zone_off_set

string

30

Diferença de fuso horário em minutos (ex: -180180).

user_agent

string

10–500

Agente do usuário (browser/device).

ip_address

string

7–45

Endereço IP do dispositivo (IPv4 ou IPv6).

#Bloco billing_information

CAMPO

TIPO

TAMANHO (MIN–MAX)

DESCRIÇÃO

country

string

3

País (ISO Alpha-3). Ex: BRA.

state

string

2

Estado (UF brasileiro).

city

string

3–100

Cidade do endereço de cobrança.

address

string

5–200

Logradouro do endereço de cobrança.

address_number

string

1–10

Número do endereço de cobrança.

neighborhood

string

3–100

Bairro do endereço de cobrança.

zip_code

string

8

CEP (somente números, sem traço).

name

string

150

Nome do titular da cobrança.

email

string

255

E-mail válido.

phone_number

string

30

Número de telefone (somente dígitos).

#Adiq

Importante: A ausência de qualquer um dos campos obrigatórios pode resultar na rejeição da transação pela adquirente Adiq.

Este documento especifica os campos obrigatórios que devem ser enviados no payload quando a adquirente utilizada for a Adiq.

Todos os campos listados abaixo são obrigatórios para garantir o correto processamento da transação.

Lista de Campos Obrigatórios

  • customer.address

  • customer.address_number

  • customer.neighborhood

  • customer.city

  • customer.state

  • customer.country

  • customer.document

  • customer.name

  • customer.email

  • customer.phone_number

  • customer.ip_address

  • customer.zip_code

  • card_holder_name

#Estrutura dos Dados Adicionais para a Adiq

{
    "acquirer_additional_data": {
        "customer": {
            "address": "Rua José Antonio Lobo",
            "address_number": "890",
            "neighborhood": "Ferraz",
            "city": "Garopaba",
            "state": "SC",
            "country": "BRA",
            "document": "12321321321",
            "name": "John Snow",
            "email": "johnsnow@gsurfnet.com",
            "phone_number": "48996420377",
            "ip_address": "1231321312",
            "zip_code": "88495000"
        },
        "card_holder_name": "John Snow"
    }
}

#Descrição dos Campos

#customer

  • customer.address: Logradouro do endereço do comprador.

  • customer.address_number: Número do endereço do comprador.

  • customer.neighborhood: Bairro do endereço do comprador.

  • customer.city: Cidade do endereço do comprador.

  • customer.state: Estado do endereço do comprador.

  • customer.country: País do endereço do comprador.

  • customer.zip_code: CEP do endereço do comprador.

  • customer.document: Documento de identificação do comprador.

  • customer.name: Nome completo do comprador.

  • customer.email: Endereço de e-mail do comprador.

  • customer.phone_number: Número de telefone do comprador.

  • customer.ip_address: Endereço IP do dispositivo do comprador.

#card_holder

  • card_holder_name: Nome do titular do cartão utilizado na transação.

#Antifraude

#Clear

Campos obrigatórios no anti_fraud_data para o roteamento com a clear sale:

order_information.bill_to.first_name

order_information.bill_to.last_name

order_information.bill_to.email

Campos obrigatórios no envio do endereço na clear sale, tanto para bill_to ou ship_to:

order_information.bill_to.address

order_information.bill_to.address_number

order_information.bill_to.neighborhood

order_information.bill_to.city

order_information.bill_to.state

order_information.bill_to.zip_code

Campos obrigatórios no envio do telefone na clear sale, tanto para bill_to ou ship_to:

order_information.bill_to.phone_number_type

order_information.bill_to.phone_number