Experimente nossa plataforma

Pagar.me

Adicionando o conector

Requisitos

  1. Este conector requer a versão V5 (2021-09-01) da API (também conhecida como Pagar.me 2.0)
  2. Você deve seguir este tutorial com o acesso de Administrador

Instruções

  1. Faça login em sua conta do Pagar.me com um usuário que possua acesso de Administrador
  2. Caso possua várias contas, na página de Empresas, selecione Empresas 2.0 > Produção > Sua conta
  3. Em sua conta, na lateral direita, clique em Configurações > Chaves
  4. Na página de Chaves, clique em Criar chave
  5. No modal que irá abrir, dê um nome para sua chave e em Acesso da chave escolha Personalizado e então clique em Avançar
  6. Na próxima tela, em Selecione os escopos faça o seguinte:
    1. Ative Transacional  com permissão Somente leitura
    2. Ative Financeiro  com permissão Somente leitura
    3. Ative Recebedores  com permissão Somente leitura
    4. Clique em Criar chave
  7. Clique em Copiar chave secreta e depois Concluir
  8. Faça login na Kondado > clique em CRIAR + > Conector > Pagar.me > em Chave de API copie o valor obtido > clique em SALVAR
  9. IMPORTANTE: Caso utilize a funcionalidade de IPs permitidos, é necessário também seguir estas instruções

Integrações

Índice

Gráfico de relacionamento

Clique para ampliar

Clientes

Objeto principal

Campo Tipo

id

text

[pt] Identificador único do cliente

address_city

text

[pt] Cidade.

address_country

text

[pt] País (Código do país no formato ISO 3166-1 alpha-2) (2 dígitos).

address_created_at

timestamp

[pt] Data de criação do endereço.

address_id

text

[pt] Identificador único do endereço.

address_line_1

text

[pt] Dados principais do endereço. Neste campo deve ser informado Número, Rua, Bairro, nesta ordem e separados por vírgula.

address_line_2

text

[pt] Dados complementares do endereço. Neste campo pode ser informado complemento, referências.

address_state

text

[pt] Estado (Código do estado no formato ISO 3166-2).

address_status

text

[pt] Status do endereço (ativo ou inativo).

address_updated_at

timestamp

[pt] Data da última atualização do endereço.

address_zip_code

text

[pt] Código Postal (CEP) (Apenas numérico).

birthdate

date

[pt] Data de nascimento do cliente. Padrão mm/dd/aaaa.

code

text

[pt] Código de referência do cliente no sistema da loja. Máx: 52 caracteres.

created_at

timestamp

[pt] Data de criação do cliente no sistema.

delinquent

boolean

[pt] Indica se o cliente está inadimplente.

document

text

[pt] CPF, CNPJ ou PASSPORT do cliente. Máx: 16 caracteres para CPF e CNPJ e Máx: 50 caracteres para PASSPORT.

document_type

text

[pt] Tipo de documento. Valores possíveis: CPF, CNPJ ou PASSPORT.

email

text

[pt] E-mail do cliente. Máx: 64 caracteres.

name

text

[pt] Nome do cliente. Máx: 64 caracteres.

phones_home_phone_country_code

text

[pt] Código do País do telefone residencial (Apenas numérico)

phones_home_phone_area_code

text

[pt] Código da área do telefone residencial (Apenas numérico).

phones_home_phone_number

text

[pt] Número do telefone residencial (Apenas numérico).

phones_mobile_phone_number

text

[pt] Código da área do telefone celular (Apenas numérico).

phones_mobile_phone_country_code

text

[pt] Código do País do telefone celular (Apenas numérico).

phones_mobile_phone_area_code

text

[pt] Código da área do telefone celular (Apenas numérico).

type

text

[pt] Tipo de cliente. Valores possíveis: individual (pessoa física) ou company (pessoa jurídica). Obrigatório, caso o document seja enviado.

updated_at

timestamp

[pt] Data da última atualização dos dados do cliente.

pagarme_customers_metadata

Campo Tipo

customer_id

text

[pt] Identificador único do cliente

metadata_key

text

[pt] Chave do metadado

metadata_value

text

[pt] Valor do metadado

Clientes: cartões

Objeto principal

Campo Tipo

customer_id

text

