Cobranças

Parâmetros

McpfPay-Accountstring · cabeçalho

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

statuspending | overdue | paid | expired | canceled | refunded | failed | in_dispute | chargeback · consulta

—

methodpix | boleto | card | google_pay | apple_pay · consulta

—

channelonline | pos | tap · consulta

Filtra vendas online, na maquininha (pos) ou no Tap (tap).

external_referencestring · consulta

—

payment_link_idstring · consulta

—

created_gtestring · consulta

—

created_ltestring · 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[].methodobrigatóriopix | 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[].point_of_saleobject ou nulo

Só em vendas presenciais.

data[].point_of_sale.terminalstring ou nulo

Número de identificação do terminal, quando o provedor informa.

data[].point_of_sale.entry_modechip | contactless | magnetic

—

data[].statusobrigatóriopending | overdue | paid | expired | canceled | refunded | failed | in_dispute | chargeback

pending: aguardando pagamento. overdue: boleto vencido que ainda pode ser pago. paid: pago e confirmado na infraestrutura. expired: prazo final passou sem pagamento. canceled: cancelada antes do pagamento. refunded: estornada. failed: recusada. in_dispute: contestação aberta pelo portador. chargeback: contestação perdida.

data[].public_urlstring ou nulo

Página pública da cobrança (QR Pix, copia e cola, linha digitável e PDF). Pode ser enviada ao pagador.

data[].amountobrigatóriointeger

Valor em centavos de real.

data[].amount_chargedinteger ou nulo

Valor efetivamente pago pelo pagador (inclui juros, multa, taxa repassada ou desconto).

data[].amount_netinteger ou nulo

Valor líquido creditado na conta digital, depois de taxas.

data[].feesinteger ou nulo

Total de taxas e tarifas desta cobrança.

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[].installmentsinteger ou nulo

—

data[].descriptionstring ou nulo

—

data[].external_referencestring ou nulo

—

data[].payment_link_idstring ou nulo

—

data[].payerobject

Quem paga. Para boleto e cartão o endereço completo e o telefone com DDD são obrigatórios.

data[].payer.nameobrigatóriostring

—

data[].payer.documentobrigatóriostring

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

data[].payer.emailstring

—

data[].payer.phonestring

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

data[].payer.addressobject

—

data[].payer.address.streetobrigatóriostring

—

data[].payer.address.numberobrigatóriostring

—

data[].payer.address.complementstring

—

data[].payer.address.neighborhoodobrigatóriostring

—

data[].payer.address.cityobrigatóriostring

—

data[].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

—

data[].payer.address.zip_codeobrigatóriostring

—

data[].pixobject ou nulo

—

data[].pix.emvstring

Código copia e cola.

data[].pix.qr_code_urlstring

Imagem PNG do QR.

data[].pix.expires_atstring

Quando este código vence. Um novo é gerado automaticamente se a cobrança seguir pendente.

data[].boletoobject ou nulo

—

data[].boleto.due_datestring

—

data[].boleto.digitable_linestring

—

data[].boleto.barcodestring

—

data[].boleto.pix_emvstring

QR Pix impresso no boleto.

data[].boleto.pdf_urlstring

—

data[].boleto.paid_viabarcode | pix

—

data[].cardobject ou nulo

—

data[].card.brandstring

—

data[].card.last4string

—

data[].settlementslista de object

Previsão e realização do crédito na conta, por parcela.

data[].settlements[].installmentinteger

—

data[].settlements[].amountinteger

—

data[].settlements[].expected_onstring

—

data[].settlements[].statuspending | settled

—

data[].failureobject ou nulo

—

data[].failure.codestring

—

data[].failure.messagestring

—

data[].metadataobject

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

data[].created_atobrigatóriostring

—

data[].paid_atstring ou nulo

—

data[].canceled_atstring ou nulo

—

data[].refunded_atstring ou nulo

—

Códigos de resposta

• 200 Página de cobranças.
• 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)

methodobrigatóriopix | boleto

—

amountobrigatóriointeger

Valor em centavos de real.

descriptionstring

—

external_referencestring

Id do título no seu ERP. Aparece em eventos e na conciliação.

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

Quem paga. Para boleto e cartão o endereço completo e o telefone com DDD são obrigatórios.

payer.nameobrigatóriostring

—

payer.documentobrigatóriostring

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

payer.emailstring

—

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

—

metadataobject

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

notify_payerboolean

Envia a cobrança ao WhatsApp do pagador (payer.phone obrigatório), com o link da página da cobrança.

