Objeto Order

customer Object

Contém informações do cliente que fará pagamentos usando o serviço PagBank.

nome String (1-30 caracteres)
Nome do cliente.
Exemplo: João Souza

email String (10-255 caracteres)
E-mail do cliente.
Exemplo: [email protected]

tax_id String (11/14 caracteres)
Documento de identificação pessoal (CPF/CNPJ) do cliente. Obrigatório.
Exemplo: 12345678910

phone Array of Object

Contém uma lista de telefones do cliente.

country Int (3 caracteres)
Código de operadora do País (DDI).
Exemplo: 55

area Int (2 caracteres)
Código de operadora local (DDD).
Exemplo: 021

number Int (8-9 caracteres)
Número do telefone.
Exemplo: 123456789

type String (ENUM)
Indica o tipo de telefone.
Valores de ENUM:

MOBILE se for um telefone celular.

BUSINESS se for um telefone comercial.

HOME se for um telefone residencial.

items Array of Object

Contém as informações dos itens inseridos no pedido.

name String (1-64 caracteres)
Nome dado ao item.
Exemplo: Nome do item

quantity Int (5 caracteres)
Quantidade referente ao item.
Exemplo: 2

unit_amount Int (9 caracteres)
Valor do item.
Exemplo: 500

shipping Array of Object

Contém as informações de entrega do pedido.

address Object

Contém informações do endereço de entrega do pedido.

street String (1-160 caracteres)
Rua do endereço.
Exemplo: Avenida Brigadeiro Faria Lima

number String (1-20 caracteres)
Número do endereço.
Exemplo: 1384

complement String (1-40 caracteres)
Complemento do endereço.
Exemplo: Casa

locality String (1-60 caracteres)
Bairro do endereço.
Exemplo: Pinheiros

city String (1-90 caracteres)
Cidade do endereço.
Exemplo: São Paulo

region String (1-50 caracteres)
Nome do Estado.
Exemplo: São Paulo

region_code String (2 caracteres)
Código do Estado (Padrão ISO 3166-2).
Exemplo: SP

country String (1-50 caracteres)
País do endereço (Padrão ISO 3166-1 alpha-3).
Exemplo: BRA

postal_code String (8 caracteres)
CEP do endereço.
Exemplo: 01452002

qr_codes Array of Object

Objeto contendo os QR Codes vinculados à um pedido. Ao informar o amount, o QR code será gerado automaticamente e pode ser pago com aplicativos de outras instituições (Pix). Para que o QR Code aceite o pagamento Pix, o vendedor precisa ter pelo menos uma chave de endereçamento ativa vinculada a sua conta PagBank. Caso o vendedor tenha mais de uma chave de endereçamento cadastrada no PagBank, priorizaremos a utilização da chave de endereçamento aleatória.

expiration_date Datetime
Data de expiração do QR Code. Por padrão, o QR Code gerado tem validade de 24 horas caso o parâmetro qr_codes.expiration_date não seja definido na requisição.
Exemplo: 2021-08-29T20:15:59-03:00

amount Object

Contém informações do valor a ser utilizado no QR Code.

value Int (5 caracteres)
Valor do QR Code.
Exemplo: 500

charges Array of Object

Representa todos os dados disponíveis em uma cobrança, ou seja, na iniciação de um pagamento.

id String (41 caracteres)
Identificador da cobrança PagBank.
Exemplo: CHAR_67FC568B-00D8-431D-B2E7-755E3E6C66A0

status String (1-64 caracteres)
Status da cobrança.

AUTHORIZED indica que a cobrança está pré-autorizada.

PAID indica que a cobrança está paga (capturada).

IN_ANALYSIS indica que o comprador optou por pagar com um Cartão de Crédito e o PagBank está analisando o risco da transação.

DECLINED Indica que a cobrança foi negada pelo PagBank ou Emissor.

CANCELED indica que a cobrança foi cancelada.

created_at Datetime
Data e horário em que foi criada a cobrança.
Exemplo: 2023-02-08T15:15:11.881-03:00

paid_at Datetime
Data e horário em que a cobrança foi paga (capturada).
Exemplo: 2023-02-08T15:15:12.000-03:00

reference_id String (1-64 caracteres)
Identificador único atribuído para a cobrança.
Exemplo: Referência da cobrança

description String (1-64 caracteres)
Descrição da cobrança.
Exemplo: Descrição da cobrança

amount Object

Contém as informações do valor a ser cobrado.

value Int (9 caracteres)
Valor a ser cobrado em centavos. Apenas números inteiros positivos.
Exemplo: R$ 1.500,99 = 150099