[pt] Identificador único do cliente ao qual o cartão está associado.

    Clientes > > id

card_id

text

[pt] Identificador único do cartão na API.

brand

text

[pt] Bandeira do cartão. Valores possíveis: elo, mastercard, visa, amex, jcb, aura, hipercard, diners, unionpay, discover.

created_at

timestamp

[pt] Data e hora da criação do cartão

exp_month

text

[pt] Mês de validade do cartão.

exp_year

text

[pt] Ano de validade do cartão.

first_six_digits

text

[pt] Os primeiros seis dígitos do número do cartão.

holder_name

text

[pt] Nome do portador do cartão como impresso. Máx: 64 caracteres.

last_four_digits

text

[pt] Os últimos quatro dígitos do número do cartão.

status

text

[pt] Status do cartão na API. Exemplo: ativo ou inativo.

type

text

[pt] Tipo do cartão. Exemplo: crédito ou débito.

updated_at

timestamp

[pt] Data e hora da última atualização do cartão

pagarme_customer_cards_metadata

Campo Tipo

customer_id

text

[pt] Identificador único do cliente ao qual o cartão está associado.

    Clientes > > id

card_id

text

[pt] Identificador único do cartão na API.

metadata_key

text

[pt] Chave do metadado.

metadata_value

text

[pt] Valor do metadado.

Clientes: endereços

Objeto principal

Campo Tipo

customer_id

text

[pt] Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.

    Clientes > > id

address_id

text

[pt] Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.

city

text

[pt] Cidade do endereço. Máx: 64 caracteres.

country

text

[pt] Código do país no formato.

created_at

timestamp

[pt] Data e hora da criação.

line_1

text

[pt] Linha 1 do endereço. Deve conter Número, Rua e Bairro, nesta ordem e separados por vírgula.

line_2

text

[pt] Linha 2 do endereço. Complemento como Andar, Sala ou Apto.

state

text

[pt] Código do estado no formato.

status

text

[pt] Status na API. Exemplo: ativo ou inativo.

updated_at

timestamp

[pt] Data e hora da última atualização.

zip_code

text

[pt] CEP do endereço. Apenas numérico.

pagarme_customer_addresses_metadata

Campo Tipo

customer_id

text

[pt] Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.

address_id

text

[pt] Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.

metadata_key

text

[pt] Chave do metadata.

metadata_value

text

[pt] Valor do metadata.

Cobranças

Objeto principal

Campo Tipo

id

text

[pt] Identificador único da cobrança.

amount

float

[pt] Valor total da cobrança.

code

text

[pt] Código da cobrança.

created_at

timestamp

[pt] Data e hora da criação da cobrança.

currency

text

[pt] Moeda utilizada na cobrança.

customer_code

text

[pt] Código de referência do cliente.

customer_created_at

timestamp

[pt] Data e hora da criação do cliente.

customer_delinquent

boolean

[pt] Indica se o cliente está inadimplente.

customer_document

text

[pt] Número do documento do cliente.

customer_document_type

text

[pt] Tipo do documento do cliente.

customer_email

text

[pt] E-mail do cliente.

customer_id

text

[pt] Identificador único do cliente.

    Clientes > > id

customer_name

text

[pt] Nome do cliente.

customer_phones_home_phone_country_code

text

[pt] Código do país do telefone residencial.

customer_phones_home_phone_number

text

[pt] Número do telefone residencial.

customer_phones_home_phone_area_code

text

[pt] Código de área do telefone residencial.

customer_type

text

[pt] Tipo do cliente (pessoa física ou empresa).

customer_updated_at

timestamp

[pt] Data e hora da última atualização do cliente.

gateway_id

text

[pt] Identificador da cobrança no gateway de pagamento.

last_transaction_acquirer_message

text

[pt] Mensagem do adquirente.

last_transaction_acquirer_name

text

[pt] Nome do adquirente da transação.

last_transaction_acquirer_nsu

text

[pt] NSU do adquirente.

last_transaction_acquirer_return_code

text

[pt] Código de retorno do adquirente.

last_transaction_acquirer_tid

text

[pt] TID do adquirente.

last_transaction_amount

float

[pt] Valor total da transação.

last_transaction_brand_id

text

[pt] Identificador da bandeira do cartão.

