Links de pagamento

Parâmetros

McpfPay-Accountstring · cabeçalho

Obrigatório para chaves de parceiro. Id da conta conectada em nome da qual a operação é feita.

statusactive | paid | expired | canceled · consulta

—

external_referencestring · consulta

—

limitinteger · consulta

—

starting_afterstring · consulta

Id do último item da página anterior.

Resposta

has_moreobrigatórioboolean

—

datalista de object

—

data[].idobrigatóriostring

—

data[].account_idobrigatóriostring

—

data[].statusobrigatórioactive | paid | expired | canceled

—

data[].titleobrigatóriostring

—

data[].amountobrigatóriointeger

Valor em centavos de real.

data[].methodsobrigatóriolista de string

—

data[].max_installmentsinteger

—

data[].fee_payermerchant | payer

merchant: a taxa sai do valor recebido. payer: a taxa é somada ao que o pagador paga, e a conta recebe o amount integral.

data[].urlobrigatóriostring

Link curto no domínio pagar.mcpfpay.com.br.

data[].allow_multiple_paymentsboolean

—

data[].charges_countinteger

Pagamentos recebidos por este link.

data[].external_referencestring ou nulo

—

data[].metadataobject

Até 20 pares chave/valor do seu sistema. Devolvidos em respostas e eventos.

data[].expires_atstring

—

data[].created_atobrigatóriostring

—

Códigos de resposta

• 200 Página de links.
• 401 Chave ausente, inválida ou revogada.

Parâmetros

McpfPay-Accountstring · cabeçalho

Obrigatório para chaves de parceiro. Id da conta conectada em nome da qual a operação é feita.

Idempotency-Keystring · cabeçalho

Até 255 caracteres. Mesma chave em 24 horas devolve a mesma resposta.

Corpo da requisição (JSON)

titleobrigatóriostring

—

amountobrigatóriointeger

Valor em centavos de real.

methodsobrigatóriolista de card | pix | boleto | google_pay | apple_pay

—

max_installmentsinteger

Teto de parcelas no cartão. Parcela mínima de R$ 5,00.

fee_payermerchant | payer

merchant: a taxa sai do valor recebido. payer: a taxa é somada ao que o pagador paga, e a conta recebe o amount integral.

payerobrigatórioobject

Pré-preenche a página hospedada, que exige nome, documento e e-mail.

payer.nameobrigatóriostring

—

payer.documentobrigatóriostring

CPF (11 dígitos) ou CNPJ (14 dígitos), só números.

payer.emailobrigatóriostring

—

payer.phonestring

DDD + número, 10 ou 11 dígitos, sem o 55.

payer.addressobject

—

payer.address.streetobrigatóriostring

—

payer.address.numberobrigatóriostring

—

payer.address.complementstring

—

payer.address.neighborhoodobrigatóriostring

—

payer.address.cityobrigatóriostring

—

payer.address.stateobrigatórioAC | AL | AP | AM | BA | CE | DF | ES | GO | MA | MS | MT | MG | PA | PB | PR | PE | PI | RJ | RN | RS | RO | RR | SC | SP | SE | TO

—

payer.address.zip_codeobrigatóriostring

—

boletoobject

—

boleto.due_dateobrigatóriostring

—

boleto.days_until_expirationinteger

Dias após o vencimento em que o boleto ainda pode ser pago.

boleto.fineobject

—

boleto.fine.percentageobrigatóriostring

Ex.: 2.00 para 2%.

boleto.fine.after_daysinteger

—

boleto.interest_monthly_percentagestring

Juros ao mês. Ex.: 1.00 para 1%.

boleto.discountslista de object

—

boleto.discounts[].amountobrigatóriointeger

Valor em centavos de real.

boleto.discounts[].untilobrigatóriostring

—

boleto.messageslista de string

—

boleto.document_kindDUPLICATA_MERCANTIL | DUPLICATA_SERVICO | NOTA_PROMISSORIA | RECIBO | OUTROS

—

discountslista de object

Desconto por meio de pagamento, por exemplo 5% no Pix.

discounts[].methodobrigatóriocard | pix | boleto

—

discounts[].typeobrigatóriopercentage | amount

—

discounts[].valueobrigatórionumber

—

pix_expires_in_minutesinteger

