Recebedores

Modelagem de recipients e split de pagamentos na Pagar.me v5.

Documentação legada do Pagar.me v5

Esta página descreve um conceito da Pagar.me v5 (versão clássica). Para projetos novos, explore o API Catalog.

Um recipient é um recebedor — vendedor ou empresa que expõe produtos dentro do seu Marketplace. Dentro do ambiente Pagar.me é atribuído um saldo a esse recebedor de acordo com as transações criadas para ele. O primeiro passo para dividir transações entre diferentes recebedores é criar o objeto recipient pela API.

É através de um recipient que você especifica suas regras de split, para que os valores a receber sejam automaticamente atribuídos a cada um dos sellers envolvidos na transação.

Parâmetros de um recebedor

CampoDefinição
nameNome do recebedor
emailE-mail do recebedor
descriptionDescrição do recebedor
documentCPF ou CNPJ do recebedor
typeindividual (PF) ou corporation (PJ)
default_bank_accountDados bancários para repasse
transfer_settingsConfiguração de antecipação e transferência
metadataDados customizados (até 20 pares chave/valor)

Funcionalidades relacionadas

  • Criar recebedor
  • Atualizar dados bancários
  • Configurar transfer_interval (daily/weekly/monthly)
  • Listar saldos
  • Listar transferências

Split em uma transação

{
  "amount": 50000,
  "payment_method": "credit_card",
  "split": [
    {
      "amount": 40000,
      "recipient_id": "rp_aN9k7xWp...",
      "type": "flat",
      "options": { "charge_processing_fee": true }
    },
    {
      "amount": 10000,
      "recipient_id": "rp_pQ8m2vZb...",
      "type": "flat"
    }
  ]
}
Na API Unificada Stone

Marketplaces com até 15 recebedores por cobrança e regras flat/percent. Veja Split de pagamentos ou Marketplace use case.


Jornada: Montar um marketplace
Etapa 3 de 10