Este objeto é responsável por apresentar todos os dados disponíveis em uma transferência.
Atributos
amount Object
Objeto que contém as informações do valor a ser transacionado.
value String
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
description String
Descrição da transferência. Caso o campo seja enviado, deve conter no mínimo 1 e, no máximo, 72 caracteres
alfanuméricos.
Exemplo: Valor referente as vendas do dia 01/01
reference_id String
Identificador próprio atribuído para a transferência. Tamanho máximo permitido: 64 caracteres alfanuméricos.
Exemplo: referencia_cliente12345
instrument Object
Objeto contendo as informações da transferência.
type ENUM
Tipo da transação. 
A utilização de transferência utilizando
PIX precisa da liberação do time comercial do PagBank. Caso liberado, obrigatoriamente, deve enviar o objeto
"pix". Ao selecionar o tipo de transferência PIX, a
transferência pode ser feita utilizando os dados do PIX do recebedor ou os dados da conta bancária.
Caso você selecione "P2P", obrigatoriamente, deve enviar o objeto "p2p".
Valores de ENUM:
P2P(transferência entre contas Pags).PIX(transferência para outros domicílios bancários).
p2p Object
Objeto que contém as informações da conta destino para uma transferência entre contas PagBank.
Caso o type seja "P2P", este é um objeto obrigatório.
Caso o type seja "P2P", este é um objeto obrigatório.
branch String
Agência bancária do recebedor (Máximo 10 caracteres). Para uma transferência P2P, você deve
obrigatoriamente enviar os campos bank_branch e account_number ou o
account_id.
Exemplo: 1234
account_number String
Número da conta do recebedor (Máximo 20 caracteres). Para uma transferência P2P, você deve
obrigatoriamente enviar os campos bank_branch e account_number ou o
account_id.
O número da conta deve conter o digito verificador sem o hífen.
Exemplo: 1234567
account_id String
Identificador da conta destino PagBank. Para uma transferência P2P, o campo
email ou account_id deve, obrigatoriamente, ser enviado.
Exemplo: [email protected]
pix Object
Objeto que contém informações sobre transferência para outros domicílios bancários.
Os campos key e tax_id são obrigatórios caso a transferência utilize o sistema
PIX. Já se a transferência for convencional, os campos bank_ispb, bank_branch,
account_number e account_type são obrigatórios.
Os campos key e tax_id são obrigatórios caso a transferência utilize o sistema
PIX. Já se a transferência for convencional, os campos bank_ispb, bank_branch,
account_number e account_type são obrigatórios.
key String
Chave que identifica a conta destino para uma transferência via PIX.
Campo obrigatório para uma transferência PIX.
Exemplo: chavePIXdaConta
name String (140 caracteres)
Nome completo do recebedor.
Exemplo: João 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 rede.
Exemplo: 12345678910
bank_ispb String (8 caracteres)
ISPB do banco do recebedor. Devem ser enviados apenas números.
Exemplo: 12345678
bank_branch String (8 caracteres)
Agência bancária do recebedor.
Exemplo: 1234
account_number String (20 caracteres)
Número da conta do recebedor.
Exemplo: 1234567
account_type ENUM
Tipo de conta do recebedor.
Valores de ENUM:
CCPPPGCS
notification_urls String
Contém as URLs que receberão as notificações do pedido (por ora, somente aceitamos uma url apenas. Aceitaremos
mais URLs em breve.)
Exemplo: https://webhook.site/067fc99b-88e7-4e30-8f74-609901413fe7