last_transaction_card_last_four_digits

text

[pt] Os últimos quatro dígitos do cartão.

last_transaction_card_brand

text

[pt] Bandeira do cartão.

last_transaction_card_holder_name

text

[pt] Nome do titular do cartão.

last_transaction_card_exp_month

text

[pt] Mês de expiração do cartão.

last_transaction_card_exp_year

text

[pt] Ano de expiração do cartão.

last_transaction_card_status

text

[pt] Status do cartão.

last_transaction_card_type

text

[pt] Tipo do cartão (crédito ou débito).

last_transaction_card_created_at

timestamp

[pt] Data e hora de criação do cartão.

last_transaction_card_updated_at

timestamp

[pt] Data e hora da última atualização do cartão.

last_transaction_card_first_six_digits

text

[pt] Os primeiros seis dígitos do cartão.

last_transaction_created_at

timestamp

[pt] Data e hora da criação da última transação.

last_transaction_funding_source

text

[pt] Fonte de financiamento da transação.

last_transaction_gateway_id

text

[pt] Identificador da transação no gateway.

last_transaction_id

text

[pt] Identificador único da transação.

last_transaction_installments

float

[pt] Número de parcelas da transação.

last_transaction_operation_type

text

[pt] Tipo da operação da transação.

last_transaction_statement_descriptor

text

[pt] Descrição da transação exibida no extrato.

last_transaction_status

text

[pt] Status da transação.

last_transaction_success

boolean

[pt] Indica se a transação foi bem-sucedida.

last_transaction_transaction_type

text

[pt] Tipo da transação.

last_transaction_updated_at

timestamp

[pt] Data e hora da última atualização da transação.

order_amount

float

[pt] Valor total do pedido.

order_closed

boolean

[pt] Indica se o pedido foi encerrado.

order_closed_at

timestamp

[pt] Data e hora do fechamento do pedido.

order_code

text

[pt] Código do pedido.

order_created_at

timestamp

[pt] Data e hora da criação do pedido.

order_currency

text

[pt] Moeda utilizada no pedido.

order_customer_id

text

[pt] Identificador do cliente associado ao pedido.

order_id

text

[pt] Identificador único do pedido.

order_status

text

[pt] Status do pedido.

order_updated_at

timestamp

[pt] Data e hora da última atualização do pedido.

payment_method

text

[pt] Método de pagamento utilizado.

status

text

[pt] Status da cobrança.

updated_at

timestamp

[pt] Data e hora da última atualização da cobrança.

pagarme_last_transaction_metadata

Campo Tipo

charge_id

text

[pt] Identificador único do objeto na API.

last_transaction_metadata_key

text

[pt] Chave do metadata.

last_transaction_metadata_last_transaction_id

text

[pt] Chave do id de last_transaction.

last_transaction_metadata_value

text

[pt] Valor do metadata.

Operações de saldo

Campo Tipo

id

text

[pt] Identificador único da operação de saldo.

amount

float

[pt] Valor total envolvido na operação de saldo.

balance_amount

float

[pt] Valor do saldo disponível após a operação.

created_at

timestamp

[pt] Data e hora da criação da operação de saldo.

fee

float

[pt] Taxa cobrada na operação de saldo.

movement_object_amount

float

[pt] Valor total envolvido no objeto da operação de saldo.

movement_object_brand

text

[pt] Bandeira associada à operação de saldo.

movement_object_document

text

[pt] Documento do destinatário da operação de saldo.

movement_object_document_type

text

[pt] Tipo de documento do destinatário da operação de saldo.

movement_object_external_engine_payment_id

text

[pt] Identificador do pagamento no motor externo associado à operação de saldo.

movement_object_id

text

[pt] Identificador único do objeto relacionado à operação de saldo.

movement_object_liquidation_arrangement_id

text

[pt] Identificador do arranjo de liquidação da operação de saldo.

movement_object_object

text

[pt] Tipo do objeto relacionado à operação de saldo.

movement_object_product

text

[pt] Produto relacionado à operação de saldo.

movement_object_description

text

[pt] Tipo do objeto relacionado à operação de saldo.

movement_object_payment_date

timestamp

[pt] Tipo do objeto relacionado à operação de saldo.

movement_object_recipient_id

text

