Objeto-resposta Recebível

Objeto contendo os dados de um recebível. O recebível (payable) é gerado automaticamente após uma transação ser paga. Para cada parcela de uma transação é gerado um recebível, que também pode ser dividido por recebedor (no caso de um split ter sido feito).

❗️

Atenção: Essa versão de API será descontinuada

Essa versão da API Pagar.me já não é mais atualizada e, em breve, deixará de funcionar. Para que sua loja possa vender sem problemas, você precisa realizar sua integração usando a versão mais recente da nossa API, a V5.

No canto superior esquerdo da tela é indicado qual versão da documentação você está vendo. Clique na seta onde indica a versão e altere para a V5 para acessar a documentação.

Se você já é cliente, precisa realizar obrigatoriamente a migração para a versão V5.

Em caso de dúvidas, basta entrar em contato com o nosso time de atendimento através do e-mail, enviando a sua dúvida para [email protected] e por telefone, ligando para 4004-1330. Se você já é cliente pode também entrar em contato através do chat dentro da sua Dashboard.

object
String
Nome do tipo do objeto criado/modificado.
Valor retornado: payable
id
Numeric
Identificador do recebível
status
String
Estado atual do recebível.
Valores possíveis: waiting_funds, prepaid, paid.
amount
String
Valor em centavos que foi pago
fee
String
Valor em centavos que foi cobrado (taxa)
anticipation_fee
int
Valor em centavos que foi cobrado pela respectiva antecipação(caso criada)
installment
Int
Número da parcela
transaction_id
Numeric
Identificador da transação que gerou o recebível
split_rule_id
String
Identificador da regra de split do recebível
bulk_anticipation_id
String
Identificador da antecipação deste recebível, caso tenha sido criada.
recipient_id
String
Identificador do recebedor a qual este recebível pertence
payment_date
String
Dia e hora do pagamento (ISODate)
original_payment_date
String
Dia de hora de pagamento (ISODate) originais do recebível
type
String
Tipo do recebível.
Valores possíveis: credit, refund, refund_reversal, chargeback, chargeback_refund.
payment_method
String
Tipo de pagamento da transação.
Valores possíveis: credit_card, debit_card, boleto.
accrual_date
String
Data(ISODate) em que o banco emissor reconheceu o pagamento da transação a que este recebível pertence.
date_created
String
Data da criação do objeto (ISODate)
liquidation_arrangement_id
String
Identificador da liquidação do recebível

📘

Criando recebíveis

Uma transação paga com 5 parcelas e 3 recebedores nas regras de split gera 15 (5 x 3) recebíveis. Com isso você tem controle sobre a menor divisão possível de um pagamento.