Operações de saldo

Operações de saldo são todas as atividades que geram movimentação do saldo disponível da sua conta Pagar.me, tais como pagamentos ou saques. Essas informações podem ser resgatadas através da API utilizando a rota /balance_operations.

Segue um exemplo de operação de saldo:

{
    "object": "balance_operation",
    "id": 12979989,
    "status": "available",
    "balance_amount": 0,
    "balance_old_amount": null,
    "type": "payable",
    "amount": 10000,
    "fee": 380,
    "date_created": "2020-09-01T18:27:29.016Z",
    "movement_object": {
        "object": "payable",
        "id": 11491515,
        "status": "paid",
        "amount": 10000,
        "fee": 380,
        "anticipation_fee": 0,
        "fraud_coverage_fee": 0,
        "installment": null,
        "transaction_id": 9646500,
        "split_rule_id": null,
        "bulk_anticipation_id": null,
        "recipient_id": "re_cjsklmm5k00qu2j6exqej7tss",
        "originator_model": null,
        "originator_model_id": null,
        "payment_date": "2020-09-01T03:00:00.325Z",
        "original_payment_date": null,
        "type": "credit",
        "payment_method": "boleto",
        "accrual_date": null,
        "date_created": "2020-09-01T18:27:28.358Z"
    }
}

Explicação de cada parâmetro:

Atualmente os recebíveis podem possuir um dos seguintes tipos: payable, refund, anticipation, transfer e fee_collection. O tipo "payable" se refere aos recebíveis, "refund" será referente aos estornos, "anticipation" representarão as antecipações, "transfer" as transferências e por fim "fee_collection" serão descontos referentes a serviços da Pagar.me, tal como cobrança de gateway.

Os recebíveis podem possuir um dos seguintes status: waiting_funds, available e transferred. O status "waiting_funds" estará atrelado às operações de saldo que estão sendo processadas. Já o status "available" estará em todas as operações já concluídas. E finalmente o status "transferred" se aplica apenas a transferências bem sucedidas.