[pt] Tipo do objeto relacionado à operação de saldo.

movement_object_type

text

[pt] Tipo do objeto relacionado à operação de saldo.

movement_object_created_at

text

[pt] Tipo do objeto relacionado à operação de saldo.

movement_object_target_type

text

[pt] Tipo de destino da operação de saldo.

movement_object_fee

float

[pt] Taxa cobrada pela operação de saldo.

movement_object_target_id

text

[pt] Identificador do destino da operação de saldo.

movement_object_source_type

text

[pt] Tipo de origem da operação de saldo.

movement_object_source_id

text

[pt] Identificador da origem da operação de saldo.

movement_object_funding_estimated_date

timestamp

[pt] Data estimada para a liquidação da operação de saldo.

movement_object_status

text

[pt] Status atual da operação de saldo.

movement_object_bank_account_account_check_digit

text

[pt] Dígito verificador da conta.

movement_object_bank_account_account_number

text

[pt] Número da conta.

movement_object_bank_account_bank

text

[pt] Banco registrado.

movement_object_bank_account_branch_number

text

[pt] Número da agência.

movement_object_bank_account_created_at

timestamp

[pt] Data de criação da conta.

movement_object_bank_account_holder_document

text

[pt] Documento do titular.

movement_object_bank_account_holder_name

text

[pt] Nome do titular.

movement_object_bank_account_holder_type

text

[pt] Tipo de titularidade.

movement_object_bank_account_type

text

[pt] Tipo da conta.

status

text

[pt] Status da operação de saldo.

type

text

[pt] Tipo da operação de saldo.

Pedidos

Objeto principal

Campo Tipo

id

text

[pt] Identificador único do objeto na API.

customer_id

text

[pt] Identificador único do cliente.

    Clientes > > id

amount

float

[pt] Valor total da transação. Padrão: 0.

closed

boolean

[pt] Indica se a transação está encerrada. Padrão: true.

closed_at

timestamp

[pt] Data e hora do fechamento da transação.

code

text

[pt] Código de referência do objeto.

created_at

timestamp

[pt] Data e hora da criação da transação.

currency

text

[pt] Moeda da transação.

customer_address_id

text

[pt] Identificador único do endereço.

customer_address_line_1

text

[pt] Linha 1 do endereço. Número, Rua e Bairro.

customer_address_line_2

text

[pt] Linha 2 do endereço. Complemento.

customer_address_zip_code

text

[pt] CEP do endereço.

customer_address_city

text

[pt] Cidade do endereço.

customer_address_country

text

[pt] Código do país do endereço.

customer_address_created_at

timestamp

[pt] Data e hora da criação do endereço.

customer_address_state

text

[pt] Código do estado do endereço.

customer_address_updated_at

timestamp

[pt] Data e hora da última atualização do endereço.

customer_address_status

text

[pt] Status do endereço.

customer_code

text

[pt] Código de referência do cliente.

customer_created_at

timestamp

[pt] Data e hora da criação do cliente.

customer_delinquent

boolean

[pt] Indica se o cliente está inadimplente. Padrão: true.

customer_document

text

[pt] Documento do cliente (CPF/CNPJ).

customer_document_type

text

[pt] Tipo de documento do cliente.

customer_email

text

[pt] E-mail do cliente.

customer_name

text

[pt] Nome do cliente.

customer_phones_home_phone_country_code

text

[pt] Código do país do telefone residencial.

customer_phones_home_phone_area_code

text

[pt] Código da área do telefone residencial.

customer_phones_home_phone_number

text

[pt] Número do telefone residencial.

customer_phones_mobile_phone_country_code

text

[pt] Código do país do telefone celular.

customer_phones_mobile_phone_area_code

text

[pt] Código da área do telefone celular.

customer_phones_mobile_phone_number

text

[pt] Número do telefone celular.

customer_type

text

[pt] Tipo de cliente (individual ou company).

customer_updated_at

timestamp

[pt] Data e hora da última atualização do cliente.

status

text

[pt] Status da transação.

updated_at

timestamp

[pt] Data e hora da última atualização da transação.

pagarme_orders_charges

Campo Tipo

order_id

text

[pt] Identificador único do objeto na API.

charges_id

text

[pt] Identificador único da cobrança.

    Cobranças > > id