—

expires_in_minutesinteger

Validade do link. Padrão 24 horas, máximo 30 dias.

allow_multiple_paymentsboolean

true para links reutilizáveis (ex.: link fixo de doação ou de mensalidade).

external_referencestring

—

send_tolista de whatsapp | email

Envia o link ao payer pelos canais indicados.

metadataobject

Até 20 pares chave/valor do seu sistema. Devolvidos em respostas e eventos.

Resposta

idobrigatóriostring

—

account_idobrigatóriostring

—

statusobrigatórioactive | paid | expired | canceled

—

titleobrigatóriostring

—

amountobrigatóriointeger

Valor em centavos de real.

methodsobrigatóriolista de string

—

max_installmentsinteger

—

fee_payermerchant | payer

merchant: a taxa sai do valor recebido. payer: a taxa é somada ao que o pagador paga, e a conta recebe o amount integral.

urlobrigatóriostring

Link curto no domínio pagar.mcpfpay.com.br.

allow_multiple_paymentsboolean

—

charges_countinteger

Pagamentos recebidos por este link.

external_referencestring ou nulo

—

metadataobject

Até 20 pares chave/valor do seu sistema. Devolvidos em respostas e eventos.

expires_atstring

—

created_atobrigatóriostring

—

Códigos de resposta

• 201 Link criado.
• 400 Parâmetro ausente ou inválido.
• 403 Sem conexão ativa com a conta, escopo insuficiente ou conta sem a capacidade exigida.
• 422 Regra de negócio recusou a operação (limite da conta, valor mínimo de parcela, dados do pagador incompletos).
• 502 A infraestrutura de pagamentos não respondeu. A operação pode ser repetida com a mesma `Idempotency-Key`.

Parâmetros

McpfPay-Accountstring · cabeçalho

Obrigatório para chaves de parceiro. Id da conta conectada em nome da qual a operação é feita.

payment_link_idobrigatóriostring · caminho

—

Resposta

idobrigatóriostring

—

account_idobrigatóriostring

—

statusobrigatórioactive | paid | expired | canceled

—

titleobrigatóriostring

—

amountobrigatóriointeger

Valor em centavos de real.

methodsobrigatóriolista de string

—

max_installmentsinteger

—

fee_payermerchant | payer

merchant: a taxa sai do valor recebido. payer: a taxa é somada ao que o pagador paga, e a conta recebe o amount integral.

urlobrigatóriostring

Link curto no domínio pagar.mcpfpay.com.br.

allow_multiple_paymentsboolean

—

charges_countinteger

Pagamentos recebidos por este link.

external_referencestring ou nulo

—

metadataobject

Até 20 pares chave/valor do seu sistema. Devolvidos em respostas e eventos.

expires_atstring

—

created_atobrigatóriostring

—

Códigos de resposta

• 200 Link.
• 404 Recurso não encontrado para esta chave.

Parâmetros

McpfPay-Accountstring · cabeçalho

Obrigatório para chaves de parceiro. Id da conta conectada em nome da qual a operação é feita.

payment_link_idobrigatóriostring · caminho

—

Idempotency-Keystring · cabeçalho

Até 255 caracteres. Mesma chave em 24 horas devolve a mesma resposta.

Resposta

idobrigatóriostring

—

account_idobrigatóriostring

—

statusobrigatórioactive | paid | expired | canceled

—

titleobrigatóriostring

—

amountobrigatóriointeger

Valor em centavos de real.

methodsobrigatóriolista de string

—

max_installmentsinteger

—

fee_payermerchant | payer

merchant: a taxa sai do valor recebido. payer: a taxa é somada ao que o pagador paga, e a conta recebe o amount integral.

urlobrigatóriostring

Link curto no domínio pagar.mcpfpay.com.br.

allow_multiple_paymentsboolean

—

charges_countinteger

Pagamentos recebidos por este link.

external_referencestring ou nulo

—

metadataobject

Até 20 pares chave/valor do seu sistema. Devolvidos em respostas e eventos.

expires_atstring

—

created_atobrigatóriostring

—

Códigos de resposta

• 200 Link cancelado.
• 404 Recurso não encontrado para esta chave.
• 409 Estado não permite a operação, ou `Idempotency-Key` reutilizada com outro corpo.