currency String (3 caracteres)
Código de moeda ISO de três letras, em maiúsculas. Por enquanto, apenas o Real brasileiro é suportado (“BRL”).
Exemplo: BRL

summary Object

Contém um resumo de valores da cobrança.

total Int (9 caracteres)
Valor total da cobrança.
Exemplo: 150099

paid Int (9 caracteres)
Valor que foi pago na cobrança.
Exemplo: 150099

refunded Int (9 caracteres)
Valor que foi devolvido da Cobrança.
Exemplo: 0

payment_response Object

Contém informações de resposta do provedor de pagamento.

code Int (5 caracteres)
Código PagBank que indica o motivo da resposta de autorização no pagamento, tanto para pagamento autorizado, quanto para negado.
Exemplo: 20000

message String (5-100 caracteres)
Mensagem amigável descrevendo motivo da não aprovação ou autorização da cobrança. Compatível com o padrão ABECS - Normativo 21.
Exemplo: SUCESSO

reference String (4-20 caracteres)
NSU da autorização, caso o pagamento seja aprovado pelo Emissor.
Exemplo: 032416400102

payment_method Object

Contém as informações do método de pagamento da cobrança.

type ENUM
Indica o método de pagamento usado na cobrança.
Valores de ENUM:

CREDIT_CARD ou DEBIT_CARD se o método de pagamento utilizado for Cartão de Crédito, Cartão de Débito ou Token de Bandeira.

Obrigatório o envio do objeto payment_method.card.

BOLETO se o método de pagamento utilizado for Boleto.

Obrigatório o envio do objeto payment_method.boleto.

PIX se o método de pagamento utilizado for Pix.

O objeto payment_method.pix será criado no pagamento do qr code .

installments Int (2 caracteres)
Quantidade de parcelas. Obrigatório para o método de pagamento Cartão de Crédito.
Exemplo: 06

capture Boolean
Parâmetro que indica se uma transação de Cartão de Crédito deve ser apenas pré-autorizada (reserva o valor da cobrança no cartão do cliente de 6 á 29 dias) ou se a transação deve ser capturada automaticamente (cobrança realizada em apenas um passo). Obrigatório para o método de pagamento Cartão de Crédito. Função indisponível para o método de pagamento Cartão de Débito e Token de Bandeira (débito).

Bandeiras de Cartão de Crédito: VISA, MASTERCARD, AMEX, ELO.

Bandeiras de Token de Bandeira (Crédito): VISA, MASTERCARD, ELO.

Informar true para cobrança em único passo. Informar false para pré-autorizar.

capture_before Datetime
Data e horário limite para que seja feita a captura em uma transação com o status AUTHORIZED.
Exemplo: 2023-02-18T15:15:11.881-03:00

MASTERCARD,VISA e ELO permitirá à captura em até 29 dias para MCCs permitidos pelas bandeiras. Lista de MCCs disponíveis.

Demais bandeiras permitirá à captura em até 6 dias.

soft_descriptor String (0-17 caracteres)
Parâmetro responsável pelo que será exibido como Nome na Fatura do cliente. Aplicável no momento apenas para Cartão de crédito. Não permite caracteres especiais (acentuações serão substituídas por caracteres sem acentos, demais caracteres especiais serão removidos).
Exemplo: IntegraçãoPagBank

card Object

Contém os dados de Cartão de Crédito, Cartão de Débito e Token de Bandeira. Obrigatório para o método de pagamento Cartão de Crédito, Cartão de Débito e Token de Bandeira.

id String (41 caracteres)
Identificador PagBank do Cartão de Crédito salvo (Cartão Tokenizado pelo PagBank). Função indisponível para o método de pagamento Cartão de Débito e Token de Bandeira.
Exemplo: CARD_CCFE8D12-79E9-4ADF-920B-A54E51D8DA6E

number String (14-19 caracteres)
Número do Cartão de Crédito ou Cartão de Débito.
Exemplo: 4111111111111111

network_token String (14-19 caracteres)
Número do Token de Bandeira.
Exemplo: 1234567890000000

exp_month Int (1/2 caracteres)
Mês de expiração do Cartão de Crédito, Cartão de Débito ou Token de Bandeira.
Exemplo: 12

exp_year Int (3/4 caracteres)
Ano de expiração do Cartão de Crédito, Cartão de Débito ou Token de Bandeira.
Exemplo: 2026

security_code Int (3/4 caracteres)
Código de Segurança do Cartão de Crédito, Cartão de Débito ou Token de Bandeira.
Exemplo: 2026