charges_customer_id

text

[pt] Identificador único do cliente da cobrança.

    Clientes > > id

charges_amount

float

[pt] Valor total da cobrança. Padrão: 0.

charges_code

text

[pt] Código da cobrança.

charges_created_at

timestamp

[pt] Data e hora da criação da cobrança.

charges_currency

text

[pt] Moeda da cobrança.

charges_customer_name

text

[pt] Nome do cliente da cobrança.

charges_customer_email

text

[pt] E-mail do cliente da cobrança.

charges_customer_code

text

[pt] Código de referência do cliente da cobrança.

charges_customer_document

text

[pt] Documento do cliente da cobrança.

charges_customer_document_type

text

[pt] Tipo de documento do cliente da cobrança.

charges_customer_type

text

[pt] Tipo de cliente da cobrança (individual ou company).

charges_customer_delinquent

boolean

[pt] Indica se o cliente da cobrança está inadimplente. Padrão: false.

charges_customer_created_at

timestamp

[pt] Data e hora da criação do cliente da cobrança.

charges_customer_updated_at

timestamp

[pt] Data e hora da última atualização do cliente da cobrança.

charges_customer_address_id

text

[pt] Identificador único do endereço do cliente da cobrança.

charges_customer_address_line_1

text

[pt] Linha 1 do endereço do cliente da cobrança. Número, Rua e Bairro.

charges_customer_address_line_2

text

[pt] Linha 2 do endereço do cliente da cobrança. Complemento.

charges_customer_address_zip_code

text

[pt] CEP do endereço do cliente da cobrança.

charges_customer_address_city

text

[pt] Cidade do endereço do cliente da cobrança.

charges_customer_address_state

text

[pt] Código do estado do endereço do cliente da cobrança.

charges_customer_address_country

text

[pt] Código do país do endereço do cliente da cobrança.

charges_customer_address_status

text

[pt] Status do endereço do cliente da cobrança.

charges_customer_address_created_at

timestamp

[pt] Data e hora da criação do endereço do cliente da cobrança.

charges_customer_address_updated_at

timestamp

[pt] Data e hora da última atualização do endereço do cliente da cobrança.

charges_customer_phones_home_phone_country_code

text

[pt] Código do país do telefone residencial do cliente da cobrança.

charges_customer_phones_home_phone_number

text

[pt] Número do telefone residencial do cliente da cobrança.

charges_customer_phones_home_phone_area_code

text

[pt] Código da área do telefone residencial do cliente da cobrança.

charges_customer_phones_mobile_phone_number

text

[pt] Número do telefone celular do cliente da cobrança.

charges_customer_phones_mobile_phone_country_code

text

[pt] Código do país do telefone celular do cliente da cobrança.

charges_customer_phones_mobile_phone_area_code

text

[pt] Código da área do telefone celular do cliente da cobrança.

charges_gateway_id

text

[pt] Identificador da transação no gateway de pagamento.

charges_last_transaction_brand_id

text

[pt] Identificador da bandeira do cartão.

charges_last_transaction_id

text

[pt] Identificador único da transação.

charges_last_transaction_transaction_type

text

[pt] Tipo da transação.

charges_last_transaction_gateway_id

text

[pt] Identificador da transação no gateway.

charges_last_transaction_amount

float

[pt] Valor total da transação.

charges_last_transaction_status

text

[pt] Status da transação.

charges_last_transaction_success

boolean

[pt] Indica se a transação foi bem-sucedida.

charges_last_transaction_installments

float

[pt] Número de parcelas da transação.

charges_last_transaction_statement_descriptor

text

[pt] Descrição que aparecerá no extrato bancário.

charges_last_transaction_acquirer_name

text

[pt] Nome do adquirente da transação.

charges_last_transaction_acquirer_tid

text

[pt] TID do adquirente.

charges_last_transaction_acquirer_nsu

text

[pt] NSU do adquirente.

charges_last_transaction_acquirer_message

text

[pt] Mensagem do adquirente.

charges_last_transaction_acquirer_return_code

text

[pt] Código de retorno do adquirente.

charges_last_transaction_operation_type

text

[pt] Tipo da operação da transação.

charges_last_transaction_card_id

text

[pt] Identificador único do cartão.

