Liquidação de recebíveis

Liquidação

A liquidação é o pagamento de todos os recebíveis que com pagamento agendado para o dia. A liquidação de um recebível pode gerar um ou mais pagamentos.

Os pagamentos seguem o seguinte formato:

{
    "id": "sett_abc1d23e45fgh6ijkl78901mn",
    "status": "success",
    "amount": "10000",
    "product": "credit",
    "card_brand": "elo",
    "company_id": "5556ab7c8d7efghi901jk23l4",
    "payment_date": "2021-04-07",
    "recipient_id": "re_abcd12e3f45ghi67jkl8m9nop",
    "document_type": "cnpj",
    "document_number": "12345678000121",
    "liquidation_type": "external",
    "contract_obligation_id": null,
    "liquidation_arrangement_id": "la_abc1defgh234i5jklmnopq678"
}

Explicação de cada parâmetro:

Propriedade	Descrição
id	Identificador do pagamento
status	Situação do pagamento
amount	Valor do pagamento em centavos
product	Tipo do produto do pagamento
card_brand	Arranjo de pagamento que está sendo pago
company_id	Companhia ao qual o pagamento está atrelado
payment_date	Data do pagamento
recipient_id	Recebedor ao qual o pagamento está atrelado
document_type	Tipo de documento que receberá o pagamento
document_number	Número do documento que receberá o pagamento
liquidation_type	Identifica se um pagamento foi feito como saldo no pagar.me ou se foi pago em outra instituição domicílio
contract_obligation_id	Identificador do contrato na registradora caso possua
liquidation_arrangement_id	Identificador da liquidação

Status de um pagamento

Um pagamento possui 9 diferentes status, sendo eles:

status	descrição
awaiting_response	Estamos aguardando resposta da ID.
cancelled	Cancelado por algum motivo interno.
confirmed	A liquidação será realizada na próxima janela disponível.
failed	Liquidação falhou por algum motivo.
payment_scheduled	Pagamento agendado pela ID (só no caso de produto de crédito).
pending	Em processo de criação/fluxos internos antes de realizar a liquidação.
sent	Enviado para o sistema que vai lidar com a liquidação.
stalled	Algum erro desconhecido aconteceu e estamos analisando. Após análise o status é atualizado. Nunca deveria existir settlement nesse status.
success	Pagamento finalizado com sucesso.

Tipos de pagamentos

O liquidation_type de um pagamento pode ter dois valores: internal e external
Internal, indica que o pagamento de um recebível foi feito no Pagar.me, gerando saldo para o recebedor. Já o external, indica que o pagamento do recebível foi feito para uma instituição domicílio externa, não gerando saldo disponível para o recebedor.

Produtos de um pagamento

O product de um pagamentos pode ter valores: Crédito, Débito e Antecipação.

Card brand de um pagamento

O card_brands de um pagamento pode ter os seguintes valores: amex, diners, elo, hipercard, mastercard e visa

Relação entre pagamentos e recebíveis

O pagamento terá como valor final (campo amount) o valor referente à todos os recebíveis que foram pagos. Para identificar quais recebíveis foram pagos em um pagamento, utilizamos o campo liquidation_arrangement_id do pagamento como filtro na consulta de recebíveis.