Parceiro

Resposta

datalista de object

—

data[].periodobrigatóriostring

—

data[].statusobrigatórioopen | closed | paid

open durante o mês, closed após o fechamento, paid quando creditado na conta digital do parceiro.

data[].accounts_countinteger

—

data[].charges_countinteger

—

data[].gross_revenueinteger

Receita McpfPay sobre os clientes do parceiro.

data[].provider_costsinteger

—

data[].taxesinteger

—

data[].net_margininteger

—

data[].revenue_share_percentagenumber

—

data[].revenue_share_amountobrigatóriointeger

—

data[].paid_atstring ou nulo

—

Códigos de resposta

• 200 Extratos.
• 403 Sem conexão ativa com a conta, escopo insuficiente ou conta sem a capacidade exigida.

Parâmetros

periodobrigatóriostring · caminho

Mês de competência, YYYY-MM.

account_idstring · consulta

—

limitinteger · consulta

—

starting_afterstring · consulta

Id do último item da página anterior.

Resposta

has_moreobrigatórioboolean

—

datalista de object

—

data[].charge_idobrigatóriostring

—

data[].account_idobrigatóriostring

—

data[].external_referencestring ou nulo

—

data[].methodpix | boleto | card | google_pay | apple_pay

Em POST /v1/charges só pix e boleto. Os demais nascem de links de pagamento.

data[].channelonline | pos | tap

Onde a venda aconteceu. online: criada pela API, link ou página de pagamento. pos: maquininha. tap: aproximação no celular. Vendas presenciais nascem no aparelho, chegam como charge.created seguido de charge.paid e entram no repasse do parceiro conectado.

data[].installmentsinteger ou nulo

—

data[].amountinteger

—

data[].settled_atobrigatóriostring

—

data[].revenueobrigatórioobject

—

data[].revenue.markupinteger

Margem do plano de taxas.

data[].revenue.charge_feeinteger

Tarifa por cobrança acima da franquia gratuita.

data[].costobrigatóriointeger

Custo da infraestrutura de pagamentos.

data[].taxesobrigatóriointeger

—

data[].net_marginobrigatóriointeger

—

data[].shareobrigatóriointeger

Parte do parceiro nesta cobrança.

Códigos de resposta

• 200 Linhas do extrato.
• 403 Sem conexão ativa com a conta, escopo insuficiente ou conta sem a capacidade exigida.