charges_last_transaction_card_first_six_digits

text

[pt] Os primeiros seis dígitos do cartão.

charges_last_transaction_card_last_four_digits

text

[pt] Os últimos quatro dígitos do cartão.

charges_last_transaction_card_brand

text

[pt] Bandeira do cartão.

charges_last_transaction_card_holder_name

text

[pt] Nome do titular do cartão.

charges_last_transaction_card_exp_month

text

[pt] Mês de expiração do cartão.

charges_last_transaction_card_exp_year

text

[pt] Ano de expiração do cartão.

charges_last_transaction_card_status

text

[pt] Status do cartão.

charges_last_transaction_card_type

text

[pt] Tipo do cartão (crédito ou débito).

charges_last_transaction_card_created_at

timestamp

[pt] Data e hora de criação do cartão.

charges_last_transaction_card_updated_at

timestamp

[pt] Data e hora da última atualização do cartão.

charges_last_transaction_funding_source

text

[pt] Fonte de financiamento da transação.

charges_last_transaction_created_at

timestamp

[pt] Data e hora da criação da última transação.

charges_last_transaction_updated_at

timestamp

[pt] Data e hora da última atualização da transação.

charges_last_transaction_gateway_response_code

text

[pt] Código de resposta do gateway de pagamento.

charges_payment_method

text

[pt] Método de pagamento utilizado.

charges_status

text

[pt] Status da cobrança.

charges_updated_at

timestamp

[pt] Data e hora da última atualização da cobrança.

pagarme_orders_charges_last_transaction_metadata

Campo Tipo

order_id

text

[pt] Identificador único do objeto na API.

charges_last_transaction_metadata_charge_id

text

[pt] Chave do id de charge.

charges_last_transaction_metadata_key

text

[pt] Chave do metadata.

charges_last_transaction_metadata_last_transaction_id

text

[pt] Chave do id de last_transaction.

charges_last_transaction_metadata_value

text

[pt] Valor do metadata.

pagarme_orders_items

Campo Tipo

order_id

text

[pt] Identificador único do objeto na API.

items_id

text

[pt] Identificador único do item.

items_amount

float

[pt] Valor do item. Padrão: 0.

items_code

text

items_created_at

timestamp

[pt] Data e hora da criação do item.

items_description

text

[pt] Descrição do item.

items_quantity

float

[pt] Quantidade do item. Padrão: 0.

items_status

text

[pt] Status do item.

items_type

text

[pt] Tipo do item.

items_updated_at

timestamp

[pt] Data e hora da última atualização do item.

Recebedores

Objeto principal

Campo Tipo

id

text

[pt] Identificador único do recebedor na API.

automatic_anticipation_settings_delay

float

[pt] Número de dias de atraso para a antecipação automática.

automatic_anticipation_settings_enabled

boolean

[pt] Indica se a antecipação automática está ativada.

automatic_anticipation_settings_type

text

[pt] Tipo de antecipação automática configurada.

automatic_anticipation_settings_volume_percentage

float

[pt] Percentual do volume antecipado automaticamente.

created_at

timestamp

[pt] Data e hora da criação dos registros bancários do recebedor.

default_bank_account_account_check_digit

text

[pt] Dígito verificador da conta bancária.

default_bank_account_account_number

text

[pt] Número da conta do recebedor.

default_bank_account_bank

text

[pt] Código do banco da conta bancária cadastrada.

default_bank_account_branch_number

text

[pt] Número da agência da conta bancária cadastrada.

default_bank_account_created_at

timestamp

[pt] Data e hora da criação da conta do recebedor.

default_bank_account_holder_document

text

[pt] Documento do proprietário da conta bancária.

default_bank_account_holder_name

text

[pt] Nome do proprietário da conta bancária.

default_bank_account_holder_type

text

[pt] Tipo do proprietário da conta bancária.

default_bank_account_id

text

[pt] Id da conta bancária do recebedor.

default_bank_account_status

text

[pt] Status da conta bancária do recebedor.

default_bank_account_type

text

[pt] Tipo da conta bancária do recebedor.

default_bank_account_updated_at

timestamp

[pt] Data e hora da última atualização do recebedor.

document

text

[pt] Documento do recebedor.

kyc_details_status