store Boolean
Indica se o cartão deverá ser armazenado no PagBank para futuras compras. Função indisponível para o método de pagamento Cartão de Débito e Token de Bandeira.
Informar false ou omitir este parâmetro fará com que o cartão não seja armazenado. Informar true fará com que o cartão seja armazenado. Na resposta da requisição irá receber o token do cartão em payment_method.card.id.

brand String (20 caracteres)
Bandeira do cartão.
Exemplo: visa

product String (20 caracteres)
Retornado quando um Cartão de Crédito foi do tipo PRE_PAID.
Exemplo:

first_digits Int (6 caracteres)
Seis primeiros números do Cartão ou Token de Bandeira (BIN).
Exemplo: 411111

last_digits Int (4 caracteres)
Quatro últimos números do Cartão ou Token de Bandeira.
Exemplo: 1111

holder Object

Contém as informações do portador do Cartão de Crédito, Cartão de Débito e Token de Bandeira.

name String (1-30 caracteres)
Nome do portador do Cartão de Crédito, Cartão de Débito e Token de Bandeira.
Exemplo: Jose da Silva

tax_id String (11/14 caracteres)
Número do documento (CPF ou CPNJ) do portador do Cartão de Crédito, Cartão de Débito e Token de Bandeira.
Exemplo: 12345678910

token_data Object

Contém os dados adicionais de Tokenização de Rede. Deve ser enviado quando um Cartão de Crédito ou Débito tokenizado pelas bandeiras Visa ou Mastercard é utilizado.

requestor_id String(11)
Identificador de quem gerou o Token de Bandeira (Token Requestor).
Exemplo: 12345678901

wallet ENUM
Tipo de carteira que armazenou o Token de Bandeira.
Valores de ENUM:

APPLE_PAY

GOOGLE_PAY

SAMSUNG_PAY

MERCHANT_TOKENIZATION_PROGRAM

cryptogram String(40)
Criptograma gerado pela bandeira.
Exemplo:

ecommerce_domain String(150)
Identificador do domínio de origem da transação, comumente caracterizado em um formato de domínio reverso.
Exemplo: br.com.pagbank

assurance_level Int(2)
Conteúdo que indica o nível de confiança do token de rede.
Exemplo: 99

authentication_method Object

Contém os dados adicionais de autenticação vinculados à uma transação. Obrigatório quando payment_method.type = DEBIT_CARD.

type ENUM
Indica o método de autenticação utilizado na cobrança. Condicional para Token de Bandeira ELO.
Valores de ENUM:

THREEDS se o método de autenticação utilizado for 3DS.

INAPP se o método de autenticação utilizado for InApp.

cavv String(80)
Identificador único gerado em cenário de sucesso de autenticação do cliente.
Exemplo: BwABBylVaQAAAAFwllVpAAAAAAA=

eci String(2)
Indicador E-Commerce retornado quando ocorre uma autenticação. Corresponde ao resultado da autenticação.
Exemplo: 01

xid String(80)
Identificador de uma transação de um MPI - Recomendado para a bandeira VISA. Condicional para 3DS.
Exemplo: BwABBylVaQAAAAFwllVpAAAAAAA=

version String(10)
Versão do protocolo 3DS utilizado na autenticação.
Exemplo: 2.0.1

dstrans_id String(80)
ID da transação gerada pelo servidor de diretório durante uma autenticação - Recomendado para a bandeira Mastercard. Condicional para 3DS.
Exemplo: DIR_SERVER_TID

status String(80)
Status de uma autenticação 3DS.
Exemplo: AUTHENTICATED

boleto Object

Contém os dados para geração do Boleto.

due_date String (10 caracteres)
Data de vencimento do Boleto. Formato: “yyyy-MM-dd”
Exemplo: 2023-02-10

instruction_lines Object

Contém as linhas de instrução do boleto.

line_1 String (1-75 caracteres)
Primeira linha de instruções sobre o pagamento do Boleto.
Exemplo: Pagamento processado para DESC Fatura

line_2 String (1-75 caracteres)
Segunda linha de instruções sobre o pagamento do Boleto.
Exemplo: Via PagBank

holder Object

Contém as as informações do responsável pelo pagamento do Boleto.

name String (1-30 caracteres)
Nome do responsável pelo pagamento do Boleto.
Exemplo: Jose da Silva

tax_id String (11/14 caracteres)
Número do documento do responsável pelo pagamento do Boleto.
Exemplo: 12345678902

email String (10-255 caracteres)
E-mail do responsável pelo pagamento do Boleto.
Exemplo: [email protected]

address Object

Contém informações do endereço do dono da conta ou sócio da empresa.