Resposta

idobrigatóriostring

—

account_idobrigatóriostring

—

methodobrigatóriopix | boleto | card | google_pay | apple_pay

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

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.

point_of_saleobject ou nulo

Só em vendas presenciais.

point_of_sale.terminalstring ou nulo

Número de identificação do terminal, quando o provedor informa.

point_of_sale.entry_modechip | contactless | magnetic

—

statusobrigatóriopending | overdue | paid | expired | canceled | refunded | failed | in_dispute | chargeback

pending: aguardando pagamento. overdue: boleto vencido que ainda pode ser pago. paid: pago e confirmado na infraestrutura. expired: prazo final passou sem pagamento. canceled: cancelada antes do pagamento. refunded: estornada. failed: recusada. in_dispute: contestação aberta pelo portador. chargeback: contestação perdida.

public_urlstring ou nulo

Página pública da cobrança (QR Pix, copia e cola, linha digitável e PDF). Pode ser enviada ao pagador.

amountobrigatóriointeger

Valor em centavos de real.

amount_chargedinteger ou nulo

Valor efetivamente pago pelo pagador (inclui juros, multa, taxa repassada ou desconto).

amount_netinteger ou nulo

Valor líquido creditado na conta digital, depois de taxas.

feesinteger ou nulo

Total de taxas e tarifas desta cobrança.

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.

installmentsinteger ou nulo

—

descriptionstring ou nulo

—

external_referencestring ou nulo

—

payment_link_idstring ou nulo

—

payerobject

Quem paga. Para boleto e cartão o endereço completo e o telefone com DDD são obrigatórios.

payer.nameobrigatóriostring

—

payer.documentobrigatóriostring

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

payer.emailstring

—

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

—

pixobject ou nulo

—

pix.emvstring

Código copia e cola.

pix.qr_code_urlstring

Imagem PNG do QR.

pix.expires_atstring

Quando este código vence. Um novo é gerado automaticamente se a cobrança seguir pendente.

boletoobject ou nulo

—

boleto.due_datestring

—

boleto.digitable_linestring

—

boleto.barcodestring

—

boleto.pix_emvstring

QR Pix impresso no boleto.

boleto.pdf_urlstring

—

boleto.paid_viabarcode | pix

—

cardobject ou nulo

—

card.brandstring

—

card.last4string

—

settlementslista de object

Previsão e realização do crédito na conta, por parcela.

settlements[].installmentinteger

—

settlements[].amountinteger

—

settlements[].expected_onstring

—

settlements[].statuspending | settled

—

failureobject ou nulo

—

failure.codestring

—

failure.messagestring

—

metadataobject

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

created_atobrigatóriostring

—

paid_atstring ou nulo

—

canceled_atstring ou nulo

—

refunded_atstring ou nulo

—

Códigos de resposta