text

[pt] Status da verificação de identidade.

kyc_details_status_reason

text

[pt] Motivo do status da verificação de identidade.

name

text

[pt] Nome do recebedor.

payment_mode

text

[pt] Forma de pagamento.

register_information_company_name

text

[pt] Nome do recebedor.

register_information_document

text

[pt] Documento do recebedor.

register_information_email

text

[pt] Email principal do recebedor.

register_information_main_address_city

text

[pt] Cidade do endereço principal do recebedor.

register_information_main_address_complementary

text

[pt] Complemento do endereço principal do recebedor.

register_information_main_address_neighborhood

text

[pt] Bairro do endereço principal do recebedor.

register_information_main_address_state

text

[pt] Estado do endereço principal do recebedor.

register_information_main_address_street

text

[pt] Rua do endereço principal do recebedor.

register_information_main_address_street_number

text

[pt] Número do endereço principal do recebedor.

register_information_main_address_zip_code

text

[pt] CEP do endereço principal do recebedor.

register_information_site_url

text

[pt] URL do site .

register_information_trading_name

text

[pt] Nome .

register_information_type

text

[pt] .

status

text

[pt] Status do recebedor.

transfer_settings_transfer_day

float

[pt] Dia da transferência.

transfer_settings_transfer_enabled

boolean

[pt] Indica se a transferência automática de saldo está habilitada.

transfer_settings_transfer_interval

text

[pt] Intervalo das transferências automáticas.

type

text

[pt] Tipo do recebedor.

updated_at

timestamp

[pt] Data e hora da última atualização do recebedor.

pagarme_recipients_gateway_recipients

Campo Tipo

recipient_id

text

[pt] Identificador único do gateway na API.

gateway_recipients_pgid

text

[pt] Identificador do destinatário no gateway de pagamento.

gateway_recipients_created_at

timestamp

[pt] Data e hora da criação do destinatário no gateway de pagamento.

gateway_recipients_gateway

text

[pt] Nome do gateway de pagamento associado ao destinatário.

gateway_recipients_status

text

[pt] Status do gateway do recipiente.

gateway_recipients_updated_at

timestamp

[pt] Data e hora da última atualização do gateway do recipiente.

pagarme_recipient_metadata

Campo Tipo

recipient_id

text

[pt] Identificador único do metadado do recipiente na API.

recipient_metadata_key

text

[pt] Chave do metadata.

recipient_metadata_value

text

[pt] Valor do metadata.

Recebíveis

Campo Tipo

id

text

[pt] Identificador único do recebível.

accrual_at

timestamp

[pt] Data e hora do repasse do recebível ao destinatário.

amount

float

[pt] Valor total do recebível.

anticipation_fee

float

[pt] Taxa de antecipação do recebível.

charge_id

text

[pt] Identificador da cobrança associada ao recebível.

    Cobranças > > id

created_at

timestamp

[pt] Data e hora da criação do recebível.

fee

float

[pt] Taxa cobrada sobre o recebível.

fraud_coverage_fee

float

[pt] Taxa de cobertura contra fraudes aplicada ao recebível.

gateway_id

text

[pt] Identificador da transação no gateway associada ao recebível.

installment

float

[pt] Número da parcela do recebível.

payment_date

timestamp

[pt] Data e hora prevista para o pagamento do recebível.

payment_method

text

[pt] Método de pagamento utilizado para o recebível.

recipient_id

text

[pt] Identificador do destinatário do recebível.

    Recebedores > > id

status

text

[pt] Status do recebível.

type

text

[pt] Tipo do recebível.

Notas

IPs permitidos

Caso utilize bloqueio de IP em sua conta, faça o seguinte:

  1. Na barra lateral, acesse CONFIGURAÇÕES > Conta
  2. Na página de Conta, vá para a seção Conta e clique em Editar
  3. Encontre a seção IPs permitidos e inclua todos os IPs listados aqui (lembre-se de não incluir o “/32”)
  4. Ao finalizar clique em Salvar alterações

Descrição dos campos

Devido à ausência de descrição de alguns campos na documentação da API, parte das descrições foi gerada com inteligência artificial com exemplos dos valores retornados

Beta

Este conector está em modo beta - nos avise se encontrar um resultado inesperado