• 201 Cobrança criada.
• 400 Parâmetro ausente ou inválido.
• 401 Chave ausente, inválida ou revogada.
• 403 Sem conexão ativa com a conta, escopo insuficiente ou conta sem a capacidade exigida.
• 409 Estado não permite a operação, ou `Idempotency-Key` reutilizada com outro corpo.
• 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`.

Resposta

idobrigatóriostring

—

account_idobrigatóriostring

—

methodobrigatóriopix | boleto | card | google_pay | apple_pay

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

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.

point_of_saleobject ou nulo

Só em vendas presenciais.

point_of_sale.terminalstring ou nulo

Número de identificação do terminal, quando o provedor informa.

point_of_sale.entry_modechip | contactless | magnetic

—

statusobrigatóriopending | overdue | paid | expired | canceled | refunded | failed | in_dispute | chargeback

pending: aguardando pagamento. overdue: boleto vencido que ainda pode ser pago. paid: pago e confirmado na infraestrutura. expired: prazo final passou sem pagamento. canceled: cancelada antes do pagamento. refunded: estornada. failed: recusada. in_dispute: contestação aberta pelo portador. chargeback: contestação perdida.

public_urlstring ou nulo

Página pública da cobrança (QR Pix, copia e cola, linha digitável e PDF). Pode ser enviada ao pagador.

amountobrigatóriointeger

Valor em centavos de real.

amount_chargedinteger ou nulo

Valor efetivamente pago pelo pagador (inclui juros, multa, taxa repassada ou desconto).

amount_netinteger ou nulo

Valor líquido creditado na conta digital, depois de taxas.

feesinteger ou nulo

Total de taxas e tarifas desta cobrança.

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.

installmentsinteger ou nulo

—

descriptionstring ou nulo

—

external_referencestring ou nulo

—

payment_link_idstring ou nulo

—

payerobject

Quem paga. Para boleto e cartão o endereço completo e o telefone com DDD são obrigatórios.

payer.nameobrigatóriostring

—

payer.documentobrigatóriostring

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

payer.emailstring

—

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

—

pixobject ou nulo

—

pix.emvstring

Código copia e cola.

pix.qr_code_urlstring

Imagem PNG do QR.

pix.expires_atstring

Quando este código vence. Um novo é gerado automaticamente se a cobrança seguir pendente.

boletoobject ou nulo

—

boleto.due_datestring

—

boleto.digitable_linestring

—

boleto.barcodestring

—

boleto.pix_emvstring

QR Pix impresso no boleto.

boleto.pdf_urlstring

—

boleto.paid_viabarcode | pix

—

cardobject ou nulo

—

card.brandstring

—

card.last4string

—

settlementslista de object

Previsão e realização do crédito na conta, por parcela.

settlements[].installmentinteger

—

settlements[].amountinteger

—

settlements[].expected_onstring

—

settlements[].statuspending | settled

—

failureobject ou nulo

—

failure.codestring

—

failure.messagestring

—

metadataobject

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

created_atobrigatóriostring

—

paid_atstring ou nulo

—

canceled_atstring ou nulo

—

refunded_atstring ou nulo

—

Códigos de resposta

• 200 Cobrança.
• 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.

charge_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

—

methodobrigatóriopix | boleto | card | google_pay | apple_pay

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

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.

point_of_saleobject ou nulo

Só em vendas presenciais.

point_of_sale.terminalstring ou nulo

Número de identificação do terminal, quando o provedor informa.

point_of_sale.entry_modechip | contactless | magnetic

—

statusobrigatóriopending | overdue | paid | expired | canceled | refunded | failed | in_dispute | chargeback

pending: aguardando pagamento. overdue: boleto vencido que ainda pode ser pago. paid: pago e confirmado na infraestrutura. expired: prazo final passou sem pagamento. canceled: cancelada antes do pagamento. refunded: estornada. failed: recusada. in_dispute: contestação aberta pelo portador. chargeback: contestação perdida.

public_urlstring ou nulo

Página pública da cobrança (QR Pix, copia e cola, linha digitável e PDF). Pode ser enviada ao pagador.

amountobrigatóriointeger

Valor em centavos de real.

amount_chargedinteger ou nulo

Valor efetivamente pago pelo pagador (inclui juros, multa, taxa repassada ou desconto).

amount_netinteger ou nulo

Valor líquido creditado na conta digital, depois de taxas.

feesinteger ou nulo

Total de taxas e tarifas desta cobrança.

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.

installmentsinteger ou nulo

—

descriptionstring ou nulo

—

external_referencestring ou nulo

—

payment_link_idstring ou nulo

—

payerobject

Quem paga. Para boleto e cartão o endereço completo e o telefone com DDD são obrigatórios.

payer.nameobrigatóriostring

—

payer.documentobrigatóriostring

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

payer.emailstring

—

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

—

pixobject ou nulo

—

pix.emvstring

Código copia e cola.

pix.qr_code_urlstring

Imagem PNG do QR.

pix.expires_atstring

Quando este código vence. Um novo é gerado automaticamente se a cobrança seguir pendente.

boletoobject ou nulo

—

boleto.due_datestring

—

boleto.digitable_linestring

—

boleto.barcodestring

—

boleto.pix_emvstring

QR Pix impresso no boleto.

boleto.pdf_urlstring

—

boleto.paid_viabarcode | pix

—

cardobject ou nulo

—

card.brandstring

—

card.last4string

—

settlementslista de object

Previsão e realização do crédito na conta, por parcela.

settlements[].installmentinteger

—

settlements[].amountinteger

—

settlements[].expected_onstring

—

settlements[].statuspending | settled

—

failureobject ou nulo

—

failure.codestring

—

failure.messagestring

—

metadataobject

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

created_atobrigatóriostring

—

paid_atstring ou nulo

—

canceled_atstring ou nulo

—

refunded_atstring ou nulo

—

Códigos de resposta

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

Parâmetros

McpfPay-Accountstring · cabeçalho

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

charge_idobrigatóriostring · caminho

—

Idempotency-Keystring · cabeçalho

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

Corpo da requisição (JSON)

reasonstring

—

Resposta

idobrigatóriostring

—

account_idobrigatóriostring

—

methodobrigatóriopix | boleto | card | google_pay | apple_pay

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

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.

point_of_saleobject ou nulo

Só em vendas presenciais.

point_of_sale.terminalstring ou nulo

Número de identificação do terminal, quando o provedor informa.

point_of_sale.entry_modechip | contactless | magnetic

—

statusobrigatóriopending | overdue | paid | expired | canceled | refunded | failed | in_dispute | chargeback

pending: aguardando pagamento. overdue: boleto vencido que ainda pode ser pago. paid: pago e confirmado na infraestrutura. expired: prazo final passou sem pagamento. canceled: cancelada antes do pagamento. refunded: estornada. failed: recusada. in_dispute: contestação aberta pelo portador. chargeback: contestação perdida.

public_urlstring ou nulo

Página pública da cobrança (QR Pix, copia e cola, linha digitável e PDF). Pode ser enviada ao pagador.

amountobrigatóriointeger

Valor em centavos de real.

amount_chargedinteger ou nulo

Valor efetivamente pago pelo pagador (inclui juros, multa, taxa repassada ou desconto).

amount_netinteger ou nulo

Valor líquido creditado na conta digital, depois de taxas.

feesinteger ou nulo

Total de taxas e tarifas desta cobrança.

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.

installmentsinteger ou nulo

—

descriptionstring ou nulo

—

external_referencestring ou nulo

—

payment_link_idstring ou nulo

—

payerobject

Quem paga. Para boleto e cartão o endereço completo e o telefone com DDD são obrigatórios.

payer.nameobrigatóriostring

—

payer.documentobrigatóriostring

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

payer.emailstring

—

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

—

pixobject ou nulo

—

pix.emvstring

Código copia e cola.

pix.qr_code_urlstring

Imagem PNG do QR.

pix.expires_atstring

Quando este código vence. Um novo é gerado automaticamente se a cobrança seguir pendente.

boletoobject ou nulo

—

boleto.due_datestring

—

boleto.digitable_linestring

—

boleto.barcodestring

—

boleto.pix_emvstring

QR Pix impresso no boleto.

boleto.pdf_urlstring

—

boleto.paid_viabarcode | pix

—

cardobject ou nulo

—

card.brandstring

—

card.last4string

—

settlementslista de object

Previsão e realização do crédito na conta, por parcela.

settlements[].installmentinteger

—

settlements[].amountinteger

—

settlements[].expected_onstring

—

settlements[].statuspending | settled

—

failureobject ou nulo

—

failure.codestring

—

failure.messagestring

—

metadataobject

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

created_atobrigatóriostring

—

paid_atstring ou nulo

—

canceled_atstring ou nulo

—

refunded_atstring ou nulo

—

Códigos de resposta

• 201 Estorno solicitado. O resultado final chega em `charge.refunded`.
• 404 Recurso não encontrado para esta chave.
• 409 Estado não permite a operação, ou `Idempotency-Key` reutilizada com outro corpo.
• 422 Regra de negócio recusou a operação (limite da conta, valor mínimo de parcela, dados do pagador incompletos).

Parâmetros

McpfPay-Accountstring · cabeçalho

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

Resposta

enabledobrigatórioboolean

—

stepsobrigatóriolista de integer

—

allowed_stepsobrigatóriolista de integer

—

statsobrigatórioobject

Resultado do mês corrente.

stats.monthstring

—

stats.reminders_sentinteger

—

stats.charges_recoveredinteger

Cobranças pagas depois de receber lembrete.

stats.amount_recoveredinteger

Valor dessas cobranças, em centavos.

Códigos de resposta

• 200 Régua e resultado do mês.
• 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.

Corpo da requisição (JSON)

enabledobrigatórioboolean

—

stepsobrigatóriolista de integer

Dias em relação ao vencimento (negativo = antes). Permitidos: -7, -5, -3, -2, -1, 0, 1, 2, 3, 5, 7, 10, 15.

Resposta

enabledobrigatórioboolean

—

stepsobrigatóriolista de integer

—

allowed_stepsobrigatóriolista de integer

—

statsobrigatórioobject

Resultado do mês corrente.

stats.monthstring

—

stats.reminders_sentinteger

—

stats.charges_recoveredinteger

Cobranças pagas depois de receber lembrete.

stats.amount_recoveredinteger

Valor dessas cobranças, em centavos.

Códigos de resposta

• 200 Régua salva.
• 400 Parâmetro ausente ou inválido.
• 403 Sem conexão ativa com a conta, escopo insuficiente ou conta sem a capacidade exigida.